-
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
Fixerrorresponseschema #20002
Fixerrorresponseschema #20002
Conversation
Hi, @ruslany 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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
ContainerApps.json | 2022-01-01-preview(b18598b) | 2022-01-01-preview(main) |
ContainerApps.json | 2022-03-01(b18598b) | 2022-03-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-03 | package-2022-03(b18598b) | package-2022-03(main) |
package-2022-01-01-preview | package-2022-01-01-preview(b18598b) | package-2022-01-01-preview(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-01-01-preview/ContainerApps.json#L148 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-01-01-preview/ContainerApps.json#L209 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L148 |
|
The summary and description values should not be same. Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L209 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L561 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: external Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L597 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowInsecure Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L640 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: latestRevision Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L717 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHostnameAlreadyVerified Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L767 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: hasConflictOnManagedEnvironment Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L837 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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/b18598b18fc94aad88057a1811c472b3033c2734/specification/app/resource-manager/readme.md#tag-package-2022-03">app/resource-manager/readme.md#package-2022-03
- "https://github.com/Azure/azure-rest-api-specs/blob/b18598b18fc94aad88057a1811c472b3033c2734/specification/app/resource-manager/readme.md#tag-package-2022-01-01-preview">app/resource-manager/readme.md#package-2022-01-01-preview
Rule | Message |
---|---|
"readme":"app/resource-manager/readme.md", "tag":"package-2022-03", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"app/resource-manager/readme.md", "tag":"package-2022-01-01-preview", "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
|
Generated ApiView
|
@lirenhe - This PR fixes the existent bug in the swagger for the released versions as the swagger schema does not match the actual API response returned by RP. |
Hi @ruslany, 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. |
NewApiVersionRequired reason: |
I see. But as this PR would cause breaking change, please go through the process for review. Thanks 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. |
@lirenhe - the breaking change was approved. Please merge the PR |
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.