Azure / Azure/azure-rest-api-specs
Provide x-ms-examples for all the AppService APIs
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
It is a requirement to provide x-ms-examples for all the operations in a swagger spec. We perform model validation to ensure that the provided example matches the schema defined in the swagger specification. This helps us in catching bugs early-on in the process. The documentation team generates fiddler like traces from the x-ms-examples. Hence, providing x-ms-examples for all the operations in the swagger spec is a MUST.
Contributor guide
Research direction
Locate the AppService Swagger specifications and enumerate their operations. Review how model validation checks x-ms-examples against the defined schemas, then add validated examples for every operation so the documentation team can generate traces without missing examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100