azure-rest-api-specs [Hub Generated] Review request for Microsoft.Security to add version preview/2023-05-01-preview

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

[ ] I commit to follow the Breaking Change Policy of "no breaking changes"
[ ] I have reviewed the documentation for the workflow.
[ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: :warning:

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

[x] 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
[ ] 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.

May 22 '23 13:05 talco773

Hi, @talco773 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

May 22 '23 13:05 openapi-workflow-bot[bot]

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
customRecommedations.json	2023-05-01-preview(dd3fdee)	2023-05-01-preview(main)
securityStandards.json	2023-05-01-preview(dd3fdee)	2023-05-01-preview(main)
standardAssignments.json	2023-05-01-preview(dd3fdee)	2023-05-01-preview(main)

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L82:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L82:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L165:5

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️⌛CredScan pending [Detail]

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

compared tags (via openapi-validator v2.1.2)	new version	base version
package-composite-v3	package-composite-v3(dd3fdee)	package-composite-v3(main)

️🔄Avocado inProgress [Detail]

️⌛ApiReadinessCheck pending [Detail]

️⌛~[Staging] ServiceAPIReadinessTest pending [Detail]

️⌛SwaggerAPIView pending [Detail]

️⌛CadlAPIView pending [Detail]

️⌛TypeSpecAPIView pending [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) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️⌛CadlValidation pending [Detail]

️⌛TypeSpec Validation pending [Detail]

️⌛PR Summary pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

May 22 '23 13:05 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

_{Posted by Swagger Pipeline | How to fix these errors?}

May 22 '23 13:05 openapi-pipeline-app[bot]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.Security	https://apiview.dev/Assemblies/Review/df88a164a775411a8efbd1246c6ce893

May 22 '23 13:05 openapi-pipeline-app[bot]

Hi @talco773, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

May 22 '23 13:05 openapi-workflow-bot[bot]

Hi, @talco773 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

May 23 '23 06:05 openapi-workflow-bot[bot]

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

May 23 '23 19:05 openapi-workflow-bot[bot]

The automation detected this Pull Request introduces breaking changes to an existing API version and hence it added the NewApiVersionRequired label. This means you cannot proceed with merging this PR until you complete one of the following action items:

- A) Submit a new PR instead of this one, or modify this PR, so that it introduces a new API version instead of introducing breaking changes to an existing API version. The automation will remove the label once it detects there are no more breaking changes.
- B) OR you can request an approval of the breaking changes, get it reviewed, and approved. The reviewer will add Approved-BreakingChange label if they approve.

For additional guidance, please see https://aka.ms/NewApiVersionRequired

May 29 '23 12:05 openapi-workflow-bot[bot]

@talco773, please fix the [must fix] lint error.

Jun 06 '23 09:06 ms-zhenhua

@talco773, please fix the [must fix] lint error.

@ms-zhenhua some of the failures seems like false alarms:

NoDuplicatePathsForScopeParameter: Why these two scopes are duplications? '/{scope}/providers/Microsoft.Security/customRecommendations/{customRecommendationName}' is a duplicate of path '/{scope}/providers/Microsoft.Security/customRecommendations' that has the scope parameter.'??? One is list and one is get single

DeleteOperationAsyncResponseValidation: The link doesn't work...

TopLevelResourcesListBySubscription: All the resources I added have the following path: /{scope}/providers/Microsoft.Security/ResourceType and the 'scope' can be subscription

Jun 07 '23 14:06 talco773

Swagger Validation Report

️❌BreakingChange: 6 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
customRecommedations.json	2023-05-01-preview(0d6fa56)	2023-05-01-preview(main)
securityStandards.json	2023-05-01-preview(0d6fa56)	2023-05-01-preview(main)
standardAssignments.json	2023-05-01-preview(0d6fa56)	2023-05-01-preview(main)

Rule	Message
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/customRecommedations.json#L82:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/securityStandards.json#L82:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L37:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.Security/preview/2023-05-01-preview/standardAssignments.json#L165:5

️️✔️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 v2.1.3)	new version	base version
package-composite-v3	package-composite-v3(0d6fa56)	package-composite-v3(main)

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
:warning: MULTIPLE_API_VERSION	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

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView 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.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️All merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

Jun 08 '23 09:06 openapi-pipeline-app[bot]

@ms-zhenhua you didn't add any comment. What else should be fixed?

Jun 09 '23 14:06 talco773

@talco773 I left the following comment. Kindly help confirm it. Thanks. https://github.com/Azure/azure-rest-api-specs/pull/24090#discussion_r1223788132

Jun 10 '23 00:06 ms-zhenhua

@talco773 I left the following comment. Kindly help confirm it. Thanks. #24090 (comment)

I replied the relevant comment

Jun 11 '23 06:06 talco773

@talco773 I left the following comment. Kindly help confirm it. Thanks. #24090 (comment)

I replied the relevant comment

Please see the latest respond on the comment, thanks

Jun 12 '23 22:06 zizw123

@talco773 I left the following comment. Kindly help confirm it. Thanks. #24090 (comment)

I replied the relevant comment

Please see the latest respond on the comment, thanks

@zizw123 replied to your comment, please see the latest respond

Jun 13 '23 12:06 talco773

/azp run

Jun 29 '23 02:06 kazrael2119

Azure Pipelines successfully started running 1 pipeline(s).

Jun 29 '23 02:06 azure-pipelines[bot]

this js sdk breaking may be caused by changing default tag from composite-v3 to a new apiversion

Jun 29 '23 02:06 kazrael2119

Please merge latest main after https://github.com/Azure/azure-rest-api-specs/pull/24457 get merged. and then rerun the pipeline.

Jun 29 '23 06:06 qiaozha

What is left to do before the merge? I already got signoff

Jul 11 '23 11:07 talco773

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

Jul 11 '23 11:07 openapi-workflow-bot[bot]

/azp run

Jul 24 '23 19:07 visingla-ms

No commit pushedDate could be found for PR 24090 in repo Azure/azure-rest-api-specs

Jul 24 '23 19:07 azure-pipelines[bot]

Hi, @talco773. 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 no-recent-activity label.