API to CLI Mapping
==========================

The tables below show which Synapse Admin APIs are used by their corresponding ``synadm`` commands.
The left column's entries link to the official Synapse Admin API documentation, the right column's entries point to the ``synadm`` CLI reference.
To add missing entries to a table edit one of the CSV files in our `documentation source directory`_ and submit a `pull request`_ - see `feature coverage documentation`_ for details.


Account Validity
----------------

.. csv-table::
   :file: features/account_validity.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Background Updates
------------------

.. csv-table::
   :file: features/background_updates.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Delete Group
------------

.. csv-table::
   :file: features/delete_group.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Event Reports
-------------

.. csv-table::
   :file: features/event_reports.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Experimental Features
---------------------

.. csv-table::
   :file: features/experimental_features.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Media
-----

.. csv-table::
   :file: features/media.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1
   :keepspace:

Purge History
-------------

.. csv-table::
   :file: features/purge_history.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Register Users
--------------

.. csv-table::
   :file: features/register_users.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Registration Tokens
-------------------

.. csv-table::
   :file: features/registration_tokens.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Manipulate Room Membership
--------------------------

.. csv-table::
   :file: features/manipulate_room_membership.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Rooms
-----

.. csv-table::
   :file: features/rooms.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Server Notices
--------------

.. csv-table::
   :file: features/server_notices.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Statistics
----------

.. csv-table::
   :file: features/statistics.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Users
-----

.. csv-table::
   :file: features/users.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Server Version
--------------

.. csv-table::
   :file: features/server_version.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Federation
----------

.. csv-table::
   :file: features/federation.csv
   :header: "Synapse Admin API","synadm command(s)"
   :widths: 1 1

Miscellaneous
-------------

.. csv-table::
   :file: features/miscellaneous.csv
   :header: "Description","synadm command(s)"
   :widths: 1 1


.. _documentation source directory:
   https://github.com/JOJ0/synadm/tree/master/doc/source/features/
.. _feature request issue:
   https://github.com/JOJ0/synadm/issues/new
.. _pull request:
   https://github.com/JOJ0/synadm/blob/master/CONTRIBUTING.md#submitting-your-work
.. _feature coverage documentation:
   https://github.com/JOJ0/synadm/blob/master/CONTRIBUTING.md#feature-coverage-documentation 
.. |indent| unicode:: U+00A0 U+00A0 .. non-breaking two-space indentation