masq
/
halfapi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[doc] docstring for api_routes

This commit is contained in:
Maxime Alves LIRMM@home 2021-06-17 19:02:11 +02:00
parent 81f6cf8b39
commit 2819483070
1 changed files with 38 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
halfapi/lib/schemas.py
View File

@ -16,26 +16,60 @@ from typing import Dict
from starlette.schemas import SchemaGenerator from starlette.schemas import SchemaGenerator
from starlette.exceptions import HTTPException from starlette.exceptions import HTTPException
from .. import __version__
from .routes import gen_starlette_routes, api_acls from .routes import gen_starlette_routes, api_acls
from .responses import ORJSONResponse from .responses import ORJSONResponse
logger = logging.getLogger('uvicorn.asgi') logger = logging.getLogger('uvicorn.asgi')
SCHEMAS = SchemaGenerator( SCHEMAS = SchemaGenerator(
{"openapi": "3.0.0", "info": {"title": "HalfAPI", "version": "1.0"}} {"openapi": "3.0.0", "info": {"title": "HalfAPI", "version": __version__}}
) )
async def get_api_routes(request, *args, **kwargs): async def get_api_routes(request, *args, **kwargs):
""" """
description: Returns the current API routes description (HalfAPI 0.2.1) description: Returns the current API routes dictionary
as a JSON object as a JSON object
example: {
"dummy_domain": {
"abc/alphabet": {
"GET": [
{
"acl": "public"
}
]
},
"abc/alphabet/{test:uuid}": {
"GET": [
{
"acl": "public"
}
],
"POST": [
{
"acl": "public"
}
],
"PATCH": [
{
"acl": "public"
}
],
"PUT": [
{
"acl": "public"
}
]
}
}
}
""" """
return ORJSONResponse(request.scope['api']) return ORJSONResponse(request.scope['api'])
def get_api_domain_routes(domain): def get_api_domain_routes(domain):
async def wrapped(request, *args, **kwargs): async def wrapped(request, *args, **kwargs):
""" """
description: Returns the current API routes description (HalfAPI 0.2.1) description: Returns the current API routes dictionary for a specific
as a JSON object domain as a JSON object
""" """
if domain in request.scope['api']: if domain in request.scope['api']:
return ORJSONResponse(request.scope['api'][domain]) return ORJSONResponse(request.scope['api'][domain])