Fix a couple issues with existing swaggers #19735
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 4 commits
July 7, 2022 15:04
…ontract" This reverts commit 5d12256.
…ST API even API does not have a response
|
Hi, @thomasp98296 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| actionGroups_API.json | 2022-04-01(5b5114c) | 2022-04-01(main) |
| actionGroups_API.json | 2022-06-01(5b5114c) | 2022-06-01(main) |
Only 30 items are listed, please refer to log for more details.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-06 | package-2022-06(5b5114c) | package-2022-06(main) |
| package-2022-04 | package-2022-04(5b5114c) | package-2022-04(main) |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2022-06 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/5b5114c2898e2993372b423e5463870d4e255924/specification/monitor/resource-manager/readme.md#tag-package-2022-06">monitor/resource-manager/readme.md#package-2022-06
- "https://github.com/Azure/azure-rest-api-specs/blob/5b5114c2898e2993372b423e5463870d4e255924/specification/monitor/resource-manager/readme.md#tag-package-2022-06-01-only">monitor/resource-manager/readme.md#package-2022-06-01-only
- "https://github.com/Azure/azure-rest-api-specs/blob/5b5114c2898e2993372b423e5463870d4e255924/specification/monitor/resource-manager/readme.md#tag-package-2022-04">monitor/resource-manager/readme.md#package-2022-04
- "https://github.com/Azure/azure-rest-api-specs/blob/5b5114c2898e2993372b423e5463870d4e255924/specification/monitor/resource-manager/readme.md#tag-package-2022-04-01-only">monitor/resource-manager/readme.md#package-2022-04-01-only
| Rule | Message |
|---|---|
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06", "details":"Duplicate Schema named 'Resource' (2 differences):\n - properties.kind: => "$ref":"#/components/schemas/schemas:630", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true\n - properties.etag: => "$ref":"#/components/schemas/schemas:631", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06", "details":"Duplicate Schema named 'ErrorResponse' (6 differences):\n - properties.code.$ref: "#/components/schemas/schemas:66" => "#/components/schemas/schemas:831"\n - properties.code.description: "Error code" => "The error code."\n - properties.code.readOnly: => true\n - properties.message.$ref: "#/components/schemas/schemas:67" => "#/components/schemas/schemas:832"\n - properties.message.description: "Error message indicating why the operation failed." => "The error message indicating why the operation failed."\n - properties.message.readOnly: => true; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06", "details":"Duplicate Schema named 'AzureResource' (11 differences):\n - properties.id.description: "Azure resource Id" => "The resource Id."\n - properties.name.description: "Azure resource name" => "The name of the resource."\n - properties.type.description: "Azure resource type" => "The type of the resource."\n - properties.kind: "$ref":"#/components/schemas/schemas:232", "description":"Azure resource kind", "readOnly":true =>\n - properties.identity: "$ref":"#/components/schemas/schemas:233", "description":"Azure resource identity", "readOnly":true =>\n - properties.location.x-ms-mutability.0: "create" => "read"\n - properties.location.x-ms-mutability.1: "read" => "create"\n - properties.location.$ref: "#/components/schemas/schemas:234" => "#/components/schemas/schemas:800"\n - properties.location.description: "Resource location" => "The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'."\n - properties.tags.description: "Resource tags" => "The tags of the resource."\n - required: ["location"] =>; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06", "details":"Duplicate Schema named 'ActionGroup' (17 differences):\n - properties.groupShortName: "$ref":"#/components/schemas/schemas:270", "description":"The short name of the action group. This will be used in SMS messages." =>\n - properties.enabled: "type":"boolean", "default":true, "description":"Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." =>\n - properties.emailReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:271", "description":"The list of email receivers that are part of this action group." =>\n - properties.smsReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:272", "description":"The list of SMS receivers that are part of this action group." =>\n - properties.webhookReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:273", "description":"The list of webhook receivers that are part of this action group." =>\n - properties.itsmReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:274", "description":"The list of ITSM receivers that are part of this action group." =>\n - properties.azureAppPushReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:275", "description":"The list of AzureAppPush receivers that are part of this action group." =>\n - properties.automationRunbookReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:276", "description":"The list of AutomationRunbook receivers that are part of this action group." =>\n - properties.voiceReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:277", "description":"The list of voice receivers that are part of this action group." =>\n - properties.logicAppReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:278", "description":"The list of logic app receivers that are part of this action group." =>\n - properties.azureFunctionReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:279", "description":"The list of azure function receivers that are part of this action group." =>\n - properties.armRoleReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:280", "description":"The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." =>\n - properties.eventHubReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:281", "description":"The list of event hub receivers that are part of this action group." =>\n - properties.actionGroupId: => "$ref":"#/components/schemas/schemas:823", "description":"The resource ID of the Action Group. This cannot be null or empty."\n - properties.webhookProperties: => "$ref":"#/components/schemas/schemas:824", "description":"the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload."\n - required.0: "groupShortName" => "actionGroupId"\n - required.1: "enabled" =>; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06", "details":"Error: 4 errors occured -- cannot continue." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04", "details":"Duplicate Schema named 'Resource' (2 differences):\n - properties.kind: => "$ref":"#/components/schemas/schemas:629", "description":"Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.", "readOnly":true\n - properties.etag: => "$ref":"#/components/schemas/schemas:630", "description":"The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ", "readOnly":true; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04", "details":"Duplicate Schema named 'ErrorResponse' (6 differences):\n - properties.code.$ref: "#/components/schemas/schemas:66" => "#/components/schemas/schemas:830"\n - properties.code.description: "Error code" => "The error code."\n - properties.code.readOnly: => true\n - properties.message.$ref: "#/components/schemas/schemas:67" => "#/components/schemas/schemas:831"\n - properties.message.description: "Error message indicating why the operation failed." => "The error message indicating why the operation failed."\n - properties.message.readOnly: => true; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04", "details":"Duplicate Schema named 'AzureResource' (11 differences):\n - properties.id.description: "Azure resource Id" => "The resource Id."\n - properties.name.description: "Azure resource name" => "The name of the resource."\n - properties.type.description: "Azure resource type" => "The type of the resource."\n - properties.kind: "$ref":"#/components/schemas/schemas:232", "description":"Azure resource kind", "readOnly":true =>\n - properties.identity: "$ref":"#/components/schemas/schemas:233", "description":"Azure resource identity", "readOnly":true =>\n - properties.location.x-ms-mutability.0: "create" => "read"\n - properties.location.x-ms-mutability.1: "read" => "create"\n - properties.location.$ref: "#/components/schemas/schemas:234" => "#/components/schemas/schemas:799"\n - properties.location.description: "Resource location" => "The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'."\n - properties.tags.description: "Resource tags" => "The tags of the resource."\n - required: ["location"] =>; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04", "details":"Duplicate Schema named 'ActionGroup' (17 differences):\n - properties.groupShortName: "$ref":"#/components/schemas/schemas:270", "description":"The short name of the action group. This will be used in SMS messages." =>\n - properties.enabled: "type":"boolean", "default":true, "description":"Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." =>\n - properties.emailReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:271", "description":"The list of email receivers that are part of this action group." =>\n - properties.smsReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:272", "description":"The list of SMS receivers that are part of this action group." =>\n - properties.webhookReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:273", "description":"The list of webhook receivers that are part of this action group." =>\n - properties.itsmReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:274", "description":"The list of ITSM receivers that are part of this action group." =>\n - properties.azureAppPushReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:275", "description":"The list of AzureAppPush receivers that are part of this action group." =>\n - properties.automationRunbookReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:276", "description":"The list of AutomationRunbook receivers that are part of this action group." =>\n - properties.voiceReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:277", "description":"The list of voice receivers that are part of this action group." =>\n - properties.logicAppReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:278", "description":"The list of logic app receivers that are part of this action group." =>\n - properties.azureFunctionReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:279", "description":"The list of azure function receivers that are part of this action group." =>\n - properties.armRoleReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:280", "description":"The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." =>\n - properties.eventHubReceivers: "x-ms-identifiers":[], "$ref":"#/components/schemas/schemas:281", "description":"The list of event hub receivers that are part of this action group." =>\n - properties.actionGroupId: => "$ref":"#/components/schemas/schemas:822", "description":"The resource ID of the Action Group. This cannot be null or empty."\n - properties.webhookProperties: => "$ref":"#/components/schemas/schemas:823", "description":"the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload."\n - required.0: "groupShortName" => "actionGroupId"\n - required.1: "enabled" =>; 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." |
|
"readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04", "details":"Error: 4 errors occured -- cannot continue." |
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2022-06-01-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"monitor/resource-manager/readme.md", "tag":"package-2022-04-01-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
Hi @thomasp98296, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
NewApiVersionRequired reason: |
|
Hi @thomasp98296, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Jul 11, 2022
Closed
added 3 commits
July 12, 2022 09:45
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
@xiaoxuqi-ms , I would like to give you a background on this breaking changes. There are two issues that I am fixing here:
I went to Swagger Breaking Changes Office hours yesterday, and was confirmed that because these never worked, so there is no need to update the API version. I should just fix it in the current versions instead (again because these never worked). Please let me know if there is any other information needed from me. Else I would appreciate if we can proceed this. Thanks! |
mikekistler
added
the
Approved-BreakingChange
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
xiaoxuqi-ms
approved these changes
Jul 19, 2022
This was referenced Jul 19, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] 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.
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.