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

typo

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

2
meta/documentation_style.rst
View file

@ -101,6 +101,6 @@ 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 Some descriptions start with the word "Optional" to explicitly mark optional
properties and parameters. This is redundant. Instead, use the ``required`` properties and parameters. This is redundant. Instead, use the ``required``
property to mark those that are required. property to mark those that are required.