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

[Hub Generated] Review request for Microsoft.Security to add version stable/2022-03-01 #17919

Conversation

kerend
Copy link
Contributor

@kerend kerend commented Feb 20, 2022

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

Changelog

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

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

Applicability: ⚠️

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:

  • Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @kerend 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]

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 20, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 3 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R3023 - OperationsAPIImplementation Operations API must be implemented for '/providers/Microsoft.Security/operations'.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L36
    R4009 - RequiredReadOnlySystemData The response of operation:'Pricings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L74
    R4009 - RequiredReadOnlySystemData The response of operation:'Pricings_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L111


    The following errors/warnings exist before current PR submission:

    Rule Message
    R4037 - MissingTypeObject The schema 'PricingList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L154
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'Pricings_Update' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L121
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Pricings_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L38
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get pricings on subscription
    Location: Microsoft.Security/stable/2022-03-01/pricings.json#L75
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️Cross-Version Breaking Changes: 6 Warnings warning [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings' removed or restructured?
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L76:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/pricings/{pricingName}' removed or restructured?
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L197:5
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupName' removed or renamed?
    New: Microsoft.Security/stable/2022-03-01/pricings.json#L227:3
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L352:3
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'Pricings_GetSubscriptionPricing' to 'Pricings_Get'. This will impact generated code.
    New: Microsoft.Security/stable/2022-03-01/pricings.json#L74:7
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L119:7
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'Pricings_UpdateSubscriptionPricing' to 'Pricings_Update'. This will impact generated code.
    New: Microsoft.Security/stable/2022-03-01/pricings.json#L111:7
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L156:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'nextLink' renamed or removed?
    New: Microsoft.Security/stable/2022-03-01/pricings.json#L159:7
    Old: Microsoft.Security/preview/2017-08-01-preview/pricings.json#L289:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 20, 2022

    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.

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

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

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

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

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

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

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

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

    ️⚠️ azure-sdk-for-js warning [Detail]

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

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

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

    ️⚠️ azure-resource-manager-schemas warning [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @kerend, 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.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @kerend kerend marked this pull request as ready for review February 20, 2022 19:21
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 20, 2022
    @openapi-workflow-bot
    Copy link

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

    @kerend
    Copy link
    Contributor Author

    kerend commented Feb 21, 2022

    Targeting deployment to end of March.

    Copy link
    Contributor

    @j5lim j5lim left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Approved from ARM side.

    @j5lim j5lim added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 28, 2022
    @ruowan ruowan merged commit dc59d50 into Azure:main Mar 10, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    …stable/2022-03-01 (Azure#17919)
    
    * Adds base for updating Microsoft.Security from version stable/2018-06-01 to version 2022-03-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * .
    
    * .
    
    * .
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 20, 2022
    …stable/2022-03-01 (Azure#17919)
    
    * Adds base for updating Microsoft.Security from version stable/2018-06-01 to version 2022-03-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * .
    
    * .
    
    * .
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-LintDiff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-JavaScript CI-FixRequiredOnFailure
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants