Skip to content

Conversation

@shahafal
Copy link
Contributor

@shahafal shahafal commented May 17, 2022

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: May 2022
  3. When do you expect to publish the swagger? Please provide date or, the if date is not yet available, the month: May 2022
  4. If updating an existing version, please select the specific language 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 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 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, @shahafal 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 17, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'Settings_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-05-01/settings.json#L124
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled
    Location: Microsoft.Security/stable/2022-05-01/settings.json#L252
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled
    Location: Microsoft.Security/stable/2022-05-01/settings.json#L265
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ 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]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️Cross-Version Breaking Changes: 3 Warnings warning [Detail]
    The following breaking changes are detected by comparison with latest preview version:
    Rule Message
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'DataExportSetting' removed or renamed?
    New: Microsoft.Security/stable/2022-05-01/settings.json#L156:3
    Old: Microsoft.Security/preview/2017-08-01-preview/settings.json#L156:3
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'DataExportSetting' from the old version.
    New: Microsoft.Security/stable/2022-05-01/settings.json#L213:9
    Old: Microsoft.Security/preview/2017-08-01-preview/settings.json#L196:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'DataExportSetting' from the old version.
    Old: Microsoft.Security/preview/2017-08-01-preview/settings.json#L125:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌PoliCheck: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    "readme":"security/resource-manager/readme.md",
    "tag":"package-composite-v3",
    "details":"Error: Plugin prechecker reported failure."
    ️️✔️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 May 17, 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 warning [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.

    ️❌ azure-powershell failed [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 openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 17, 2022
    @openapi-workflow-bot
    Copy link

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

    @shahafal
    Copy link
    Contributor Author

    the only change in this PR is the addition of a new name in the SettingName enum, everything else stayed exactly the same as version 2021-07-01 that was published in #15093

    @mentat9
    Copy link
    Member

    mentat9 commented Jun 1, 2022

    @shahafal - Please create a new PR following this process (and check the box when you submit):

    [ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

    Note: it's fine if you don't want to use OpenAPIHub to set up your new API version PR. In that case, please create it manually by copying the current API version files [unmodified] to the new API version folder and commit that as your first commit of the PR. Apply other changes in subsequent commits. This is required for ARM review.

    Ref: https://armwiki.azurewebsites.net/rp_onboarding/process/api_review.html#introduction.

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 1, 2022
    @shahafal
    Copy link
    Contributor Author

    shahafal commented Jun 6, 2022

    Please create a new PR following this process (and check the box when you submit):

    hi @mentat9 i started a new PR with OpenAPIHub as requested:
    #19334

    @mentat9
    Copy link
    Member

    mentat9 commented Jun 6, 2022

    Please create a new PR following this process (and check the box when you submit):

    hi @mentat9 i started a new PR with OpenAPIHub as requested: #19334

    @shahafal - Thank-you, your PR has been handed off to this week's oncall. Please close this PR.

    "info": {
    "title": "Microsoft Defender for Cloud",
    "description": "API spec for Microsoft.Security (Microsoft Defender for Cloud) resource provider",
    "version": "2022-05-01"
    Copy link

    Choose a reason for hiding this comment

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

    2022-05-01"

    this is still incorrect , you need to add the previous version of settings.json as the first checkin or else we cannot do a diff to see the changes

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    hi @raosuhas ,
    please notice that as per @mentat9 request in the comments i started a new PR using OpenAPIHub with the previous version in a separate commit.
    i added a link to the new PR in my previous comment ^ and i also pointed to the latest PR in my email to ARM RP API Review (that you responded on)
    in case you still missed it - here is the link again #19334

    "MCAS",
    "WDATP",
    "WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW",
    "WDATP_UNIFIED_SOLUTION",
    Copy link

    Choose a reason for hiding this comment

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

    Is this the only change ? renaming the enum value ?This would be a breaking change , please get approval if that is required.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

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

    the change is not renaming an enum value, it's adding a new value to it WDATP_UNIFIED_SOLUTION.
    please notice that i made a very similar change on July 2021 (added the value WDATP_EXCLUDE_LINUX_PUBLIC_PREVIEW to the enum) that was accepted #15093

    Copy link

    @raosuhas raosuhas left a comment

    Choose a reason for hiding this comment

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

    🕐

    @shahafal shahafal closed this Jun 9, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants