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.

Sign up for GitHub

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

Jump to bottom

Correct 2019-01-01-preview: Use IncidentSeverity in IncidentInfo #15762

Merged
merged 1 commit into from
Sep 8, 2021
Merged

Correct 2019-01-01-preview: Use IncidentSeverity in IncidentInfo #15762

merged 1 commit into from
Sep 8, 2021

Conversation

anat-gilenson
Copy link
Contributor

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.

  • 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, @anat-gilenson 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. vsswagger@microsoft.com

    @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 Aug 24, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'Critical' from the old version.
    New: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L7903:9
    Old: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L7903:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/Cases.json#L1113
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L49
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4485
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3385
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2957
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L6666
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4735
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4740
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4745
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L5153
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3288
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3293
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3298
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3303
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3257
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3262
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3267
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3272
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3277
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4735
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4740
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4745
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L5153
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4485
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3385
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L2957
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L6666
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3288
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3293
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L3298
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2019-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2019-01-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    Rule Message
    ❌ AutorestCore/Exception "readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2019-01-preview",
    "details":"Error: Semantic validation failed. There was some errors"
    💬 AutorestCore/Exception "readme":"securityinsights/resource-manager/readme.md",
    "tag":"package-2019-01-preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️[Staging] 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 Aug 24, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

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

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

    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

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

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

    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-python-track2 warning [Detail]

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

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

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

    ️❌ azure-cli-extensions failed [Detail]

    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?

    @anat-gilenson anat-gilenson changed the title Use IncidentSeverity in IncidentInfo Correct 2019-01-01-preview: Use IncidentSeverity in IncidentInfo Aug 24, 2021
    @openapi-workflow-bot
    Copy link

    Hi @anat-gilenson, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    This was referenced Aug 24, 2021
    Closed
    Closed
    This was referenced Aug 24, 2021
    Closed
    Closed
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 24, 2021
    @ArcturusZhang ArcturusZhang added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Aug 26, 2021
    @msyyc
    Copy link
    Member

    msyyc commented Aug 26, 2021

    Hi @anat-gilenson Please get approve from reviewer to merge the PR.

    @msyyc msyyc merged commit 8834471 into Azure:main Sep 8, 2021
    This was referenced Sep 8, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    iscai-msft added a commit to iscai-msft/azure-rest-api-specs that referenced this pull request Sep 10, 2021
    @iscai-msft
    Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …
    f8e292d 
    …into add_endpoint

* 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits)
  Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967)
  Updated SKU property to be read only (Azure#15965)
  Add Microsoft.Communication.UserDisconnected Event (Azure#15870)
  Add collection APIs (Azure#15221)
  [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699)
  Adding default error response & updating basePath (Azure#15784)
  Update readme and readme.python (Azure#15973)
  add synapse batch tag package-composite-v1 (Azure#15974)
  Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680)
  change readme.go.md template to track 2 (Azure#15972)
  [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817)
  Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954)
  DiskRP swagger for 2021-04-01 (Azure#15665)
  Use IncidentSeverity in IncidentInfo (Azure#15762)
  Add stable API version "2021-09-01" (Azure#15897)
  add-purview-typescript-file (Azure#15948)
  Swagger Completeness for Microsoft.Authorization (Azure#15253)
  [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861)
  Add swagger for missing CheckPolicyRestrictions API version (Azure#15888)
  Add Red Hat OpenShift 2021-09-01-preview (Azure#15616)
  ...
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @msyyc msyyc msyyc approved these changes

    @igalshapira igalshapira Awaiting requested review from igalshapira

    Assignees

    @msyyc msyyc

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-Python CI-BreakingChange-Go FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @anat-gilenson @msyyc @JeffreyRichter @ArcturusZhang