From 2605c75f920973fafe4d57c29b89735dac9dfb53 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Fri, 22 Jun 2018 14:31:31 +0100 Subject: [PATCH] typo --- meta/documentation_style.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/meta/documentation_style.rst b/meta/documentation_style.rst index a866d1eb..e60c7847 100644 --- a/meta/documentation_style.rst +++ b/meta/documentation_style.rst @@ -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 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`` property to mark those that are required.