def get_api_schema(request):
"""
Returns a hash of all API endpoints and their descriptions.
Returns::
{
'/example/url/here': {
'name': endpoint name,
'description': endpoint description
}...
}
.. todo:: Should this require authentication? Should it return only endpoints the user has authorization for?
.. todo:: Format docstrings better.
"""
endpoints = get_api_endpoints()
resp = {}
for url, fn in endpoints.items():
desc = format_api_docstring(fn.func_doc)
endpoint_details = {'name': fn.func_name,
'description': desc}
resp[url] = endpoint_details
return JsonResponse(resp)
def get_api_schema(request):
"""
Returns a hash of all API endpoints and their descriptions.
Returns::
{
'/example/url/here': {
'name': endpoint name,
'description': endpoint description
}...
}
.. todo:: Format docstrings better.
"""
endpoints = get_api_endpoints()
resp = {}
for url, fn in endpoints.items():
desc = format_api_docstring(fn.func_doc)
endpoint_details = {'name': fn.func_name,
'description': desc}
resp[url] = endpoint_details
return JsonResponse(resp)
def get_api_schema(request):
"""
Returns a hash of all API endpoints and their descriptions.
Returns::
{'/example/url/here': {
'name': endpoint name,
'description': endpoint description
}...
}
TODO: Should this require authentication? Should it limit the return
to endpoints the user has authorization for?
TODO: Format docstrings better.
"""
endpoints = get_api_endpoints()
resp = {}
for url, fn in endpoints.items():
desc = format_api_docstring(fn.func_doc)
endpoint_details = {'name': fn.func_name, 'description': desc}
resp[url] = endpoint_details
return resp