docs: clarify type-name conventions between route bundles and v2 profile configs#19
Closed
himorishige wants to merge 1 commit into
Closed
Conversation
…ile configs Signed-off-by: Hiroshi Morishige <hiroshi.morishige@gmail.com>
Contributor
|
@himorishige Thanks for the contribution. This deserves a fix in the code to unify rather than docs. So I will prefer that |
Contributor
Author
|
Closing in favor of #22 — per your suggestion, this unifies the type-name spellings in code (the v2 |
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
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.
What
Adds a short note to the getting-started guide clarifying that legacy route bundles (
--routing-profiles routes.yaml) use snake_case route types (random_routing) while v2 profile configs (switchyard serve --config profiles.yaml) use hyphenated profile types (random-routing,llm-routing).Why
Following the quickstart, we copied
type: random_routinginto a v2 profile config and hitunknown profile type 'random_routing'. The two formats are easy to conflate for new users, since the quickstart teaches the bundle format whileexamples/profiles.yamland the serve docs use the v2 format. A one-paragraph note at the point of first contact avoids the confusion.The note follows the existing blockquote style used by the adjacent "Format default and caching" note in the same file.
Notes