fix: Renamed spec files and incorrect cSpell ignores #12584

nschonni · 2021-01-24T20:03:43Z

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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 · 2021-01-24T20:03:45Z

Hi, @nschonni 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-pipeline-app · 2021-01-24T20:03: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.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

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

Validation passes for SDKTrack2Validation

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-pipeline-app · 2021-01-24T20:03:46Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

ghost · 2021-01-24T20:03:49Z

Thank you for your contribution nschonni! We will review the pull request and get back to you soon.

raych1 · 2021-01-25T07:16:16Z

cSpell.json

@@ -716,9 +716,8 @@
            ]
        },
        {
-            "filename": "**/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json",
+            "filename": "**/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/NetworkRuleSet-preview.json",


This file doesn't exist in master branch.

Right, looks like it got renamed again in #11743

Looks like this is fixed now, so I removed it and added some related missing file-specific overrides that had gotten added to the root dictionary

Did a little test script and cleaned out some other renamed files

const fs = require('fs'); const cspell = JSON.parse(fs.readFileSync('cSpell.json', 'utf-8')); cspell.overrides.forEach(element => { let filename = element.filename.substring(3); try { let content = fs.readFileSync(filename, 'utf-8') element.words.forEach(word => { if (content.indexOf(word) === -1) { console.warn(`BAD: ${filename}\n${word}`) } }) } catch (error) { console.warn(`BAD: ${filename}\n${error}`) } });

nschonni · 2021-01-26T00:57:06Z

@raych1 added another missing "Regenerte" for the current failure on the main branch https://github.com/Azure/azure-rest-api-specs/runs/1765899989

ghost · 2021-02-21T16:01:08Z

Hi, @nschonni. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

raych1 · 2021-03-01T02:11:20Z

custom-words.txt

 privatepreview
 projectable
 propogation
 Protectable
-ProviderHub
+Providerhub


Why changed the case?

It had been added with both casings. CamelCase is already treated as separate words by cSpell

raych1 · 2021-03-01T02:12:04Z

custom-words.txt

@@ -1518,7 +1530,6 @@ RSNULL
 rstrnt
 RTMP
 RTSP
-Ruleproperties


How about this removing?

Moved to a file level suppression again

raych1 · 2021-03-01T02:12:13Z

custom-words.txt

@@ -1589,7 +1600,6 @@ sessionids
 sessionstate
 SETACL
 SETEXPIRY
-Setget
 setissuers
 SETOWNER


File level suppression

raych1 · 2021-03-01T02:12:37Z

custom-words.txt

@@ -1971,7 +1982,6 @@ vmimage
 vmname
 vmotion
 VMQS
-vmsizes


File level suppression

raych1 · 2021-03-01T02:15:32Z

custom-words.txt

@@ -2070,29 +2080,3 @@ ziplist
 Zoho
 zoneinfo
 zset
-tpgs


I don't see these words in this file any more. Why do we remove them?

tpgs ProviderHub regionality Resource metdata Exprired saskey vmsize FSLogix

Some were unfixed typos moved to file level suppression in cspell.json, duplicates of words that were already in the file in the right sort location, CamelCase words, that cSpell already treats as separate words, or correctly spelled words like "Resource" that shouldn't be in this overrides dictionary

raych1 · 2021-03-01T02:24:46Z

cSpell.json

@@ -333,6 +255,12 @@
                "Regenerte"
            ]
        },
