Add additional Dapr options (2022-05-01) #19410
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
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.6)] | new version | base version |
|---|---|---|
| ContainerApps.json | 2022-05-01(5951b81) | 2022-03-01(main) |
| ContainerApps.json | 2022-05-01(5951b81) | 2022-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-05 | package-2022-05(5951b81) | package-2022-05(Microsoft.App-2022-05-01) |
The following errors/warnings are introduced by current PR:
| Rule | Message |
|---|---|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableApiLogging Location: Microsoft.App/stable/2022-05-01/ContainerApps.json#L607 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The summary and description values should not be same. Location: Microsoft.App/stable/2022-05-01/ContainerApps.json#L148 |
|
| The summary and description values should not be same. Location: Microsoft.App/stable/2022-05-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-05-01/ContainerApps.json#L558 |
|
| 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-05-01/ContainerApps.json#L622 |
|
| 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-05-01/ContainerApps.json#L665 |
|
| 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-05-01/ContainerApps.json#L742 |
|
| 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-05-01/ContainerApps.json#L792 |
|
| 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-05-01/ContainerApps.json#L862 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️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/5951b8119d27b9afe5cd985cc4f35d028528a462/specification/app/resource-manager/readme.md#tag-package-2022-05">app/resource-manager/readme.md#package-2022-05
| Rule | Message |
|---|---|
| "readme":"app/resource-manager/readme.md", "tag":"package-2022-05", "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.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
|
Hi, @ahmelsayed 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] |
1 similar comment
|
Hi, @ahmelsayed 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 Generation Artifacts
|
This was referenced Jun 10, 2022
Draft
ahmelsayed
changed the title
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @ahmelsayed your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
hi @ahmelsayed , referring to https://github.com/Azure/azure-rest-api-specs/pull/19410/checks?check_run_id=6835959217, this PR is for a stable api version containing breaking change. would you please select below option in top comment to require a breaking change review? |
|
@changlong-liu I selected #4 even though it's adding new optional properties to an existing API, but these properties have new validation |
|
Hi @ahmelsayed, 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. |
Hi @ahmelsayed , looks like some properties are removed: https://github.com/Azure/azure-rest-api-specs/pull/19410/checks?check_run_id=6835959217 |
25 tasks
ahmelsayed
changed the title
Generated ApiView
|
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.
…o version 2022-05-01MSFT 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.