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

Update Swagger to allow Asynchronous Patch Action and add SKU in the Patch properties #14484

Merged
merged 1 commit into from
May 22, 2021

Conversation

akshita31
Copy link
Contributor

@akshita31 akshita31 commented May 19, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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, @akshita31 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 May 19, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️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] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[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 May 19, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️⌛[Staging] SDK Breaking Change Tracking pending [Detail]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2e3f1e0. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/datadog/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.Datadog [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2e3f1e0. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-datadog [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model DatadogMonitorResourceUpdateParameters has a new parameter sku
      info	[Changelog]   - Added operation MonitorsOperations.begin_update
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Removed operation MonitorsOperations.update
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2e3f1e0. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-05-24 03:17:00 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-datadog;1.0.0-beta.2;1.0.0-beta.3"
      cmderr	[generate.py] 2021-05-24 03:17:00 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.3"
      cmderr	[generate.py] 2021-05-24 03:17:00 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.28 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/datadog/azure-resourcemanager-datadog --java.namespace=com.azure.resourcemanager.datadog   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/datadog/resource-manager/readme.md
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-datadog
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Skip] pom already has module azure-resourcemanager-datadog
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Skip] pom already has module sdk/datadog
      cmderr	[generate.py] 2021-05-24 03:17:35 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-datadog [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Got artifact_id: azure-resourcemanager-datadog
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Got artifact: azure-resourcemanager-datadog-1.0.0-beta.3-sources.jar
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Got artifact: azure-resourcemanager-datadog-1.0.0-beta.3-javadoc.jar
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Got artifact: azure-resourcemanager-datadog-1.0.0-beta.3.jar
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG Match jar package: azure-resourcemanager-datadog-1.0.0-beta.3.jar
      cmderr	[Inst] 2021-05-24 03:21:20 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14484/azure-sdk-for-java/azure-resourcemanager-datadog/azure-resourcemanager-datadog-1.0.0-beta.3.jar\" -o azure-resourcemanager-datadog-1.0.0-beta.3.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-datadog -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-datadog-1.0.0-beta.3.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2e3f1e0. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️datadog/mgmt/2021-03-01/datadog [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `MonitorsClient.Update` return value(s) have been changed from `(MonitorResource, error)` to `(MonitorsUpdateFuture, error)`
      info	[Changelog] - Function `MonitorsClient.UpdateSender` return value(s) have been changed from `(*http.Response, error)` to `(MonitorsUpdateFuture, error)`
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `*MonitorsUpdateFuture.UnmarshalJSON([]byte) error`
      info	[Changelog] - New struct `MonitorsUpdateFuture`
      info	[Changelog] - New field `Sku` in struct `MonitorResourceUpdateParameters`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 4 additive change(s).
      info	[Changelog]
    • ️✔️preview/datadog/mgmt/2020-02-01-preview/datadog [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `MonitorsClient.Update` return value(s) have been changed from `(MonitorResource, error)` to `(MonitorsUpdateFuture, error)`
      info	[Changelog] - Function `MonitorsClient.UpdateSender` return value(s) have been changed from `(*http.Response, error)` to `(MonitorsUpdateFuture, error)`
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `*MonitorsUpdateFuture.UnmarshalJSON([]byte) error`
      info	[Changelog] - New struct `MonitorsUpdateFuture`
      info	[Changelog] - New field `Sku` in struct `MonitorResourceUpdateParameters`
      info	[Changelog]
      info	[Changelog] Total 2 breaking change(s), 4 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2e3f1e0. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/datadog/resource-manager/readme.md
    • ️✔️@azure/arm-datadog [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/microsoftDatadogClient.js → ./dist/arm-datadog.js...
      cmderr	[npmPack] created ./dist/arm-datadog.js in 312ms
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 2e3f1e0. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/datadog/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /MarketplaceAgreements/put/MarketplaceAgreements_CreateOrUpdate
      cmderr	[Autorest]     - name: /MarketplaceAgreements/get/MarketplaceAgreements_List
      cmderr	[Autorest]     - name: /Monitors/put/Monitors_Create
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_Get
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_List
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_ListByResourceGroup
      cmderr	[Autorest]     - name: /Monitors/patch/Monitors_Update
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_GetDefaultKey
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_ListApiKeys
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_ListHosts
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_ListLinkedResources
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_ListMonitoredResources
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_RefreshSetPasswordLink
      cmderr	[Autorest]     - name: /Monitors/post/Monitors_SetDefaultKey
      cmderr	[Autorest]     - name: /SingleSignOnConfigurations/put/SingleSignOnConfigurations_CreateOrUpdate
      cmderr	[Autorest]     - name: /SingleSignOnConfigurations/get/SingleSignOnConfigurations_Get
      cmderr	[Autorest]     - name: /SingleSignOnConfigurations/get/SingleSignOnConfigurations_List
      cmderr	[Autorest]     - name: /TagRules/put/TagRules_CreateOrUpdate
      cmderr	[Autorest]     - name: /TagRules/get/TagRules_Get
      cmderr	[Autorest]     - name: /TagRules/get/TagRules_List
      cmderr	[Autorest]     - name: /Monitors/delete/Monitors_Delete
      cmderr	[Autorest] --------------------------------------------------------
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 2e3f1e0. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      cmderr	[generateScript.sh] (node:2944) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2021-03-01/Microsoft.Datadog.json'
      cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
      cmderr	[generateScript.sh] (node:2944) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
      cmderr	[generateScript.sh] (node:2944) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
      warn	No file changes detected after generation
    • ️✔️datadog [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @openapi-workflow-bot
    Copy link

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

    @akshita31
    Copy link
    Contributor Author

    This pr is a clone of our two merged prs from the private repo below:

    https://github.com/Azure/azure-rest-api-specs-pr/pull/3810
    https://github.com/Azure/azure-rest-api-specs-pr/pull/3515

    The changes above are enabling us to have our PATCH operation as async to enable more scenarios like SKU change that might take more time than allowed in ARM async operation. At the moment, our CLI and SDK are not released so there is no customer impact from CLI and SDK perspective. Also addition of the new 201 response and the Sku property in the patch call doesnt impact any of our existing resources.

    @jorgecotillo jorgecotillo added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 19, 2021
    @akshita31
    Copy link
    Contributor Author

    Hi @njuCZ Please help us to merge this pr. Thank you

    @RAY-316
    Copy link
    Contributor

    RAY-316 commented May 24, 2021

    /azp run