+        {
+            "filename": "**/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.1/storage.json",


Can you add for other keyvault versions too?

These were the only ones with the issue

raych1

@nschonni , sorry for the late reply. Can you have a look at my comments?

nschonni · 2021-03-01T02:46:26Z

custom-words.txt

@@ -304,9 +309,11 @@ changedSince
 changepoint
 changestate
 CHECKACCESS
+Checkfeature
+CheckfeatureSupport


I don't think this one is needed since "Checkfeature" is already in, and "Support" would be treated as a separate word because it is camelCase.
It's possible "Checkfeature" should be moved to a file level suppression and fixed in the spec though

Thanks @nschonni for the reply. Can you run the spell check locally for all the specs and check the result?

I did that over in #11474, but due to the size I don't think it's going to land till smaller pieces can be landed to shrink it

raych1 · 2021-03-15T00:39:41Z

@nschonni , could you please resolve the conflicts so that I can merge this PR? Thanks.

nschonni · 2021-03-15T03:14:00Z

@raych1 I've rebased this one. After #12638 and #12638 land, cSpell can be update to v5 with a full clean run, and the runtime across the full repo drops from 16 minutes to 3 😄

raych1 · 2021-03-15T06:36:55Z

@nschonni , can you resolve the conflicts again? Thanks.

nschonni · 2021-03-15T14:58:16Z

@raych1 rebased again

raych1 · 2021-03-16T00:31:12Z

/azp run

azure-pipelines · 2021-03-16T00:31:27Z

Azure Pipelines successfully started running 2 pipeline(s).

openapi-assignment-bot bot assigned raych1 Jan 24, 2021

ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 24, 2021

nschonni force-pushed the renamed-ignored-cspell branch from 6caab09 to f8d0f05 Compare January 25, 2021 03:05

raych1 reviewed Jan 25, 2021

View reviewed changes

nschonni force-pushed the renamed-ignored-cspell branch 4 times, most recently from 6d131c9 to 30e3afa Compare January 25, 2021 07:56

nschonni requested a review from raych1 January 25, 2021 07:58

nschonni force-pushed the renamed-ignored-cspell branch 3 times, most recently from 8ad6f85 to 814bc66 Compare January 25, 2021 08:50

nschonni mentioned this pull request Jan 25, 2021

chore: Don't allow Exprired typo #12579

Closed

25 tasks

nschonni force-pushed the renamed-ignored-cspell branch from 814bc66 to 0798e92 Compare January 25, 2021 08:55

nschonni changed the title ~~fix: Renamed spec files in cSpell ignores~~ fix: Renamed spec files and unneeded cSpell ignores Jan 25, 2021

nschonni changed the title ~~fix: Renamed spec files and unneeded cSpell ignores~~ fix: Renamed spec files and incorrect cSpell ignores Jan 25, 2021

nschonni force-pushed the renamed-ignored-cspell branch from 0798e92 to 222e5ea Compare January 26, 2021 00:47

nschonni force-pushed the renamed-ignored-cspell branch 4 times, most recently from 40036d8 to 771fe35 Compare January 30, 2021 07:05

nschonni force-pushed the renamed-ignored-cspell branch from 771fe35 to 0bc0769 Compare February 4, 2021 04:31

ghost added the no-recent-activity label Feb 21, 2021

nschonni force-pushed the renamed-ignored-cspell branch from 0bc0769 to 69889bf Compare February 21, 2021 16:58

raych1 reviewed Mar 1, 2021

View reviewed changes

raych1 added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Mar 1, 2021

nschonni requested a review from raych1 March 1, 2021 02:38

nschonni force-pushed the renamed-ignored-cspell branch from 69889bf to 4b4c04b Compare March 1, 2021 02:43

nschonni commented Mar 1, 2021

View reviewed changes

nschonni force-pushed the renamed-ignored-cspell branch from 4b4c04b to 3e6001d Compare March 15, 2021 02:39

nschonni marked this pull request as draft March 15, 2021 02:51

nschonni force-pushed the renamed-ignored-cspell branch from 3e6001d to a308d12 Compare March 15, 2021 03:11

nschonni marked this pull request as ready for review March 15, 2021 03:12

fix: Renamed spec files in cSpell ignores

9ebbef1

nschonni force-pushed the renamed-ignored-cspell branch from a308d12 to 9ebbef1 Compare March 15, 2021 14:57

raych1 removed the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Mar 16, 2021

raych1 approved these changes Mar 16, 2021

View reviewed changes

raych1 merged commit ada21ec into Azure:master Mar 16, 2021

nschonni deleted the renamed-ignored-cspell branch March 16, 2021 01:00

MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021

fix: Renamed spec files in cSpell ignores (Azure#12584)

2738bb3

mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021

fix: Renamed spec files in cSpell ignores (Azure#12584)

eaef6a3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Renamed spec files and incorrect cSpell ignores #12584

fix: Renamed spec files and incorrect cSpell ignores #12584

nschonni commented Jan 24, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jan 24, 2021

openapi-pipeline-app bot commented Jan 24, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 24, 2021 •

edited

Loading

ghost commented Jan 24, 2021

raych1 Jan 25, 2021

nschonni Jan 25, 2021

nschonni Jan 25, 2021

nschonni Jan 25, 2021 •

edited

Loading

nschonni commented Jan 26, 2021

ghost commented Feb 21, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 left a comment

nschonni Mar 1, 2021

raych1 Mar 1, 2021

nschonni Mar 1, 2021

raych1 commented Mar 15, 2021

nschonni commented Mar 15, 2021 •

edited

Loading

raych1 commented Mar 15, 2021

nschonni commented Mar 15, 2021

raych1 commented Mar 16, 2021

azure-pipelines bot commented Mar 16, 2021

@@ @@ -1971,7 +1982,6 @@ vmimage @@
               vmname
               vmotion
               VMQS
-              vmsizes

fix: Renamed spec files and incorrect cSpell ignores #12584

fix: Renamed spec files and incorrect cSpell ignores #12584

Conversation

nschonni commented Jan 24, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 24, 2021

openapi-pipeline-app bot commented Jan 24, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 24, 2021 • edited Loading

ghost commented Jan 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nschonni Jan 25, 2021 • edited Loading

Choose a reason for hiding this comment

nschonni commented Jan 26, 2021

ghost commented Feb 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raych1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raych1 commented Mar 15, 2021

nschonni commented Mar 15, 2021 • edited Loading

raych1 commented Mar 15, 2021

nschonni commented Mar 15, 2021

raych1 commented Mar 16, 2021

azure-pipelines bot commented Mar 16, 2021

nschonni commented Jan 24, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 24, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 24, 2021 •

edited

Loading

nschonni Jan 25, 2021 •

edited

Loading

nschonni commented Mar 15, 2021 •

edited

Loading