Skip to content

Commit 6389e18

Browse files
author
Ron
authored
Merge pull request OAI#1023 from timburks/OpenAPI.next
Minor edits: add headers for consistency, fix misspelling, add missing tag.
2 parents af42644 + 9036068 commit 6389e18

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

versions/3.0.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,9 @@ This object can be extended with [Specification Extensions](#specificationExtens
384384
385385
#### <a name="serverVariableObject"></a>Server Variable Object
386386
387-
An object representing a Server Variable for server URL template substituion.
387+
An object representing a Server Variable for server URL template substitution.
388+
389+
##### Fixed Fields
388390
389391
Field Name | Type | Description
390392
---|:---:|---
@@ -409,7 +411,7 @@ Field Name | Type | Description
409411
<a name="componentsParameters"></a> parameters | Map[`string`, [Parameter Object](#parameterObject)] | An object to hold reusable [Parameter Objects](#parameterObject).
410412
<a name="componentsExamples"></a> examples | Map[`string`, [Example Object](#exampleObject)] | An object to hold reusable [Example Objects](#exampleObject).
411413
<a name="componentsRequestBodies"></a> requestBodies | Map[`string`, [Request Body Object](#requestBodyObject)] | An object to hold reusable [Request Body Objects](#requestBodyObject).
412-
<a name="componentsHeaders"></a> headers | Map[`string`, [Header object](#headerObject)] | An object to hold reusable [Header objects](#headerObject).
414+
<a name="componentsHeaders"></a> headers | Map[`string`, [Header Object](#headerObject)] | An object to hold reusable [Header Objects](#headerObject).
413415
<a name="componentsSecuritySchemes"></a> securitySchemes| Map[`string`, [Security Scheme Object](#securitySchemeObject)] | An object to hold reusable [Security Scheme Objects](#securitySchemeObject).
414416
<a name="componentsLinks"></a> links | Map[`string`, [Link Object](#linkObject)] | An object to hold reusable [Link Objects](#linkObject).
415417
<a name="componentsCallbacks"></a> callbacks | Map[`string`, [Callback Object](#callbackObject)] | An object to hold reusable [Callback Objects](#callbackObject).
@@ -911,6 +913,7 @@ Describes a single operation parameter.
911913

912914
A unique parameter is defined by a combination of a [name](#parameterName) and [___location](#parameterIn).
913915

916+
##### Parameter Locations
914917
There are four possible parameter locations (as specified with the `in` field):
915918
* path - Used together with [Path Templating](#pathTemplating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`.
916919
* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`.
@@ -926,7 +929,7 @@ Field Name | Type | Description
926929
<a name="parameterDescription"></a>description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
927930
<a name="parameterRequired"></a>required | `boolean` | Determines whether this parameter is mandatory. If the [parameter ___location](#parameterIn) is "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`.
928931
<a name="parameterDeprecated"></a> deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
929-
<a name="parameterAllowEmptyValue"/>allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, if behavior is `n/a`, the value of `allowEmptyValue` SHALL be ignored.
932+
<a name="parameterAllowEmptyValue"></a> allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, if behavior is `n/a`, the value of `allowEmptyValue` SHALL be ignored.
930933

931934
The rules for serialization of the parameter are specified in one of two ways.
932935
For simpler scenarios, a [`style`](#parameterStyle) and [`schema`](#parameterSchema) can be used to describe the structure and syntax of the parameter.
@@ -950,6 +953,8 @@ Field Name | Type | Description
950953
---|:---:|---
951954
<a name="parameterContent"></a>content | [Content Object](#contentObject) | The content of the parameter.
952955

956+
##### Style Values
957+
953958
In order to support common ways of serializing simple parameters, a set of `style` values are defined.
954959

955960
`style` | [`type`](#dataTypeType) | `in` | Comments
@@ -1998,6 +2003,8 @@ Field Pattern | Type | Description
19982003
#### <a name="linkObject"></a>Link Object
19992004
The `Link Object` is responsible for defining a possible operation based on a single response.
20002005

2006+
##### Fixed Fields
2007+
20012008
Field Name | Type | Description
20022009
---|:---:|---
20032010
operationRef | `string` | a relative or absolute reference to an OAS operation. This field is mutually exclusive with the `operationId` field, and must point to the fragment of a valid OAS definition
@@ -2604,6 +2611,8 @@ This object is an extended subset of the [JSON Schema Specification Wright Draft
26042611
Further information about the properties can be found in [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00) and [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00).
26052612
Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
26062613

2614+
##### Properties
2615+
26072616
The following properties are taken directly from the JSON Schema definition and follow the same specifications:
26082617

26092618
- title

0 commit comments

Comments
 (0)