Skip to content
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

update bizapps #29122

Conversation

dvir-ms
Copy link
Member

@dvir-ms dvir-ms commented May 16, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented May 16, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented May 16, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 2 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-04 package-preview-2024-04(1719d8b) package-preview-2024-04(dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-04-01-preview)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json#L752
⚠️ XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json#L762


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.SecurityInsights/preview/2024-04-01-preview/BusinessApplicationAgents.json#L187
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 16, 2024

Swagger Generation Artifacts

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

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

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

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

️❌ azure-sdk-for-go failed [Detail]

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

️❌ azure-sdk-for-python-track2 failed [Detail]

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

️🔄 azure-sdk-for-js inProgress [Detail]
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

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

️❌ azure-resource-manager-schemas failed [Detail]

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

️⚠️ azure-powershell warning [Detail]

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

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 16, 2024

Generated ApiView

Language Package Name ApiView Link
.Net Azure.ResourceManager.SecurityInsights There is no API change compared with the previous version
Java azure-resourcemanager-securityinsights https://apiview.dev/Assemblies/Review/94d98f0a635f4ee98bd2349d9b276a14?revisionId=1a0ec26a6a2f463883d2f3cb84e9be61
Swagger Microsoft.SecurityInsights https://apiview.dev/Assemblies/Review/d30cc3bd7c484ad880bc3b8126f67ba5?revisionId=0a3d982fbb4548419890046e92509fda

@dvir-ms dvir-ms force-pushed the dvirnaim-dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-04-01-preview branch from 5d52e7f to 3aa5803 Compare May 16, 2024 14:32
@dvir-ms
Copy link
Member Author

dvir-ms commented May 21, 2024

hi @ms-henglu @raosuhas

after this pr you reviewed - #28504
I changed the swagger a little bit

the current PR is not for master but for a side branch that we reviewing before taking to main (this is a new feature so no breaking change)

mostly rearrange the models (added a sub model) and added a new parameter
in addition - due to a conflict in the C# SDK with System class - we renamed this definition

I see now that I cant ask for an arm review - can you pls add this label for me?

thanks a lot!

…tyInsights-2024-04-01-preview' of https://github.com/dvir-ms/azure-rest-api-specs into dvirnaim-dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-04-01-preview
@xuhumsft xuhumsft added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 23, 2024
@gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 29, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 29, 2024
@xuhumsft xuhumsft merged commit a3236df into Azure:dev-Sentinel-securityinsights-Microsoft.SecurityInsights-2024-04-01-preview May 29, 2024
24 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants