[Microsoft.Security] Migrate APIs from Microsoft.ApiSecurity RP (currently in private preview) to Microsoft.Security RP #21519
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, @aditdalvi 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 |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @aditdalvi your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-composite-v3 | package-composite-v3(2cad077) | package-composite-v3(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L51 |
||
| The response of operation:'APICollection_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L85 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L98 |
||
| The response of operation:'APICollectionOnboarding_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L130 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L143 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2022-11-20-preview/apiCollections.json#L188 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Tag package-composite-v3; Prod region: Not deployed; Canary region: Not deployed
️️✔️~[Staging] SwaggerAPIView 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.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Notes to the reviewer:
|
|
Hi @aditdalvi, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @aditdalvi, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Nov 11, 2022
rkmanda
reviewed
Nov 11, 2022
.../security/resource-manager/Microsoft.Security/preview/2022-11-20-preview/apiCollections.json
Show resolved
Hide resolved
rkmanda
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
aditdalvi
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
Swagger Validation Report
|
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/security/resource-manager/readme.md tag: specification/security/resource-manager/readme.md#tag-package-composite-v3 |
️🔄ApiReadinessCheck inProgress [Detail]
️⌛~[Staging] ServiceAPIReadinessTest pending [Detail]
️🔄~[Staging] SwaggerAPIView inProgress [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛PoliCheck pending [Detail]
️⌛PrettierCheck pending [Detail]
️⌛SpellCheck pending [Detail]
️⌛Lint(RPaaS) pending [Detail]
️⌛CadlValidation pending [Detail]
️⌛PR Summary pending [Detail]
AzureRestAPISpecReview
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
eliagrady
reviewed
Nov 13, 2022
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
ruowan
approved these changes
Nov 15, 2022
This was referenced Nov 15, 2022
Closed
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
…ently in private preview) to Microsoft.Security RP (Azure#21519) * Adds base for updating Microsoft.Security from version stable/2021-06-01 to version 2022-11-20-preview * Updates readme * Updates API version in new specs and examples * Add apiCollections.json and relevant examples * Update readme.md * Fix validation errors * Fix validation errors * One more fix * Switch to full paths * More validation fixes * Try and fix the SDK errors * Fix avocado error * Remove operations.json from tag = package-preview-2022-11 based on PR comments
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
…ently in private preview) to Microsoft.Security RP (Azure#21519) * Adds base for updating Microsoft.Security from version stable/2021-06-01 to version 2022-11-20-preview * Updates readme * Updates API version in new specs and examples * Add apiCollections.json and relevant examples * Update readme.md * Fix validation errors * Fix validation errors * One more fix * Switch to full paths * More validation fixes * Try and fix the SDK errors * Fix avocado error * Remove operations.json from tag = package-preview-2022-11 based on PR comments
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.
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.