[KeyVault] - Add exclusion for known spellcheck issue #18031

maorleger · 2022-02-28T20:00:42Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-02-28T20:00:44Z

Hi, @maorleger Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-workflow-bot · 2022-02-28T20:00:45Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2022-02-28T20:00:46Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-02-28T20:00:46Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

_{Posted by Swagger Pipeline | How to fix these errors?}

cSpell.json

maorleger · 2022-03-01T16:51:39Z

@heaths not sure why pipeline is pending for public.rest-api-specs - do you know who owns this pipeline or who I can reach out to?

heaths · 2022-03-01T18:59:36Z

According to https://github.com/Azure/azure-rest-api-specs/pull/18031/checks?check_run_id=5366659603 it completed. Seems to be an AzDO/GitHub interaction issue. I've seen these too many times before.

@lmazuel can you merge this so we can proceed with the Key Vault / Managed HSM swagger GA?

maorleger · 2022-03-03T16:09:25Z

@lmazuel friendly ping - would you mind merging this for us? The builds all pass, just seems that GH isn't getting updated...

heaths · 2022-03-03T19:15:33Z

/azp run public.rest-api-specs

azure-pipelines · 2022-03-03T19:15:44Z

Azure Pipelines successfully started running 1 pipeline(s).

heaths · 2022-03-03T19:39:37Z

@akning-ms the public.rest-api-specs pipeline, despite succeeding, is not reporting back status rather frequently. On this PR it's been twice. I restarted the pipeline and it again completed successfully. Can someone from your team look into this? As the only "error" preventing checks from passing, I cannot merge this and we have to have admins do it.

@lmazuel can you please merge this? Despite what checks show here, if you go to the checks tab itself it shows all pipelines passed. Unfortunately, that's not enough to allow me to merge it. This will hold up our KV release.

…stable/7.3 (#18028) * Adds base for updating Microsoft.KeyVault from version preview/7.3-preview to version 7.3 * Updates readme * Updates API version in new specs and examples * [KeyVault] - Add exclusion for known spellcheck issue (#18031) * add exclusion for known spellcheck issue * collapse cspell ignore for keyvault's storage.json

…stable/7.3 (Azure#18028) * Adds base for updating Microsoft.KeyVault from version preview/7.3-preview to version 7.3 * Updates readme * Updates API version in new specs and examples * [KeyVault] - Add exclusion for known spellcheck issue (Azure#18031) * add exclusion for known spellcheck issue * collapse cspell ignore for keyvault's storage.json

add exclusion for known spellcheck issue

bab0ef8

openapi-assignment-bot bot assigned qiaozha Feb 28, 2022

heaths approved these changes Feb 28, 2022

View reviewed changes

cSpell.json Outdated Show resolved Hide resolved

heaths approved these changes Feb 28, 2022

View reviewed changes

collapse cspell ignore for keyvault's storage.json

abf03f1

maorleger force-pushed the dev-keyvault-Microsoft.KeyVault-7.3-suppress-cspell branch from c5fb4a5 to abf03f1 Compare March 2, 2022 22:55

kurtzeborn merged commit c25e398 into Azure:dev-keyvault-Microsoft.KeyVault-7.3 Mar 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[KeyVault] - Add exclusion for known spellcheck issue #18031

[KeyVault] - Add exclusion for known spellcheck issue #18031

Uh oh!

maorleger commented Feb 28, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 28, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 28, 2022

Uh oh!

openapi-pipeline-app bot commented Feb 28, 2022 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Feb 28, 2022 •

edited

Loading

Breaking Changes Tracking

Uh oh!

Uh oh!

maorleger commented Mar 1, 2022

Uh oh!

heaths commented Mar 1, 2022

Uh oh!

maorleger commented Mar 3, 2022

Uh oh!

heaths commented Mar 3, 2022

Uh oh!

azure-pipelines bot commented Mar 3, 2022

Uh oh!

heaths commented Mar 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

[KeyVault] - Add exclusion for known spellcheck issue #18031

[KeyVault] - Add exclusion for known spellcheck issue #18031

Uh oh!

Conversation

maorleger commented Feb 28, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Feb 28, 2022

Uh oh!

openapi-workflow-bot bot commented Feb 28, 2022

Uh oh!

openapi-pipeline-app bot commented Feb 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Feb 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

Uh oh!

maorleger commented Mar 1, 2022

Uh oh!

heaths commented Mar 1, 2022

Uh oh!

maorleger commented Mar 3, 2022

Uh oh!

heaths commented Mar 3, 2022

Uh oh!

azure-pipelines bot commented Mar 3, 2022

Uh oh!

heaths commented Mar 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

openapi-pipeline-app bot commented Feb 28, 2022 •

edited

Loading

openapi-pipeline-app bot commented Feb 28, 2022 •

edited

Loading