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

implement editor view_as_api v2

Browse source
This commit is contained in:
Laura Klünder 2023-12-03 17:54:26 +01:00
parent 99a5c3055e
commit 60e789c15e
1 changed files with 31 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

34
src/c3nav/editor/newapi/endpoints.py
View file

@ -1,3 +1,5 @@
from django.urls import Resolver404, resolve
from django.utils.translation import gettext_lazy as _
from ninja import Router as APIRouter from ninja import Router as APIRouter
from c3nav.api.exceptions import API404 from c3nav.api.exceptions import API404
@ -96,8 +98,26 @@ def level_geometries(request, level_id: EditorID, update_cache_key: UpdateCacheK
# todo: need a way to pass the changeset if it's not a session API key # todo: need a way to pass the changeset if it's not a session API key
def resolve_editor_path_api(request, path):
resolved = None
if path:
try:
resolved = resolve('/editor/'+path+'/')
except Resolver404:
pass
@editor_api_router.get('/{path:path}/', summary="access the editor UI programmatically", if not resolved:
try:
resolved = resolve('/editor/'+path)
except Resolver404:
pass
request.sub_resolver_match = resolved
return resolved
@editor_api_router.get('/{path:path}', summary="access the editor UI programmatically",
response={200: dict, **API404.dict(), **auth_permission_responses}, response={200: dict, **API404.dict(), **auth_permission_responses},
openapi_extra={"security": [{"APITokenAuth": ["editor_access"]}]}) openapi_extra={"security": [{"APITokenAuth": ["editor_access"]}]})
@newapi_etag() # todo: correct? @newapi_etag() # todo: correct?
@ -107,11 +127,19 @@ def view_as_api(request, path: str):
`path` is the path after /editor/. `path` is the path after /editor/.
this is a mess. good luck. if you actually want to use this, poke us so we might add better documentation. this is a mess. good luck. if you actually want to use this, poke us so we might add better documentation.
""" """
resolved = resolve_editor_path_api(request, path)
raise NotImplementedError if not resolved:
raise API404(str(_('No matching editor view endpoint found.')))
if not getattr(resolved.func, 'api_hybrid', False):
raise API404(_('Matching editor view point does not provide an API.'))
response = resolved.func(request, api=True, *resolved.args, **resolved.kwargs)
return response
@editor_api_router.post('/{path:path}/', summary="access the editor UI programmatically", @editor_api_router.post('/{path:path}', summary="access the editor UI programmatically",
response={200: dict, **API404.dict(), **auth_permission_responses}, response={200: dict, **API404.dict(), **auth_permission_responses},
openapi_extra={"security": [{"APITokenAuth": ["editor_access", "write"]}]}) openapi_extra={"security": [{"APITokenAuth": ["editor_access", "write"]}]})
@newapi_etag() # todo: correct? @newapi_etag() # todo: correct?