Skip to content

Commit 3c6071b

Browse files
authored
Merge pull request OAI#949 from OAI/header-level-updates
Reorganized title headers in the spec
2 parents 02bfe18 + f80ab0d commit 3c6071b

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

versions/3.0.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ Additional utilities can also take advantage of the resulting files, such as tes
5151
- [Examples Object](#examplesObject)
5252
- [Links Object](#linksObject)
5353
- [Link Object](#linkObject)
54-
- [Variable Substitution](#variableSubstitution)
5554
- [Link Parameters Object](#linkParametersObject)
5655
- [Header Object](#headerObject)
5756
- [Tag Object](#tagObject)
@@ -1872,7 +1871,7 @@ Field Pattern | Type | Description
18721871
The link SHALL reference a single Link Object, or a JSON Reference to a single link object.
18731872

18741873

1875-
### <a name="#linkObject"></a>Link Object
1874+
#### <a name="#linkObject"></a>Link Object
18761875
The `Link Object` is responsible for defining a possible operation based on a single response.
18771876

18781877
Field Name | Type | Description
@@ -1889,13 +1888,13 @@ Locating a linked resource MAY be performed by either a `href` or `operationId`.
18891888
In the case of an `operationId`, it MUST be unique and resolved in the scope of the OAS document.
18901889
Because of the potential for name clashes, consider the `href` syntax as the preferred method for specifications with external references.
18911890

1892-
#### <a name="responsePayload"></a>Response Payload Values
1891+
##### <a name="responsePayload"></a>Response Payload Values
18931892

18941893
Payload values are only available in parsable response payloads which match the advertised media type and for media types that can be referenced using a JSON Pointer fragment Id.
18951894
In all cases, if a value does _not_ exist, the parameter will be considered a `null` value (as opposed to an empty value) and _not_ passed as a parameter to the linked resource.
18961895
In cases where a value is required, and a parameter is not supplied, the client MAY choose to not follow the link definition.
18971896

1898-
### Example
1897+
##### Example
18991898

19001899
Response payload:
19011900
```json
@@ -1934,7 +1933,7 @@ color: ["red", "green", "blue"]
19341933
The variables generated can be used in locations prescribed by the definition.
19351934

19361935

1937-
### <a name="variableSubstitution"></a>Variable Substitution
1936+
##### <a name="variableSubstitution"></a>Variable Substitution
19381937
In all cases, _variables_ from request and responses may be substituted for link generation.
19391938
The table below provides examples of variable expressions and examples of their use in a value:
19401939

@@ -1970,7 +1969,7 @@ The variable expression is defined by the following [ABNF](https://tools.ietf.or
19701969
The `name` identifier is case-sensitive, whereas `token` is not.
19711970
19721971
1973-
### Request Parameter Example
1972+
##### Request Parameter Example
19741973
Computing a link from a request operation like such:
19751974
19761975
```yaml
@@ -2010,7 +2009,7 @@ For a `id` value of `10101110`, the generated link would be:
20102009
href: '/users/10101110/department'
20112010
```
20122011

2013-
### Response Payload Example
2012+
##### Response Payload Example
20142013

20152014
```yaml
20162015
Addresses:
@@ -2042,7 +2041,7 @@ href: 'http://colors.my-server.com/colors/blue'
20422041
As with all links, it at the the clients' discretion to follow them, and permissions and the ability to make a successful call to that link is not guaranteed solely by the existence of a relationship.
20432042

20442043

2045-
### Example
2044+
##### Example
20462045

20472046
The example below shows how relationships in the BitBucket API can be represented with the link schema. This example uses `operationId` values to link responses to possible operations.
20482047

@@ -2255,7 +2254,7 @@ components:
22552254
```
22562255

22572256

2258-
### <a name="linkParametersObject"></a>Link Parameters Object
2257+
#### <a name="linkParametersObject"></a>Link Parameters Object
22592258
Using the `operationId` to reference an operation in the definition has many benefits, including the ability to define media type options, security requirements, response and error payloads.
22602259
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
22612260

0 commit comments

Comments
 (0)