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

Add xms-ids for multiple RPs (maintenance~marketplaceordering) #17740

Merged
merged 1 commit into from
Feb 15, 2022
Merged

Add xms-ids for multiple RPs (maintenance~marketplaceordering) #17740

merged 1 commit into from
Feb 15, 2022

Conversation

LinglingTong
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 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, @LinglingTong 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 Feb 9, 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:

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

    Rule Message
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L65
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L120
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L163
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L222
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L274
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L316
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L367
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L428
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L512
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L557
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L615
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L665
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L717
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L765
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L823
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L873
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L925
    ❌ R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.ManagedNetwork/preview/2019-06-01-preview/managedNetwork.json#L961
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagementGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L94
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagementGroupSubscriptions_GetSubscription' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L433
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'HierarchySettings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L553
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagementGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L152
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagementGroupSubscriptions_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L353
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'HierarchySettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L587
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagementGroups_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L212
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'HierarchySettings_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Management/stable/2021-04-01/management.json#L624
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json#L66
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json#L102
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json#L151
    ❌ R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json#L194
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/mariadb/resource-manager/readme.md
    tag: specification/mariadb/resource-manager/readme.md#tag-package-2020-01-01
    ️️✔️~[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 succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️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 9, 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 failed [Detail]

    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-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-resource-manager-schemas warning [Detail]

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

    ️❌ azure-sdk-for-python failed [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-sdk-for-net failed [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.

    Posted by Swagger Pipeline | How to fix these errors?

    @LinglingTong
    Copy link
    Contributor Author

    This PR is to add the missing x-ms-identifiers metadata: http://azure.github.io/autorest/extensions/#x-ms-identifiers for the following RPs:

    • Maintenance
    • Managednetwork
    • Managedservices
    • Managementgroups
    • Managementpartner
    • Maps
    • Mariadb
    • Marketplace
    • Marketplacenotifications
    • Marketplaceordering

    @openapi-workflow-bot
    Copy link

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

    This was referenced Feb 9, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    This was referenced Feb 9, 2022
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    @LinglingTong
    Copy link
    Contributor Author

    @weidongxu-microsoft looking at the error in SDK zaure-sdk-for-python it seems that this check needs to be updated for allowing the x-ms-identifiers proeprty. Is there anyone we could involve in to look into this?
    cmdout [automation_generate.sh] [Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers

    @LinglingTong
    Copy link
    Contributor Author

    Also @ArcturusZhang who had looked into similar failures of SDK zaure-sdk-for-go check a couple days ago. @ArcturusZhang any idea who could be looking at the azure-sdk-for-python failures?

    This was referenced Feb 15, 2022
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Feb 15, 2022
    [ReleasePR mariadb] Add xms-ids for multiple RPs (maintenance~marketp…
    d120ab6 
    …laceordering) (#2177)

Create to sync Azure/azure-rest-api-specs#17740
[ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/mariadb?expand=1)
    This was referenced Feb 15, 2022
    Closed
    Closed
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    @LinglingTong @FredericHeem
    add xms-ids for RPs (set 5) (Azure#17740)
    a55523b
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ArcturusZhang ArcturusZhang ArcturusZhang approved these changes

    @weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft approved these changes

    Assignees

    @weidongxu-microsoft weidongxu-microsoft

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

    Successfully merging this pull request may close these issues.
    5 participants
    @LinglingTong @weidongxu-microsoft @msyyc @stack111 @ArcturusZhang