You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There were two subsections called "Examples", one for actual
Link Object examples and one for runtime expression examples.
This puts the `operationRef` examples under the main Examples
section, and renames the runtime expression example section.
While I was at it, I clarified some of the wording.
Copy file name to clipboardExpand all lines: src/oas.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2507,10 +2507,12 @@ Clients follow all links at their discretion.
2507
2507
Neither permissions nor the capability to make a successful call to that link is guaranteed
2508
2508
solely by the existence of a relationship.
2509
2509
2510
-
##### `operationRef` Examples
2510
+
######`operationRef` Examples
2511
2511
2512
-
As references to `operationId` MAY NOT be possible (the `operationId` is an optional
2513
-
field in an [Operation Object](#operation-object)), references MAY also be made through a relative `operationRef`:
2512
+
As the `operationId` is an optional field in an [Operation Object](#operation-object)), references MAY instead be made through a URI-reference with `operationRef`.
2513
+
Note that both of these examples reference operations that can be identified via the [Paths Object](#paths-object) to ensure that the operation's path template is unambiguous.
2514
+
2515
+
A relative URI-reference `operationRef`:
2514
2516
2515
2517
```yaml
2516
2518
links:
@@ -2520,7 +2522,7 @@ links:
2520
2522
username: $response.body#/username
2521
2523
```
2522
2524
2523
-
or a URI `operationRef`:
2525
+
A non-relative URI `operationRef`:
2524
2526
2525
2527
```yaml
2526
2528
links:
@@ -2530,8 +2532,9 @@ links:
2530
2532
username: $response.body#/username
2531
2533
```
2532
2534
2533
-
Note that in the use of `operationRef` the _escaped forward-slash_ is necessary when
2534
-
using JSON Pointer, and it is necessary to URL-encode `{` and `}` as `%7B` and `%7D`, respectively, when using JSON Pointer as URI fragments.
2535
+
Note that in the use of `operationRef` the _escaped forward-slash_ (`~1`) is necessary when
2536
+
using JSON Pointer in URI fragments, and it is necessary to URL-encode `{` and `}` as `%7B` and `%7D`, respectively.
2537
+
The unescaped, percent-decoded path template in the above examples would be `/2.0/repositories/{username}`.
2535
2538
2536
2539
##### Runtime Expressions
2537
2540
@@ -2565,7 +2568,7 @@ The `name` identifier is case-sensitive, whereas `token` is not.
2565
2568
2566
2569
The table below provides examples of runtime expressions and examples of their use in a value:
0 commit comments