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

Added additionalProperties to itemsKeyValue to resolve autorest issues #18170

Merged
merged 3 commits into from
Mar 25, 2022
Merged

Added additionalProperties to itemsKeyValue to resolve autorest issues #18170

merged 3 commits into from
Mar 25, 2022

Conversation

ushasan
Copy link
Contributor

@ushasan ushasan commented Mar 10, 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.
  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 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 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, @ushasan 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 Mar 10, 2022 •
    edited
    Loading

    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
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'watchlistItems' with immediate parent 'Watchlist', must have a list by immediate parent operation.
    Location: Microsoft.SecurityInsights/preview/2022-04-01-preview/Watchlists.json#L612
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeleted
    Location: Microsoft.SecurityInsights/preview/2022-04-01-preview/Watchlists.json#L542
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDeleted
    Location: Microsoft.SecurityInsights/preview/2022-04-01-preview/Watchlists.json#L643
    ️️✔️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.

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 10, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

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

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

    ️⚠️SDK Breaking Change Tracking warning [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-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 @ushasan, 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.

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Mar 10, 2022
    Draft
    This was referenced Mar 10, 2022
    Draft
    Draft
    This was referenced Mar 14, 2022
    Draft
    Draft
    @ushasan
    Copy link
    Contributor Author

    ushasan commented Mar 14, 2022

    @dw511214992 please review when you get the chance

    @dw511214992 dw511214992 merged commit 825f08d into Azure:dev-Sentinel-2022-04-01-preview Mar 25, 2022
    dw511214992 pushed a commit that referenced this pull request Mar 30, 2022
    @anat-gilenson @dosegal
    @NoaGoren @ushasan
    dev-Sentinel-2022-04-01-preview (#18410)
    4122f37 
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-01-01-preview to version 2022-04-01-preview

* Updates readme

* Updates API version in new specs and examples

* Fix ThreatInteliignece accordig to latest preview for alignment (#18231)

* Add UebaEntityProviders to EntityAnalyticsSettings (#18196)

* Add UebaEntityProviders to EntityAnalyticsSettings

* remove ueba

* Added additionalProperties to itemsKeyValue to resolve autorest issues (#18170)

* added additionalProperties to itemsKeyValue to resolve autorest issues

* Update Watchlists.json

* ran prettier-fix

* Remove readonly property from ownerType (#18450)

Co-authored-by: dosegal <[email protected]>
Co-authored-by: NoaGoren <[email protected]>
Co-authored-by: ushasan <[email protected]>
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    @anat-gilenson @dosegal
    @NoaGoren @ushasan @FredericHeem
    dev-Sentinel-2022-04-01-preview (Azure#18410)
    2197881 
    * Adds base for updating Microsoft.SecurityInsights from version preview/2022-01-01-preview to version 2022-04-01-preview

* Updates readme

* Updates API version in new specs and examples

* Fix ThreatInteliignece accordig to latest preview for alignment (Azure#18231)

* Add UebaEntityProviders to EntityAnalyticsSettings (Azure#18196)

* Add UebaEntityProviders to EntityAnalyticsSettings

* remove ueba

* Added additionalProperties to itemsKeyValue to resolve autorest issues (Azure#18170)

* added additionalProperties to itemsKeyValue to resolve autorest issues

* Update Watchlists.json

* ran prettier-fix

* Remove readonly property from ownerType (Azure#18450)

Co-authored-by: dosegal <[email protected]>
Co-authored-by: NoaGoren <[email protected]>
Co-authored-by: ushasan <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @dw511214992 dw511214992 dw511214992 approved these changes

    Assignees

    @dw511214992 dw511214992

    Labels
    CI-BreakingChange-Go-V2 CI-BreakingChange-JavaScript
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @ushasan @dw511214992