Skip to content

Conversation

@michimune
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. April 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. April 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 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, @michimune 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-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 6, 2022
    @openapi-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 6, 2022

    Swagger Validation Report

    ️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L18:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L68:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L122:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L180:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L234:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L285:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L333:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.App/stable/2022-03-01/Diagnostics.json#L388:5
    ️❌LintDiff: 2 Errors, 8 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R3026 - TrackedResourcePatchOperation Tracked resource 'Diagnostics' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well.
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L459
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L673
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L468
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'ManagedEnvironmentDiagnotics_ListDetectors' might be pageable. Consider adding the x-ms-pageable extension.
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L286
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'detectors' with immediate parent 'ContainerApp', must have a list by immediate parent operation.
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L459
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'detectors' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation.
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L459
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVisible
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L644
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Container App's revisions
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L169
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Container App's revision
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L227
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Container App
    Location: Microsoft.App/stable/2022-03-01/Diagnostics.json#L278
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: location
    Url: Microsoft.App/stable/2022-03-01/Diagnostics.json#L459:20
    ExampleUrl: stable/2022-03-01/examples/ContainerAppsDiagnostics_List.json
    ️️✔️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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    HowToFix Code style issues found
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json
    ️❌SpellCheck: 6 Errors, 0 Warnings failed [Detail]
    Rule Message
    HowToFix Unknown word (Diagnoticss), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L25:38
    HowToFix Unknown word (Diagnosticss), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L75:38
    HowToFix Unknown word (detectorproperties), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L234:118
    HowToFix Unknown word (Diagnotics), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L293:43
    HowToFix Unknown word (Diagnotics), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L341:43
    HowToFix Unknown word (detectorproperties), please fix the error or add words to ./custom-words.txt
    path: Microsoft.App/stable/2022-03-01/Diagnostics.json#L388:124
    ️️✔️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 Apr 6, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️❌ azure-sdk-for-python-track2 failed [Detail]
    • Failed [Logs] Generate from fd0f71f455c16fe2408c9e45d5a5d10954ac7c46. 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
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest] warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future.
      cmdout	[automation_generate.sh] [Autorest]   - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{name}/detectorproperties/rootApi/
      cmdout	[automation_generate.sh] [Autorest] error   | DuplicateOperation | Duplicate Operation 'ManagedEnvironments' > 'get' detected(This is most likely due to 2 operation using the same 'operationId' or 'tags'). Duplicates have those paths:
      cmdout	[automation_generate.sh] [Autorest]   - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}/detectorproperties/rootApi/
      cmdout	[automation_generate.sh] [Autorest]   - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{name}
      cmdout	[automation_generate.sh] [Autorest] fatal   | Error: 2 errors occured -- cannot continue.
      cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
      cmdout	[automation_generate.sh] [Autorest] error   |   Error: Plugin checker reported failure.
      cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from fd0f71f455c16fe2408c9e45d5a5d10954ac7c46. 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
    • ️✔️azure-resourcemanager-app [View full logs]  [Preview SDK Changes]
    ️❌ azure-sdk-for-go-track2 failed [Detail]
    • Failed [Logs] Generate from fd0f71f455c16fe2408c9e45d5a5d10954ac7c46. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
      cmderr	[generator automation-v2] [ERROR] total 1 error(s):
      cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/app/armapp�[0m
      cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/app/armapp, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/app/armapp
      cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/app/armapp
      cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/app/armapp
      cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.0.6335; node: v14.19.1, max-memory: 8192 MB]
      cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
      cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
      cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.1).
      cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
      cmderr	[generator automation-v2] [ERROR] SourceMapConsumer.initialize is a no-op when running in node.js
      cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.7.3)
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.0.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.1.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.2.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.3.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.4.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.5.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.6.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.7.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.8.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.9.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] warning | DeprecatedConfig | Using directive.10.suppress which is deprecated and will be removed in the future.
      cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
      cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh.exe": exit status 1
      cmderr	[generator automation-v2] [ERROR] ': exit status 1
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
      warn	Skip package processing as generation is failed
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs] Generate from fd0f71f455c16fe2408c9e45d5a5d10954ac7c46. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from fd0f71f455c16fe2408c9e45d5a5d10954ac7c46. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
      warn	No file changes detected after generation
    • ️✔️app [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @michimune michimune closed this Apr 13, 2022
    @michimune michimune deleted the add-app-diag branch April 13, 2022 18:53
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    CI-FixRequiredOnFailure WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants