-
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
[Hub Generated] Review request for Microsoft.Security to add version preview/2023-02-15-preview #23397
[Hub Generated] Review request for Microsoft.Security to add version preview/2023-02-15-preview #23397
Conversation
…3-01-preview to version 2023-02-15-preview
Hi, @pontufle 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 tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-composite-v3 | package-composite-v3(b3b9c96) | package-composite-v3(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
PathForPutOperation |
The path for 'put' operation must be under a subscription and resource group. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L37 |
RPC-Put-V1-01 |
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L147 |
|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L161 |
|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L203 |
|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L261 |
|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L279 |
|
GuidUsage |
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L298 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'UpdateSensitivitySettings' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema' Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L38 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L44 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L84 |
||
Based on the response model schema, operation 'SensitivitySettings_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L111 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L114 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L189 |
||
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json#L192 |
️⚠️
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 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hey, We have already gone through the review process in the private repo, and got sign-off for it: Thanks |
Hi @pontufle, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
lintDiff failure already has been approved. approve in this PR. |
…preview/2023-02-15-preview (#23397) * Adds base for updating Microsoft.Security from version preview/2023-03-01-preview to version 2023-02-15-preview * Updates readme * Updates API version in new specs and examples * Update to match private repo * update readme to include sensitivitySettings * fixing the readme * remove change from readme * fix warnings --------- Co-authored-by: Elad Stavi <[email protected]>
…preview/2023-02-15-preview (Azure#23397) * Adds base for updating Microsoft.Security from version preview/2023-03-01-preview to version 2023-02-15-preview * Updates readme * Updates API version in new specs and examples * Update to match private repo * update readme to include sensitivitySettings * fixing the readme * remove change from readme * fix warnings --------- Co-authored-by: Elad Stavi <[email protected]>
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.