Skip to content

Minor webhooks/callbacks and schema examples improvements (3.1.1) #3862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2024
Merged

Minor webhooks/callbacks and schema examples improvements (3.1.1) #3862

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7eb71ad
Fix confusing usage of "WebHook"
handrews May 27, 2024
0c5bd00
Replace deprecated example with examples in schema
handrews May 27, 2024
5bbea46
Fix typos on webook(s) link
handrews May 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions versions/3.1.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2021,7 +2021,7 @@ $response.header.Location | https://example.org/subscription/1

##### Callback Object Examples

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.
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`.

```yaml
myCallback:
Expand Down Expand Up @@ -2587,10 +2587,12 @@ additionalProperties:
"required": [
"name"
],
"example": {
"name": "Puma",
"id": 1
}
"examples": [
{
"name": "Puma",
"id": 1
}
]
}
```

Expand All @@ -2604,8 +2606,8 @@ properties:
type: string
required:
- name
example:
name: Puma
examples:
- name: Puma
id: 1
```

Expand Down