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

Update documentation_style.rst

Browse source
This commit is contained in:
Richard van der Hoff 2018-02-14 16:44:09 +00:00 • 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
Download patch file Download diff file Expand all files Collapse all files

7
meta/documentation_style.rst
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."
* ``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
be used to automatically generate bindings for the endpoint.