wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add _cs suffix to client-server http APIs

Browse source 
I'm about to add identity service APIs, so differentiating is good.
This commit is contained in:
Daniel Wagner-Hall 2016-03-08 17:42:41 +00:00 • committed by review.rocks
parent cc0dae3aeb
commit f4f186baee
19 changed files with 48 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

2
specification/application_service_api.rst
View file

@ -149,7 +149,7 @@ HTTP APIs
This contains application service APIs which are used by the homeserver. All
application services MUST implement these APIs. These APIs are defined below.
{{application_service_http_api}}
{{application_service_as_http_api}}
.. _create the user: `sect:asapi-permissions`_

42
specification/client_server_api.rst
View file

@ -111,7 +111,7 @@ Some API endpoints may allow or require the use of ``POST`` requests without a
transaction ID. Where this is optional, the use of a ``PUT`` request is strongly
recommended.
{{versions_http_api}}
{{versions_cs_http_api}}
Client Authentication
---------------------
@ -481,9 +481,9 @@ API calls using the User-Interactive Authentication mechanism
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. _User-Interactive Authentication: `sect:auth-api`_
{{registration_http_api}}
{{registration_cs_http_api}}
{{login_http_api}}
{{login_cs_http_api}}
Login Fallback
++++++++++++++
@ -525,7 +525,7 @@ Adding Account Administrative Contact Information
A homeserver may keep some contact information for administrative use.
This is independent of any information kept by any Identity Servers.
{{administrative_contact_http_api}}
{{administrative_contact_cs_http_api}}
Pagination
----------
@ -628,7 +628,7 @@ Filters can be created on the server and can be passed as as a parameter to APIs
which return events. These filters alter the data returned from those APIs.
Not all APIs accept filters.
{{filter_http_api}}
{{filter_cs_http_api}}
Events
------
@ -750,9 +750,9 @@ When the client first logs in, they will need to initially synchronise with
their homeserver. This is achieved via the initial sync API described below.
This API also returns an ``end`` token which can be used with the event stream.
{{old_sync_http_api}}
{{old_sync_cs_http_api}}
{{sync_http_api}}
{{sync_cs_http_api}}
Getting events for a room
@ -760,16 +760,16 @@ Getting events for a room
There are several APIs provided to ``GET`` events for a room:
{{rooms_http_api}}
{{rooms_cs_http_api}}
{{message_pagination_http_api}}
{{message_pagination_cs_http_api}}
Sending events to a room
~~~~~~~~~~~~~~~~~~~~~~~~
{{room_state_http_api}}
{{room_state_cs_http_api}}
**Examples**
@ -806,7 +806,7 @@ In some cases, there may be no need for a ``state_key``, so it can be omitted::
PUT /rooms/!roomid:domain/state/m.room.bgd.color
{ "color": "red", "hex": "#ff0000" }
{{room_send_http_api}}
{{room_send_cs_http_api}}
Redactions
@ -855,7 +855,7 @@ Events
Client behaviour
++++++++++++++++
{{redaction_http_api}}
{{redaction_cs_http_api}}
Rooms
-----
@ -875,7 +875,7 @@ includes:
See `Room Events`_ for more information on these events. To create a room, a
client has to use the following API.
{{create_room_http_api}}
{{create_room_cs_http_api}}
Room aliases
~~~~~~~~~~~~
@ -901,7 +901,7 @@ request.
Homeservers can respond to resolve requests for aliases on other domains than
their own by using the federation API to ask other domain name homeservers.
{{directory_http_api}}
{{directory_cs_http_api}}
Permissions
@ -980,13 +980,13 @@ The allowable state transitions of membership are::
/ban
{{inviting_http_api}}
{{inviting_cs_http_api}}
{{joining_http_api}}
{{joining_cs_http_api}}
{{kicking_http_api}}
{{kicking_cs_http_api}}
{{banning_http_api}}
{{banning_cs_http_api}}
Leaving rooms
~~~~~~~~~~~~~
@ -999,7 +999,7 @@ Whether or not they actually joined the room, if the room is
an "invite-only" room they will need to be re-invited before they can re-join
the room.
{{leaving_http_api}}
{{leaving_cs_http_api}}
Banning users in a room
~~~~~~~~~~~~~~~~~~~~~~~
@ -1030,12 +1030,12 @@ before they can re-join the room or be re-invited.
Listing rooms
~~~~~~~~~~~~~
{{list_public_rooms_http_api}}
{{list_public_rooms_cs_http_api}}
Profiles
--------
{{profile_http_api}}
{{profile_cs_http_api}}
Events on Change of Profile Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
specification/modules/_template.rst
View file

