Skip to content

Commit 52a2cfa

Browse files
committed
Merge remote-tracking branch 'refs/remotes/origin/OpenAPI.next' into dm/final-review
2 parents c45482b + 3c6071b commit 52a2cfa

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)
@@ -1877,7 +1876,7 @@ Field Pattern | Type | Description
18771876
The link SHALL reference a single Link Object, or a JSON Reference to a single link object.
18781877

18791878

1880-
### <a name="#linkObject"></a>Link Object
1879+
#### <a name="#linkObject"></a>Link Object
18811880
The `Link Object` is responsible for defining a possible operation based on a single response.
18821881

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

1897-
#### <a name="responsePayload"></a>Response Payload Values
1896+
##### <a name="responsePayload"></a>Response Payload Values
18981897

18991898
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.
19001899
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.
19011900
In cases where a value is required, and a parameter is not supplied, the client MAY choose to not follow the link definition.
19021901

1903-
### Example
1902+
##### Example
19041903

19051904
Response payload:
19061905
```json
@@ -1939,7 +1938,7 @@ color: ["red", "green", "blue"]
19391938
The variables generated can be used in locations prescribed by the definition.
19401939

19411940

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

@@ -1975,7 +1974,7 @@ The variable expression is defined by the following [ABNF](https://tools.ietf.or
19751974
The `name` identifier is case-sensitive, whereas `token` is not.
19761975
19771976
1978-
### Request Parameter Example
1977+
##### Request Parameter Example
19791978
Computing a link from a request operation like such:
19801979
19811980
```yaml
@@ -2015,7 +2014,7 @@ For a `id` value of `10101110`, the generated link would be:
20152014
href: '/users/10101110/department'
20162015
```
20172016

2018-
### Response Payload Example
2017+
##### Response Payload Example
20192018

20202019
```yaml
20212020
Addresses:
@@ -2047,7 +2046,7 @@ href: 'http://colors.my-server.com/colors/blue'
20472046
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.
20482047

20492048

2050-
### Example
2049+
##### Example
20512050

20522051
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.
20532052

@@ -2260,7 +2259,7 @@ components:
22602259
```
22612260

22622261

2263-
### <a name="linkParametersObject"></a>Link Parameters Object
2262+
#### <a name="linkParametersObject"></a>Link Parameters Object
22642263
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.
22652264
Many operations require parameters to be passed, and these MAY be dynamic depending on the response itself.
22662265

0 commit comments

Comments
 (0)