Skip to content

Commit cad29a6

Browse files
authored
Merge pull request #3862 from handrews/editorial-311
Minor webhooks/callbacks and schema `examples` improvements (3.1.1)
2 parents ba0e420 + 5bbea46 commit cad29a6

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

versions/3.1.1.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -2039,7 +2039,7 @@ $response.header.Location | https://example.org/subscription/1
20392039

20402040
##### Callback Object Examples
20412041

2042-
The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook.
2042+
The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is similar to a [webhook](#oasWebhooks), but differs in that the callback only occurs because of the initial request that sent the `queryUrl`.
20432043

20442044
```yaml
20452045
myCallback:
@@ -2701,10 +2701,12 @@ additionalProperties:
27012701
"required": [
27022702
"name"
27032703
],
2704-
"example": {
2705-
"name": "Puma",
2706-
"id": 1
2707-
}
2704+
"examples": [
2705+
{
2706+
"name": "Puma",
2707+
"id": 1
2708+
}
2709+
]
27082710
}
27092711
```
27102712

@@ -2718,8 +2720,8 @@ properties:
27182720
type: string
27192721
required:
27202722
- name
2721-
example:
2722-
name: Puma
2723+
examples:
2724+
- name: Puma
27232725
id: 1
27242726
```
27252727

0 commit comments

Comments
 (0)