2025-summer/team-3
12
Fork 0
Code Issues Pull requests Projects Releases Activity

start making optional attributes look better in redoc

Browse source
This commit is contained in:
Laura Klünder 2023-12-03 23:27:20 +01:00
parent c8ec578045
commit ea335a8fe8
2 changed files with 21 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/c3nav/editor/api/schemas.py
View file

@ -15,8 +15,15 @@ GeometryStylesSchema = Annotated[
APIField(description="mapping with a color for each feature type") APIField(description="mapping with a color for each feature type")
] ]
EditorID = Union[ EditorID = Union[
Annotated[PositiveInt, APIField(title="an existing object that might have been modified in this changeset")], Annotated[PositiveInt, APIField(
Annotated[str, APIField(pattern="^c:[0-9]+$", title="an object that was created in this changeset")], title="existing object",
description="ID of an existing object that might have been modified in this changeset"
)],
Annotated[str, APIField(
pattern="^c:[0-9]+$",
title="created object",
description="id of an object that was created in this changeset"
)],
] ]
EditorGeometriesUpdateCacheKeyElem = Annotated[ EditorGeometriesUpdateCacheKeyElem = Annotated[
tuple[ tuple[

18
src/c3nav/mapdata/api/map.py
View file

@ -1,5 +1,5 @@
import json import json
from typing import Annotated, Optional from typing import Annotated, Optional, Union
from django.core.serializers.json import DjangoJSONEncoder from django.core.serializers.json import DjangoJSONEncoder
from django.shortcuts import redirect from django.shortcuts import redirect
@ -8,6 +8,7 @@ from ninja import Query
from ninja import Router as APIRouter from ninja import Router as APIRouter
from ninja import Schema from ninja import Schema
from pydantic import Field as APIField from pydantic import Field as APIField
from pydantic import PositiveInt
from c3nav.api.auth import auth_permission_responses, auth_responses, validate_responses from c3nav.api.auth import auth_permission_responses, auth_responses, validate_responses
from c3nav.api.exceptions import API404, APIPermissionDenied, APIRequestValidationFailed from c3nav.api.exceptions import API404, APIPermissionDenied, APIRequestValidationFailed
@ -270,15 +271,20 @@ def get_position_by_id(request, position_id: AnyPositionID):
raise API404() raise API404()
return location.serialize_position() return location.serialize_position()
class UpdatePositionSchema(Schema): class UpdatePositionSchema(Schema):
coordinates_id: Optional[CustomLocationID] = APIField( coordinates_id: Union[
description="coordinates to set the location to or None to unset it" Annotated[CustomLocationID, APIField(title="set coordinates")],
Annotated[None, APIField(title="unset coordinates")],
] = APIField(
description="coordinates to set the location to or null to unset it"
) )
timeout: Optional[int] = APIField( timeout: Union[
Annotated[PositiveInt, APIField(title="new timeout")],
Annotated[None, APIField(title="don't change")],
] = APIField(
None, None,
title="timeout",
description="timeout for this new location in seconds, or None if not to change it", description="timeout for this new location in seconds, or None if not to change it",
example=None,
) )