Changeset View
Changeset View
Standalone View
Standalone View
docs/developers-info.rst
| Show First 20 Lines • Show All 67 Lines • ▼ Show 20 Lines | """""""""""""""" | ||||
| * :mod:`swh.web.common.highlightjs`: utility module to ease the use of the highlightjs_ | * :mod:`swh.web.common.highlightjs`: utility module to ease the use of the highlightjs_ | ||||
| library in produced Django views. | library in produced Django views. | ||||
| * :mod:`swh.web.common.query`: Utilities to parse data from HTTP endpoints. It is used | * :mod:`swh.web.common.query`: Utilities to parse data from HTTP endpoints. It is used | ||||
| by :mod:`swh.web.common.service`. | by :mod:`swh.web.common.service`. | ||||
| * :mod:`swh.web.common.service`: Orchestration layer used by views module | * :mod:`swh.web.common.service`: Orchestration layer used by views module | ||||
| in charge of communication with :mod:`swh.storage` to retrieve information and | in charge of communication with :mod:`swh.storage` to retrieve information and | ||||
| perform conversion for the upper layer. | perform conversion for the upper layer. | ||||
| * :mod:`swh.web.common.swh_templatetags`: Custom Django template tags library for swh. | * :mod:`swh.web.common.swh_templatetags`: Custom Django template tags library for swh. | ||||
| * :mod:`swh.web.common.throttling`: Custom request rate limiter to use with the `Django REST Framework | |||||
| <http://www.django-rest-framework.org/>`_ | |||||
| * :mod:`swh.web.common.urlsindex`: Utilities to help the registering of endpoints | * :mod:`swh.web.common.urlsindex`: Utilities to help the registering of endpoints | ||||
| for the web applications | for the web applications | ||||
| * :mod:`swh.web.common.utils`: Utility functions used in the web applications implementation | * :mod:`swh.web.common.utils`: Utility functions used in the web applications implementation | ||||
| swh-web API application | swh-web API application | ||||
| ^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^ | ||||
| * :mod:`swh.web.api.apidoc`: Utilities to document the web api for its html | * :mod:`swh.web.api.apidoc`: Utilities to document the web api for its html | ||||
| browsable rendering. | browsable rendering. | ||||
| * :mod:`swh.web.api.apiresponse`: Utility module to ease the generation of | * :mod:`swh.web.api.apiresponse`: Utility module to ease the generation of | ||||
| web api responses. | web api responses. | ||||
| * :mod:`swh.web.api.apiurls`: Utilities to facilitate the registration of web api endpoints. | * :mod:`swh.web.api.apiurls`: Utilities to facilitate the registration of web api endpoints. | ||||
| * :mod:`swh.web.api.throttling`: Custom request rate limiter to use with the `Django REST Framework | |||||
| <http://www.django-rest-framework.org/>`_ | |||||
| * :mod:`swh.web.api.urls`: Module that defines the whole URI scheme for the api endpoints | * :mod:`swh.web.api.urls`: Module that defines the whole URI scheme for the api endpoints | ||||
| * :mod:`swh.web.api.utils`: Utility functions used in the web api implementation. | * :mod:`swh.web.api.utils`: Utility functions used in the web api implementation. | ||||
| * :mod:`swh.web.api.views.content`: Implementation of API endpoints for getting information | * :mod:`swh.web.api.views.content`: Implementation of API endpoints for getting information | ||||
| about contents. | about contents. | ||||
| * :mod:`swh.web.api.views.directory`: Implementation of API endpoints for getting information | * :mod:`swh.web.api.views.directory`: Implementation of API endpoints for getting information | ||||
| about directories. | about directories. | ||||
| * :mod:`swh.web.api.views.origin`: Implementation of API endpoints for getting information | * :mod:`swh.web.api.views.origin`: Implementation of API endpoints for getting information | ||||
| about origins. | about origins. | ||||
| Show All 29 Lines | |||||