do not use 'optional' in descriptions.

7 years ago · c84066df89
parent dfa4af5c19
commit c84066df89
1 changed files with 4 additions and 0 deletions
--- a/meta/documentation_style.rst
+++ b/meta/documentation_style.rst
@ -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
  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.