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

Migrate to net track2 for some resource-manager readmes batch 2 #20092

Merged
merged 1 commit into from
Aug 5, 2022

Conversation

fengzhou-msft
Copy link
Member

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 appy 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 3, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⌛CredScan pending [Detail]
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v1.13.0) new version base version
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
default default(2c9a6fc) default(main)
️⚠️Avocado: 4 Warnings warning [Detail]
Rule Message
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/compute/resource-manager/readme.md
tag: specification/compute/resource-manager/readme.md#tag-package-2022-04-04
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/containerregistry/resource-manager/readme.md
tag: specification/containerregistry/resource-manager/readme.md#tag-package-2022-02-preview
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/mysql/resource-manager/readme.md
tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/postgresql/resource-manager/readme.md
tag: specification/postgresql/resource-manager/readme.md#tag-package-2020-01-01
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⌛PoliCheck pending [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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi @fengzhou-msft, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth. @Frey-Wang , please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.

  • You can refer to Service API Toolset Introduction for details.
  • Please contact service focal @Frey-Wang contacts or Service API Toolset Support Channel if need further help.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 3, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️❌SDK Breaking Change Tracking failed [Detail]

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

    ️❌ azure-sdk-for-net-track2 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-python-track2 warning [Detail]

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

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

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

    ️❌ azure-resource-manager-schemas failed [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.

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

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 3, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Java azure-resourcemanager-authorization-generated https://apiview.dev/Assemblies/Review/cfdf2ccbb9c64169be17ca3fe7cae194
    Java azure-resourcemanager-azurestackhci https://apiview.dev/Assemblies/Review/bc66cc05cedf4159a44eab50990f693b
    .Net Azure.ResourceManager.ApiManagement https://apiview.dev/Assemblies/Review/fb1c60dd16394f258ede8aa8e7793610
    Java azure-resourcemanager-batch https://apiview.dev/Assemblies/Review/6c679d9f50a0495dacfa4ffcc4aa8ca6
    .Net Azure.ResourceManager.Authorization There is no API change compared with the previous version
    Java azure-resourcemanager-cognitiveservices https://apiview.dev/Assemblies/Review/eac3be93c71c4597a1a95d35fee26cbc
    .Net Azure.ResourceManager.Batch There is no API change compared with the previous version
    .Net Azure.ResourceManager.CognitiveServices There is no API change compared with the previous version
    .Net Azure.ResourceManager.Compute There is no API change compared with the previous version
    .Net Azure.ResourceManager.ContainerInstance https://apiview.dev/Assemblies/Review/78b7fd9b857a4c7cb9c3b98eb9be84b4
    Java azure-resourcemanager-compute-generated https://apiview.dev/Assemblies/Review/ae3b3676a3bf40269d726f992998c147
    .Net Azure.ResourceManager.ContainerRegistry There is no API change compared with the previous version
    .Net Azure.ResourceManager.GuestConfiguration There is no API change compared with the previous version
    Java azure-resourcemanager-containerinstance-generated https://apiview.dev/Assemblies/Review/d736e277c61a4b66b8c51c7c87c74700
    .Net Azure.ResourceManager.HDInsight There is no API change compared with the previous version
    .Net Azure.ResourceManager.Hci There is no API change compared with the previous version
    Java azure-resourcemanager-containerregistry-generated https://apiview.dev/Assemblies/Review/53ef545c2f92453ca308dce7c6abf33b
    .Net Azure.ResourceManager.IotHub There is no API change compared with the previous version
    .Net Azure.ResourceManager.Logic There is no API change compared with the previous version
    .Net Azure.ResourceManager.Media There is no API change compared with the previous version
    .Net Azure.ResourceManager.Migrate https://apiview.dev/Assemblies/Review/f932a32e81b144f2ba4d46db6c095a29
    .Net Azure.ResourceManager.MySql https://apiview.dev/Assemblies/Review/73da5ff6da204b4dbb5418c0911512d3
    Java azure-resourcemanager-datafactory https://apiview.dev/Assemblies/Review/2ed8873dc8fd463894e771e17b86b32c
    .Net Azure.ResourceManager.NotificationHubs There is no API change compared with the previous version
    .Net Azure.ResourceManager.PostgreSql https://apiview.dev/Assemblies/Review/3a9444169cee42e6819ee2060330ed08
    .Net Azure.ResourceManager.Redis There is no API change compared with the previous version
    .Net Azure.ResourceManager.RedisEnterpriseCache There is no API change compared with the previous version
    Java azure-resourcemanager-iothub https://apiview.dev/Assemblies/Review/19631410a4fe4be6852f9b66e87a203c
    .Net Azure.ResourceManager.ServiceFabric There is no API change compared with the previous version
    .Net Azure.ResourceManager.SqlVirtualMachine There is no API change compared with the previous version
    Java azure-resourcemanager-logic https://apiview.dev/Assemblies/Review/5eb6dce59f7a49858ca9772307346b9a
    .Net Azure.ResourceManager.StreamAnalytics https://apiview.dev/Assemblies/Review/f10614ca83ba4d8a86c4a94bc8d02e36
    Java azure-resourcemanager-mediaservices https://apiview.dev/Assemblies/Review/2927d58a81ab46c0a92c7be1d7f8465d
    Java azure-resourcemanager-mysqlflexibleserver https://apiview.dev/Assemblies/Review/79860c34a0b1484b8cd94e3f0bfdc197
    Java azure-resourcemanager-notificationhubs https://apiview.dev/Assemblies/Review/b5c1f26da2cf43aba35e6ff55216e43d
    Java azure-resourcemanager-postgresqlflexibleserver https://apiview.dev/Assemblies/Review/2c5565c019d14cf999caf92c008c2fe3
    Java azure-resourcemanager-redis-generated https://apiview.dev/Assemblies/Review/aff6473dc04b44c18ffa46c7b4c98459
    Java azure-resourcemanager-redisenterprise https://apiview.dev/Assemblies/Review/5e0b5f2d91114a80ab925690f37e7b20
    Java azure-resourcemanager-servicefabric https://apiview.dev/Assemblies/Review/9b629dab53ae420789b4cc03031f07df
    Java azure-resourcemanager-sqlvirtualmachine https://apiview.dev/Assemblies/Review/e048750703d1405f89f6edeb1abf7f86
    JavaScript @azure/arm-apimanagement https://apiview.dev/Assemblies/Review/2c7debd1242141cca7afce9b3cfa84e0
    JavaScript @azure/arm-authorization https://apiview.dev/Assemblies/Review/523feb62b40843b3b557740879de0458
    JavaScript @azure/arm-azurestackhci https://apiview.dev/Assemblies/Review/40406ac64fa14352984962507d8614db
    JavaScript @azure/arm-batch There is no API change compared with the previous version
    JavaScript @azure/arm-cognitiveservices https://apiview.dev/Assemblies/Review/0e5d0f10c30741af964df929ee88884e
    JavaScript @azure/arm-compute https://apiview.dev/Assemblies/Review/87b391fec0f343a5a73c809410bc91ad
    JavaScript @azure/arm-containerinstance https://apiview.dev/Assemblies/Review/b2f11f626b2344b6ac6782bc1da7ddac
    JavaScript @azure/arm-containerregistry https://apiview.dev/Assemblies/Review/163c6148b29c4338ad0f7cde61a5b751
    JavaScript @azure/arm-datafactory https://apiview.dev/Assemblies/Review/2e2fc811fabc4cc9ae44c738f93637ea
    JavaScript @azure/arm-hdinsight There is no API change compared with the previous version
    JavaScript @azure/arm-iothub https://apiview.dev/Assemblies/Review/5b1b273cc0ad43cda52b8019d2dce57b
    JavaScript @azure/arm-logic https://apiview.dev/Assemblies/Review/08e2d45305994886bb29e1a73e337c55
    JavaScript @azure/arm-mediaservices There is no API change compared with the previous version
    JavaScript @azure/arm-migrate There is no API change compared with the previous version
    JavaScript @azure/arm-notificationhubs https://apiview.dev/Assemblies/Review/c42cc874cec14778a4ead256e90991b9
    JavaScript @azure/arm-rediscache https://apiview.dev/Assemblies/Review/8acb5cb09e2b45cb9f974420519a673d
    JavaScript @azure/arm-redisenterprisecache https://apiview.dev/Assemblies/Review/209ac8824c8e4b33b84b31d7cf796419
    JavaScript @azure/arm-streamanalytics https://apiview.dev/Assemblies/Review/2ba18a28daef4a49ba55729c2194663b
    Python track2_azure-mgmt-apimanagement Create ApiView timeout. Package is too large and we cannot create ApiView for it.
    Python track2_azure-mgmt-authorization Create ApiView timeout. Package is too large and we cannot create ApiView for it.
    Python track2_azure-mgmt-azurestackhci Create ApiView timeout. Package is too large and we cannot create ApiView for it.
    Python track2_azure-mgmt-batch https://apiview.dev/Assemblies/Review/8dc4249ef2ec4ab7b40616f5a7231e6c
    Python track2_azure-mgmt-cognitiveservices https://apiview.dev/Assemblies/Review/47accf2c09b74f51bd2ec78411693703
    Python track2_azure-mgmt-compute Create ApiView timeout. Package is too large and we cannot create ApiView for it.
    Python track2_azure-mgmt-containerinstance https://apiview.dev/Assemblies/Review/ee3515f375984955a73826f666931d25
    Python track2_azure-mgmt-containerregistry Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-guestconfig Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-hdinsight Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-logic Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-media Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-notificationhubs Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-rdbms Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-redis Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-redisenterprise Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-servicefabric Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-sqlvirtualmachine Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help
    Python track2_azure-mgmt-streamanalytics Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. If issue still exists, please ask PR assignee for help

    @openapi-workflow-bot openapi-workflow-bot bot added ShiftLeftViolation DoNotMerge <valid label in PR review process> use to hold merge after approval labels Aug 3, 2022
    This was referenced Aug 5, 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