[dev-tool] use package scope when generating sample apiref link #32465
Conversation
This file contains 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
Currently the apiref link template has a hardcoded `@azure` scope so it doesn't work for packages with `@azure-rest` scope. Those package relies on the customized `apiRef` fields in the samples configuration section of package.json. This PR adds package scope variable to the apiref link template as well so the link generatation works for both `@azure` and `@azure-rest` scopes. These two scopes are the only ones that have SDK API reference pages currently.
jeremymeng
requested review from
mpodwysocki,
timovv,
qiaozha,
MaryGao,
dubiety,
andykao1213,
xirzec and
a team
as code owners
github-actions
bot
added
dev-tool
deyaaeldeen
approved these changes
Jan 8, 2025
|
FYI @kazrael2119 |
|
API change check API changes are not detected in this pull request. |
mpodwysocki
reviewed
Jan 9, 2025
deyaaeldeen
reviewed
Jan 9, 2025
jeremymeng
commented
Jan 9, 2025
consume the response body
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.
Currently the apiref link template has a hardcoded
@azurescope so it doesn'twork for packages with
@azure-restscope. Those package relies on thecustomized
apiRefLinkfields in the samples configuration section ofpackage.json. This PR adds package scope variable to the apiref link template as
well so the link generatation works for both
@azureand@azure-restscopes.These two scopes are the only ones that have SDK API reference pages currently.
With this change, customized
apiRefLinkfor -rest packages are also removed.