Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-24 01:58:36 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

do not use 'optional' in descriptions.

Browse source
This commit is contained in:
Richard van der Hoff 2018-06-22 14:30:24 +01:00 committed by GitHub
parent dfa4af5c19
commit c84066df89
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
meta/documentation_style.rst
View file

@ -100,3 +100,7 @@ When writing OpenAPI specifications for the API endpoints, follow these rules:
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]."
Some descriptions start with the workd "Optional" to explicitly mark optional
properties and parameters. This is redundant. Instead, use the ``required``
property to mark those that are required.