Changeset View
Changeset View
Standalone View
Standalone View
swh/web/api/apidoc.py
Show First 20 Lines • Show All 324 Lines • ▼ Show 20 Lines | Args: | ||||
noargs: set to True if the route has no arguments, and its | noargs: set to True if the route has no arguments, and its | ||||
result should be displayed anytime its documentation | result should be displayed anytime its documentation | ||||
is requested. Default to False | is requested. Default to False | ||||
tags: Further information on api endpoints. Two values are | tags: Further information on api endpoints. Two values are | ||||
possibly expected: | possibly expected: | ||||
* hidden: remove the entry points from the listing | * hidden: remove the entry points from the listing | ||||
* upcoming: display the entry point but it is not followable | * upcoming: display the entry point but it is not followable | ||||
* deprecated: display the entry point as deprecated in the index | |||||
api_version: api version string | api_version: api version string | ||||
""" | """ | ||||
tags_set = set(tags) | tags_set = set(tags) | ||||
# @api_doc() Decorator call | # @api_doc() Decorator call | ||||
def decorator(f): | def decorator(f): | ||||
# if the route is not hidden, add it to the index | # if the route is not hidden, add it to the index | ||||
▲ Show 20 Lines • Show All 124 Lines • Show Last 20 Lines |