Skip to content

Commit 33c205c

Browse files
authored
fix: json schema for datetime (#114)
## What I'm changing - Use `{"type": "string"}` for the OpenAPI docs for datetime, too ## How I did it - Also added an example ![image](https://github.com/user-attachments/assets/58c5015e-74fc-404b-b999-cba6bf704d07)
1 parent 0f36066 commit 33c205c

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

stapi-pydantic/src/stapi_pydantic/datetime_interval.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ def serialize(
3939
BeforeValidator(validate_before),
4040
AfterValidator(validate_after),
4141
WrapSerializer(serialize, return_type=str),
42-
WithJsonSchema({"type": "string"}, mode="serialization"),
42+
WithJsonSchema({"type": "string"}),
4343
]

stapi-pydantic/src/stapi_pydantic/order.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def __getitem__(self, index: int) -> Order[T]:
129129

130130

131131
class OrderPayload(BaseModel, Generic[ORP]):
132-
datetime: DatetimeInterval
132+
datetime: DatetimeInterval = Field(examples=["2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"])
133133
geometry: Geometry
134134
# TODO: validate the CQL2 filter?
135135
filter: CQL2Filter | None = None # type: ignore [type-arg]
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
from pydantic import TypeAdapter
2+
from stapi_pydantic.datetime_interval import DatetimeInterval
3+
4+
5+
def test_datetime_interval() -> None:
6+
assert TypeAdapter(DatetimeInterval).json_schema() == {"type": "string"}

0 commit comments

Comments
 (0)