-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Fixing broken links/ updating some sentences #14197
Conversation
Hi, @mimckitt Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[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. |
Swagger Validation Report
|
Rule | Message |
---|---|
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L36 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L223 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L327 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L374 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Update' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L465 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Delete' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L544 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_GrantAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L648 |
D5001 - XmsExamplesRequired |
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_RevokeAccess' Location: Microsoft.Compute/stable/2020-12-01/disk.json#L695 |
R2020 - RequiredPropertiesMissingInResourceModel |
Model definition 'SubResourceWithColocationStatus' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.Compute/stable/2021-03-01/compute.json#L7941 |
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.Compute/stable/2021-03-01/compute.json#L10795 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2021-03-01 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross Version BreakingChange (Base on preview version): 12 Errors, 4 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2016-04-30-preview/compute.json <---> new: stable/2021-03-01/compute.json
Only 10 items are listed, please refer to log for more details.
️❌
Cross Version BreakingChange (Base on stable version): 4 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-12-01/compute.json <---> new: stable/2021-03-01/compute.json
Rule | Message |
---|---|
1037 - ConstraintIsWeaker |
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L785:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L785:11 |
1037 - ConstraintIsWeaker |
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L1081:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L1080:11 |
1037 - ConstraintIsWeaker |
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L3266:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L3243:11 |
1037 - ConstraintIsWeaker |
The new version has a less constraining 'enum' value than the previous one. New: Microsoft.Compute/stable/2021-03-01/compute.json#L6808:11 Old: Microsoft.Compute/stable/2020-12-01/compute.json#L6277:11 |
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
"tag":"package-2021-03-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"compute/resource-manager/readme.md",
"tag":"package-2021-03-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
PreCheck/DuplicateSchema |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "$ref":"#/components/schemas/schemas:1441", "description":"The Offer Promotion Code." ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
AutorestCore/Exception |
"readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"Error: Plugin prechecker reported failure." |
💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"compute/resource-manager/readme.md", "tag":"package-2021-03-01-only", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
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?
Updated broken links, adjusted sentences based on new links and removed en-us from URLs to be compliant with localization standards.
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.
N/A
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
Next rollout
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
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.
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 Breaking Change Review Board as defined in the Breaking Change Policy.
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.