Commit 599443b
authored
feat(openapi): Add WebhookRepresentation schema for ad-hoc webhooks (#2469)
## Summary
- Adds a new `WebhookRepresentation` schema describing the minimal
ad-hoc webhook shape (`eventTypes`, `requestUrl`, optional
`payloadTemplate` / `headersTemplate`).
- References it via `contentSchema` on the `webhooks` query parameter
(used on Actor/task run and build endpoints), so the parameter now
documents the actual decoded structure of the Base64-encoded JSON array
instead of a vague free-form description.
## Why
The `webhooks` query parameter is hand-maintained in
[`apify-client-python`](https://github.com/apify/apify-client-python)
because the spec didn't expose its decoded shape. Lifting it into the
spec lets the client generate the model from codegen
(apify/apify-client-python#758) and keeps the API reference accurate for
any other consumer.
## Related
- Pairs with the apify-client-python PR that drops the hand-written
`WebhookRepresentation` model in favor of the generated one.1 parent c32a22b commit 599443b
2 files changed
Lines changed: 36 additions & 2 deletions
File tree
- apify-api/openapi/components
- parameters
- schemas/webhooks
Lines changed: 8 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
179 | 179 | | |
180 | 180 | | |
181 | 181 | | |
182 | | - | |
183 | | - | |
| 182 | + | |
| 183 | + | |
184 | 184 | | |
185 | 185 | | |
186 | 186 | | |
187 | 187 | | |
188 | 188 | | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
189 | 195 | | |
190 | 196 | | |
191 | 197 | | |
| |||
Lines changed: 28 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
0 commit comments