swagger-api / swagger-api/swagger.io-docs
Multiple Callbacks section missing to define the other two callback events
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
I am referring this url - https://swagger.io/docs/specification/callbacks/, where the section called Multiple Callbacks suppose to define 3 callback events but it currently defined just one call back event named - inProgress: and used all the three callback messages underneath this event.
I suppose the documentation should be updated to show example defining other two events namely failed: & success: and define the callback messages accordingly.
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
Start with the Multiple Callbacks section at the linked Swagger documentation URL and compare the displayed example with the three callback events described in the issue. Update the example so failed and success are represented alongside inProgress, with their callback messages correctly assigned; done means the published section shows all three events accurately.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100