mirror of
https://github.com/arcan1s/ahriman.git
synced 2025-11-03 15:23:41 +00:00
review fixes
This commit is contained in:
@ -27,7 +27,7 @@ Let's imagine, that the new class implements ``help-web``, which prints server i
|
||||
result = response.json()
|
||||
print(result)
|
||||
|
||||
The main functionality of the class is already described, but command is still not available yet. To do so, it is required to set ``arguments`` property, which is list of functions, which takes argument parser object, creates new subcommand and returns the modified parser, e.g.:
|
||||
The main functionality of the class is already described, but command is still not available yet. To do so, it is required to set ``arguments`` property, which is the list of the functions, each of them which takes argument parser object, creates new subcommand and returns the modified parser, e.g.:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
Writing own API endpoint
|
||||
========================
|
||||
|
||||
The web service loads views dynamically, thus it is possible to add custom API endpoint or even web page. The views must be derived from ``ahriman.web.views.base.BaseView`` and implements HTTP methods. The API specification will be also loaded (if available), but optional. The implementation must be saved into the ``ahriman.web.views`` package
|
||||
The web service loads views dynamically, thus it is possible to add custom API endpoint or even web page. The view must be derived from ``ahriman.web.views.base.BaseView`` and should implement desired HTTP methods. The API specification will be also loaded automatically if available, but optional. The implementation must be saved into the ``ahriman.web.views`` package
|
||||
|
||||
Let's consider example for API endpoint which always returns 204 with no response:
|
||||
Let's consider example of API endpoint which always returns 204 with no response:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@ -18,9 +18,9 @@ Let's consider example for API endpoint which always returns 204 with no respons
|
||||
# check public methods of the BaseView class for all available controls
|
||||
raise HTTPNoContent
|
||||
|
||||
The ``get()`` method can be decorated by ``aiohttp_apispec`` methods, but we will leave it for self-study. Consider checking examples of usages in the main package.
|
||||
The ``get()`` method can be decorated by ``aiohttp_apispec`` methods, but we will leave it for a self-study, please, consider to check examples of usages in the main package.
|
||||
|
||||
In order to view to be set correctly to routes list, few more options are required to be set. First of all, it is required to specify ``ROUTES`` (list of strings), which contains list of all available routes, e.g.:
|
||||
In order to view to be added to the route list correctly, few more properties are required to be set. First of all, it is required to specify ``ROUTES`` (list of strings), which contains list of all available routes, e.g.:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
|
||||
@ -440,7 +440,7 @@ Different APIs are separated into different packages:
|
||||
* ``ahriman.web.views.api`` not a real API, but some views which provide OpenAPI support.
|
||||
* ``ahriman.web.views.*.auditlog`` provides event log API.
|
||||
* ``ahriman.web.views.*.distributed`` is an API for builders interaction for multi-node setup.
|
||||
* ``ahriman.web.views.*.pacakges`` contains views which provide information about existing packages.
|
||||
* ``ahriman.web.views.*.packages`` contains views which provide information about existing packages.
|
||||
* ``ahriman.web.views.*.service`` provides views for application controls.
|
||||
* ``ahriman.web.views.*.status`` package provides REST API for application reporting.
|
||||
* ``ahriman.web.views.*.user`` package provides login and logout methods which can be called without authorization.
|
||||
|
||||
@ -9,7 +9,7 @@ How to setup web service
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
yay -S -ahriman-web
|
||||
yay -S ahriman-web
|
||||
|
||||
#.
|
||||
Configure service:
|
||||
|
||||
Reference in New Issue
Block a user