Contributor docs: author API versions via service.yaml
Open
Beginner friendly
docs
feature
needs-area
triaged:core
- Dominant language
- TypeScript
- Stars
- 27
- Forks
- 90
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 156
Description
Part of #4825.
RFC: https://github.com/Azure/azure-rest-api-specs/blob/rfc/unified-examples-format/documentation/rfc/service-yaml.md
Update contributor documentation so authors **add/bump API versions in `service.yaml`** (instead of editing `readme.md` tags). Cover ARM and data-plane, TypeSpec and swagger versions.
Depends on #4826.
Contributor guide
Research direction
Start by reading the linked unified examples format RFC, then inspect the contributor documentation and the service.yaml/readme.md references. Done means the documentation explains adding or bumping API versions in service.yaml rather than readme.md tags, covering ARM and data-plane APIs plus TypeSpec and swagger versions, after dependency #4826 is addressed.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100