add managed cert API in 2022-11-01-preview #21281
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
|
Hi, @ElleTojaroon 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.10.1)] | new version | base version |
|---|---|---|
| CommonDefinitions.json | 2022-11-01-preview(3878867) | 2022-03-01(main) |
| CommonDefinitions.json | 2022-11-01-preview(3878867) | 2022-06-01-preview(main) |
| ManagedEnvironments.json | 2022-11-01-preview(3878867) | 2022-03-01(main) |
| ManagedEnvironments.json | 2022-11-01-preview(3878867) | 2022-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L102:5 Old: Microsoft.App/stable/2022-03-01/CommonDefinitions.json#L37:5 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L582:11 Old: Microsoft.App/stable/2022-03-01/CommonDefinitions.json#L474:11 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different default value than the previous one. New: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L687:13 Old: Microsoft.App/preview/2022-06-01-preview/CommonDefinitions.json#L687:13 |
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(3878867) | package-preview-2022-11(release-app-Microsoft.App-2022-11-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L980 |
||
| The child tracked resource, 'managedCertificates' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L971 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L635 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or Update Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L709 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L761 |
||
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Patch Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L823 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L850 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L1376 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L1 |
|
| The child tracked resource, 'daprComponents' with immediate parent 'ConnectedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L666 |
|
| The child tracked resource, 'daprComponents' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L666 |
|
| The child tracked resource, 'certificates' with immediate parent 'ConnectedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L841 |
|
| The child tracked resource, 'certificates' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-11-01-preview/CommonDefinitions.json#L841 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: internal Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L1081 |
|
| The resource 'workloadProfileStates' does not have get operation, please add it. Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L1367 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List environments by resource group Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L94 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get environments by name Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L141 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Patch Managed Environment Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L302 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L407 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or Update Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L467 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L519 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Patch Certificate Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L581 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Certificates_CheckNameAvailability Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L929 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List environments by subscription Location: Microsoft.App/preview/2022-11-01-preview/ManagedEnvironments.json#L1029 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 12 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
resource-manager
WaitForARMFeedback
|
Hi @ElleTojaroon, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Oct 26, 2022
|
Hi, @ElleTojaroon your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
@leni-msft failed validations are not related to this PR. Please let me know if it is ready to merge. This sub resource type will be in prod in November. |
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
vinisoto
approved these changes
Nov 1, 2022
|
Hi, @ElleTojaroon. 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 |
ghost
added
|
@leni-msft could you please help merging this PR please? It is blocked by failed validations not related to changes in the PR. |
leni-msft
approved these changes
Dec 6, 2022
|
Suppressing the model validation errors, which need to be fixed in the future |
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.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.