swagger-api / swagger-api/swagger.io-docs
In multiple callbacks section, event names are missing
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
Reading documentation here. I think that in the multiple callbacks section, the example is missing event names for failedUrl and successUrl cases. So instead of:
callbacks:
inProgress:
'{$request.body#/inProgressUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage1'
responses:
'200':
description: OK
'{$request.body#/failedUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage2'
responses:
'200':
description: OK
'{$request.body#/successUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage3'
responses:
'200':
description: OK
It should be:
callbacks:
inProgress:
'{$request.body#/inProgressUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage1'
responses:
'200':
description: OK
failed:
'{$request.body#/failedUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage2'
responses:
'200':
description: OK
success:
'{$request.body#/successUrl}':
post:
requestBody:
$ref: '#/components/requestBodies/callbackMessage3'
responses:
'200':
description: OK
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Swagger documentation and locate the multiple callbacks section. Compare the failedUrl and successUrl examples with the inProgress example, then update the documentation so each callback has its event name. Done means the rendered example clearly shows inProgress, failed, and success callback entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100