From f85ae26d28b5ef67eb0621c3e09b3c4f154882fa Mon Sep 17 00:00:00 2001 From: Scott Dowding <62896133+sdowding-koho@users.noreply.github.com> Date: Tue, 19 May 2020 09:26:54 -0600 Subject: [PATCH] Add required docs to README.md There is no mention of the `validate` tag used for required fields in the docs, so I did my best to add one. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 880f9bbed..71932bf3c 100644 --- a/README.md +++ b/README.md @@ -458,6 +458,7 @@ type Foo struct { Field Name | Type | Description ---|:---:|--- +validate | `string` | Determines the validation for the parameter. Possible values are: `required`. default | * | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.