-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
In features.csv link to EVERY single Admin API
in the left column. Use proper rst Syntax in the right column. Unfortunately we have to work around this bug: click-contrib/sphinx-click#15 Bug description in short: Only linking to cli-options possible, not to entire cli-commands. Eg. `synadm room list -i` works but `synadm room list` does not!
- Loading branch information
Showing
1 changed file
with
36 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,36 @@ | ||
| Synapse API,synadm command group(s) | ||
| `Acount Validity <https://element-hq.github.io/synapse/develop/admin_api/account_validity.html>`_, | ||
| `Delete Group <https://element-hq.github.io/synapse/develop/admin_api/delete_group.html>`_,`synadm group <https://synadm.readthedocs.io/en/latest/synadm.cli.group.html>`_ | ||
| `Event Reports <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html>`_, | ||
| `Media <https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html>`_,"`synadm media <https://synadm.readthedocs.io/en/latest/synadm.cli.media.html>`_ | ||
| `synadm user <https://synadm.readthedocs.io/en/latest/synadm.cli.user.html>`_" | ||
| `List all media in a room <https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html#list-all-media-in-a-room>`_,:doc:`synadm.cli.media` | ||
| `Purge History <https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html>`_,`synadm history <https://synadm.readthedocs.io/en/latest/synadm.cli.history.html>`_ | ||
| `Purge Room <https://element-hq.github.io/synapse/develop/admin_api/purge_room.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_ | ||
| `Register <https://element-hq.github.io/synapse/develop/admin_api/register_api.html>`_, | ||
| `Room Membership <https://element-hq.github.io/synapse/develop/admin_api/room_membership.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_ | ||
| `Rooms <https://element-hq.github.io/synapse/develop/admin_api/rooms.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_ | ||
| `Server Notices <https://element-hq.github.io/synapse/develop/admin_api/server_notices.html>`_,`synadm notice <https://synadm.readthedocs.io/en/latest/synadm.cli.notice.html>`_ | ||
| `Statistics <https://element-hq.github.io/synapse/develop/admin_api/statistics.html>`_, | ||
| `User Admin <https://element-hq.github.io/synapse/develop/admin_api/user_admin_api.html>`_,`synadm user <https://synadm.readthedocs.io/en/latest/synadm.cli.user.html>`_ | ||
| `Version <https://element-hq.github.io/synapse/develop/admin_api/version_api.html>`_,`synadm version <https://synadm.readthedocs.io/en/latest/synadm.cli.version.html>`_ | ||
| `Registration Tokens <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/registration_tokens.html>`_,`synadm regtok <https://synadm.readthedocs.io/en/latest/synadm.cli.regtok.html>`_ | ||
| `Background Update <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/background_updates.html>`_, | ||
| `Experimental Features <https://element-hq.github.io/synapse/develop/admin_api/experimental_features.html>`_, | ||
| `Federation <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/federation.html>`_, | ||
| ,`synadm config <https://synadm.readthedocs.io/en/latest/synadm.cli.config.html>`_ | ||
| ,`synadm raw <https://synadm.readthedocs.io/en/latest/synadm.cli.raw.html>`_ | ||
| ,`synadm matrix <https://synadm.readthedocs.io/en/latest/synadm.cli.matrix.html>`_ | ||
| Synapse Admin API,synadm command group / synadm command | ||
| `Acount Validity APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/account_validity.html>`_, | ||
| - `Renew account <https://element-hq.github.io/synapse/develop/admin_api/account_validity.html#renew-account>`_, | ||
| "`Delete Group API [dead, API gone?] <https://element-hq.github.io/synapse/develop/admin_api/delete_group.html>`_",- :doc:`synadm.cli.group` | ||
| `Background Update APIs Overview <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/background_updates.html>`_, | ||
| - `Event Reports APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html>`_, | ||
| - `Show reported events <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html#show-reported-events>`_, | ||
| - `Show details of a specific event report <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html#show-details-of-a-specific-event-report>`_, | ||
| - `Delete a specific event report <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html#delete-a-specific-event-report>`_, | ||
| `Experimental Features APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/experimental_features.html>`_, | ||
| `Media APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html>`_,"- :doc:`synadm.cli.media` | ||
| - :doc:`synadm.cli.user`" | ||
| - `List all media in a room <https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html#list-all-media-in-a-room>`_,- :option:`synadm media list -r` | ||
| - `List all media uploaded by a user <https://element-hq.github.io/synapse/develop/admin_api/user_admin_api.html#list-media-uploaded-by-a-user>`_,"- :option:`synadm media list -u` | ||
| - :option:`synadm user media -f`" | ||
| `Purge History APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html>`_,- :doc:`synadm.cli.history` | ||
| - `Purge history <https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html>`_,- :option:`synadm history purge -i` | ||
| - `Purge status query <https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html#purge-status-query>`_,- :option:`synadm history purge-status PURGE_ID` | ||
| `Register Users APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/register_api.html>`_, | ||
| - `Shared-Secret Registration <https://element-hq.github.io/synapse/develop/admin_api/register_api.html#shared-secret-registration>`_, | ||
| `Registration Tokens APIs Overview <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/registration_tokens.html>`_,- :doc:`synadm.cli.regtok` | ||
| `Manipulate Room Membership API <https://element-hq.github.io/synapse/develop/admin_api/room_membership.html>`_,- :doc:`synadm.cli.room` | ||
| - `Edit Room Membership API <https://element-hq.github.io/synapse/develop/admin_api/room_membership.html#edit-room-membership-api>`_,- :option:`synadm room join ROOM_ID_OR_ALIAS` | ||
| `Rooms APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/rooms.html>`_,- :doc:`synadm.cli.room` | ||
| - `List Room API <https://element-hq.github.io/synapse/develop/admin_api/rooms.html#list-room-api>`_,- :option:`synadm room list -f` | ||
| - `Room Details API <https://element-hq.github.io/synapse/develop/admin_api/rooms.html#room-details-api>`_,- :option:`synadm room details ROOM_ID` | ||
| - `Room Members API <https://element-hq.github.io/synapse/develop/admin_api/rooms.html#room-members-api>`_,- :option:`synadm room members ROOM_ID` | ||
| ...and so on....we have a lot of Room APIs....,...and synadm room commands..... | ||
| `Server Notices APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/server_notices.html>`_,- :doc:`synadm.cli.notice` | ||
| `Statistics APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/statistics.html>`_, | ||
| `User Admin APIs Overview <https://element-hq.github.io/synapse/develop/admin_api/user_admin_api.html>`_,- :doc:`synadm.cli.user` | ||
| `Server Version API <https://element-hq.github.io/synapse/develop/admin_api/version_api.html>`_,- :option:`synadm --version` | ||
| `Federation APIs Overview <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/federation.html>`_, | ||
| ,- :doc:`synadm.cli.config` | ||
| ,- :doc:`synadm.cli.raw` | ||
| ,- :doc:`synadm.cli.matrix` |