@ -31,10 +31,10 @@ Client behaviour
----------------
List any new HTTP endpoints. These endpoints should be documented using Swagger.
Once there is Swagger, there will be a template variable based on the name of
the YAML file with the suffix ``_http_api``. You can insert a template for
the YAML file with the suffix ``_cs_http_api``. You can insert a template for
swagger docs like so:
{{name-of-yaml-file-without-file-ext_http_api}}
{{name-of-yaml-file-without-file-ext_cs_http_api}}
List the steps the client needs to take to
correctly process this module. List what data structures the client should be

2
specification/modules/account_data.rst
View file

@ -24,4 +24,4 @@ the tags are for.
Client Behaviour
----------------
{{account_data_http_api}}
{{account_data_cs_http_api}}

2
specification/modules/admin.rst
View file

@ -9,4 +9,4 @@ and data.
Client Behaviour
----------------
{{admin_http_api}}
{{admin_cs_http_api}}

2
specification/modules/content_repo.rst
View file

@ -24,7 +24,7 @@ Client behaviour
Clients can upload and download content using the following HTTP APIs.
{{content_repo_http_api}}
{{content_repo_cs_http_api}}
Thumbnails
~~~~~~~~~~

2
specification/modules/event_context.rst
View file

@ -11,7 +11,7 @@ Client behaviour
There is a single HTTP API for retrieving event context, documented below.
{{event_context_http_api}}
{{event_context_cs_http_api}}
Security considerations
-----------------------

2
specification/modules/presence.rst
View file

@ -44,7 +44,7 @@ Client behaviour
Clients can manually set/get their presence/presence list using the HTTP APIs
listed below.
{{presence_http_api}}
{{presence_cs_http_api}}
Idle timeout
~~~~~~~~~~~~

4
specification/modules/push.rst
View file

@ -89,7 +89,7 @@ Client behaviour
Clients MUST configure a Pusher before they will receive push notifications.
There is a single API endpoint for this, as described below.
{{pusher_http_api}}
{{pusher_cs_http_api}}
.. _pushers: `def:pushers`_
@ -334,7 +334,7 @@ Push Rules: API
Clients can retrieve, add, modify and remove push rules globally or per-device
using the APIs below.
{{pushrules_http_api}}
{{pushrules_cs_http_api}}
Examples
++++++++

2
specification/modules/receipts.rst
View file

@ -52,7 +52,7 @@ dismissing a notification in order for the event to count as "read".
A client can update the markers for its user by interacting with the following
HTTP APIs.
{{receipts_http_api}}
{{receipts_cs_http_api}}
Server behaviour
----------------

2
specification/modules/room_previews.rst
View file

@ -27,7 +27,7 @@ events outside the ``/events`` stream.
.. _peeking_events_api:
{{peeking_events_http_api}}
{{peeking_events_cs_http_api}}
Server behaviour
----------------

2
specification/modules/search.rst
View file

@ -12,7 +12,7 @@ Client behaviour
----------------
There is a single HTTP API for performing server-side search, documented below.
{{search_http_api}}
{{search_cs_http_api}}
Search Categories
-----------------

2
specification/modules/tags.rst
View file

@ -45,4 +45,4 @@ Two special names are listed in the specification:
Client Behaviour
----------------
{{tags_http_api}}
{{tags_cs_http_api}}

2
specification/modules/third_party_invites.rst
View file

@ -36,7 +36,7 @@ Client behaviour
A client asks a server to invite a user by their third party identifier.
{{third_party_membership_http_api}}
{{third_party_membership_cs_http_api}}
Server behaviour
----------------

2
specification/modules/typing_notifications.rst
View file

@ -32,7 +32,7 @@ expected timeout runs out is recommended. When the user stops typing, the
state change of the ``boolean`` to ``false`` should trigger another HTTP request
to inform the server that the user has stopped typing.
{{typing_http_api}}
{{typing_cs_http_api}}
Security considerations
-----------------------

2
specification/modules/voip_events.rst
View file

@ -90,7 +90,7 @@ The homeserver MAY provide a TURN server which clients can use to contact the
remote party. The following HTTP API endpoints will be used by clients in order
to get information about the TURN server.
{{voip_http_api}}
{{voip_cs_http_api}}
Security considerations