Document the service.yaml manifest - #5338
Open
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Open
Document the service.yaml manifest#5338Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Conversation
Contributor
|
No changes needing a change description found. |
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
August 28, 2026 18:02
Timothee Guerin (timotheeguerin)
requested review from
Mark Cowlishaw (markcowl) and
Jeff Fisher (xirzec)
as code owners
August 28, 2026 18:02
Contributor
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
enabled auto-merge
August 28, 2026 19:33
Mark Cowlishaw (markcowl)
requested changes
Aug 31, 2026
| managed by the emitter. | ||
|
|
||
| :::caution | ||
| A project defining multiple services can't be described by a single manifest. The emitter warns and |
There was a problem hiding this comment.
We should include some additional documentation on how to handle this scenario, with examples
Member
Author
There was a problem hiding this comment.
do we have any services like that? with actually multiple @service in the same spec?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@azure-tools/typespec-autoresthas been emittingservice.yamlsince #4846, but the only documentation is the generatedservice-yamlemitter option entry. Nothing explains what the file is or why a spec author should care about it — which is the part that actually matters during the rollout.Adds a short page under Howtos & Examples → Publish REST API Spec that leads with the why: version metadata used to live in
readme.mdtags, folder names and conventions, hand-maintained and easy to drift from the spec;service.yamlgives it one schema-validated home generated from the spec itself.The rest is deliberately minimal — an annotated example, and just enough mechanics to act on it: how the emitter fills in
source: typespecentries, that hand-authoredsource: swaggerentries are left alone, and the multi-service caveat.Preview:
/docs/howtos/rest-api-publish/service-yaml/(no sidebar change needed, thehowtosdirectory is autogenerated).Part of #4829.