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

documentation_style: fix indentation

Browse source
This commit is contained in:
Richard van der Hoff 2018-02-06 16:10:55 +00:00 • committed by GitHub
parent 306783b7bf
commit 3c40d5a94e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
meta/documentation_style.rst
View file

@ -67,18 +67,18 @@ OpenAPI
When writing OpenAPI specifications for the API endpoints, follow these rules: When writing OpenAPI specifications for the API endpoints, follow these rules:
* ``summary``: a phrase summarising what this API does. Start with a capital, * ``summary``: a phrase summarising what this API does. Start with a capital,
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.
* ``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.
* Parameter and property ``description``\s: a phrase summarising the behaviour * Parameter and property ``description``\s: a phrase summarising the behaviour
of this parameter or property, optionally followed by sentences giving more of this parameter or property, optionally followed by sentences giving more
detailed explanations. detailed explanations.
The description is also the place to define default values for optional The description is also the place to define default values for optional
properties. Use the wording "Defaults to X [if unspecified]." properties. Use the wording "Defaults to X [if unspecified]."