-
Notifications
You must be signed in to change notification settings - Fork 5.4k
API Spec Review FAQ
Daniel Jurek edited this page Jul 3, 2025
·
7 revisions
Answers to frequently asked questions in the Api Spec Review. Within that channel, EngSys should be answering questions about validation pipelines and tools that run in those pipelines. Specific questions about typespec, the API Review process, etc. should be answered by others who specialize in those topics.
If the question is about | The answer should be |
---|---|
Authoring typespec | Send to TypeSpec Discussions |
My PR is ready to review, will someone review it? | See the "Next steps to merge" comment in your PR and follow directions to ensure you're in the review queue. No need to post here. |
API Doc Preview is broken | If the error message linked doesn't make sense, follow instructions at Troubleshooting REST API documentation. API Doc Preview is not a required check so you can ignore the failure if it's not relevant to your documentation needs. |
My PR needs to be reviewed by the ARM team right now | PRs are generally reviewed in order of the ARM queue. If your PR needs special treatment, you can contact the ARM team: https://aka.ms/armofficehoursinfo |
I need a review to merge changes to a non-standard branch (e.g. not main , RPSaaSMaster , etc.) |
Contact the owner of that branch. |
EngSys is behaving badly in my non-standard/release branch | Update the state of the branch to match with main . The owner of the release branch is responsible for doing this. See documentation: Update your branch with changes from main. |
I need to set up suppressions for LintDiff violations in my PR | See Adding Scoped Suppressions |
I have specific questions about the inner workings of ARM, testing changes to APIs, or rollout/release schedules | Talk to the ARM team: https://aka.ms/armofficehoursinfo |