archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation_style.rst

Browse Source
pull/977/head
Richard van der Hoff 7 years ago committed by GitHub
parent 726af76a77
commit 196e668768
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File

7
meta/documentation_style.rst
Unescape Escape View File

@ -77,7 +77,12 @@ When writing OpenAPI specifications for the API endpoints, follow these rules:
end with a full stop. Examples: "Sends an event."; "Searches the directory." end with a full stop. Examples: "Sends an event."; "Searches the directory."
* ``description``: a longer description of the behaviour of this API, written * ``description``: a longer description of the behaviour of this API, written
in complete sentences. in complete sentences. Use multiple paragraphs if necessary.
Example:
This API sends an event to the room. The server must ensure that the user
has permission to post events to this room.
* ``operationId``: a camelCased unique identifier for this endpoint. This will * ``operationId``: a camelCased unique identifier for this endpoint. This will
be used to automatically generate bindings for the endpoint. be used to automatically generate bindings for the endpoint.

Write Preview
Loading…
Cancel
Save