Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add filters and words so full repo passes cSpell #11474

Closed
wants to merge 30 commits into from

Conversation

nschonni
Copy link
Contributor

@nschonni nschonni commented Nov 1, 2020

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

Contribution checklist:

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

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

@AutorestCI
Copy link

You don't have permission to trigger SDK Automation.
Please add yourself to Azure group from opensource portal if you are MSFT employee,
or please ask reviewer to add comment *** /openapibot sdkautomation ***.
Please ask tih@microsoft.com (or NullMDR in github) for additional help.

@ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Nov 1, 2020
@ghost
Copy link

ghost commented Nov 1, 2020

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 1, 2020

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.

️⚠️LintDiff: 0 Warnings warning [Detail]
The following errors/warnings exist before current PR submission:

Only 10 items are listed, please refer to log for more details.

Rule Message
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ResourceNavigationLinks_Get'
Location: Microsoft.Network/stable/2019-02-01/virtualNetwork.json#L597
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ServiceAssociationLinks_Get'
Location: Microsoft.Network/stable/2019-02-01/virtualNetwork.json#L640
R2020 - RequiredPropertiesMissingInResourceModel Model definition 'InterfaceEndpoint' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json#L273
R2020 - RequiredPropertiesMissingInResourceModel Model definition 'InterfaceEndpoint' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/stable/2018-12-01/interfaceEndpoint.json#L267
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/stable/2020-08-01/network.json#L247
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/stable/2020-08-01/network.json#L247
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/stable/2020-08-01/network.json#L247
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/preview/2021-02-01-preview/network.json#L300
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/stable/2020-08-01/network.json#L247
R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/stable/2020-08-01/network.json#L247
️❌Avocado: 1 Errors, 4 Warnings failed [Detail]
Rule Message
MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
folder: work/1/c93b354fd9c14905bb574a8834c4d69b/scripts
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/billing/resource-manager/readme.md
tag: specification/billing/resource-manager/readme.md#tag-package-2020-05
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/monitor/resource-manager/readme.md
tag: specification/monitor/resource-manager/readme.md#tag-package-2020-03
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/mysql/resource-manager/readme.md
tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/policyinsights/resource-manager/readme.md
tag: specification/policyinsights/resource-manager/readme.md#tag-package-2021-01
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️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 inProgress [Detail]
️️✔️[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-workflow-bot
Copy link

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.
  • 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. vsswagger@microsoft.com

    1 similar comment
    @openapi-workflow-bot
    Copy link

    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.
  • 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. vsswagger@microsoft.com

    @nschonni
    Copy link
    Contributor Author

    nschonni commented Nov 1, 2020

    I didn't update the CI workflow in script/spellcheck.ts because the filtering from the util is also used by the prettier task and would cause a bunch of other formatting changes

    @nschonni nschonni force-pushed the cspell branch 2 times, most recently from cbeb8b9 to 215ccdd Compare November 2, 2020 00:19
    Copy link
    Member

    @heaths heaths left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Search and Key Vault changes LGTM. I didn't review the others.

    @ghost
    Copy link

    ghost commented Jan 3, 2021

    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.

    This was referenced Apr 18, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    CI-BreakingChange-Python customer-reported Issues that are reported by GitHub users external to the Azure organization.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants