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

Improve AKS Swagger documentation #14696

Closed
wants to merge 3 commits into from
Closed

Improve AKS Swagger documentation #14696

wants to merge 3 commits into from

Conversation

matthchr
Copy link
Member

@matthchr matthchr commented Jun 7, 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: Improving documentation
  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, @matthchr 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 7, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️⚠️LintDiff: 9 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4021 - DescriptionAndTitleMissing 'osDiskSizeGB' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2327
    ⚠️ R4021 - DescriptionAndTitleMissing 'osDiskType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2330
    ⚠️ R4021 - DescriptionAndTitleMissing 'kubeletDiskType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2333
    ⚠️ R4021 - DescriptionAndTitleMissing 'osType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2351
    ⚠️ R4021 - DescriptionAndTitleMissing 'osSKU' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2354
    ⚠️ R4021 - DescriptionAndTitleMissing 'type' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2371
    ⚠️ R4021 - DescriptionAndTitleMissing 'mode' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2374
    ⚠️ R4021 - DescriptionAndTitleMissing 'osType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3657
    ⚠️ R4021 - DescriptionAndTitleMissing 'osType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3978


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2491
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L2584
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3208
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3456
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3580
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L3623
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagedClusters_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L420
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'AgentPools_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L892
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L1448
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'ManagedClusters_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ContainerService/stable/2021-05-01/managedClusters.json#L460
    ️️✔️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

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"containerservice/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"containerservice/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"containerservice/resource-manager/readme.md",
    "tag":"package-2021-05",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"containerservice/resource-manager/readme.md",
    "tag":"package-2021-05-01-only",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"containerservice/resource-manager/readme.md",
    "tag":"package-2021-05-01-only",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[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-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 Jun 7, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-containerservice - 16.0.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2021-05-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2021-03-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2021-02-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-12-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-11-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-09-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-07-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-06-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-04-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-03-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-02-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2020-01-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2019-11-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2019-10-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2019-08-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2019-06-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2019-04-30/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2018-03-31/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2017-09-30/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2017-08-31/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2017-07-01/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2019-10-27-preview/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2019-09-30-preview/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2019-02-01-preview/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2018-09-30-preview/containerservice - v55.3.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2018-08-01-preview/containerservice - v55.3.0
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
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
    • ️✔️azure-mgmt-containerservice [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. 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-06-22 05:52:57 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-containerservice-generated"
cmderr	[generate.py] 2021-06-22 05:52:57 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-06-22 05:52:57 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.30 --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/containerservice/azure-resourcemanager-containerservice-generated --java.namespace=com.azure.resourcemanager.containerservice.generated   --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/containerservice/resource-manager/readme.md
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [POM][Skip] pom already has module azure-resourcemanager-containerservice-generated
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-06-22 05:53:54 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-containerservice-generated [View full logs]  [Preview SDK Changes] 
      cmderr	[Inst] 2021-06-22 05:56:21 DEBUG Got artifact_id: azure-resourcemanager-containerservice-generated
cmderr	[Inst] 2021-06-22 05:56:21 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-06-22 05:56:21 DEBUG Got artifact: azure-resourcemanager-containerservice-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-22 05:56:21 DEBUG Match jar package: azure-resourcemanager-containerservice-generated-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-22 05:56:21 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14696/azure-sdk-for-java/azure-resourcemanager-containerservice-generated/azure-resourcemanager-containerservice-generated-1.0.0-beta.1.jar\" -o azure-resourcemanager-containerservice-generated-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-containerservice-generated -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-containerservice-generated-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. SDK Automation 14.0.0 
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️containerservice/mgmt/2021-05-01/containerservice [View full logs]  [Preview SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2021-03-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2021-02-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-12-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-11-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-09-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-07-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-06-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-04-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-03-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-02-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2020-01-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2019-11-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2019-10-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2019-08-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2019-06-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2019-04-30/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2018-03-31/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2017-09-30/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2017-08-31/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️containerservice/mgmt/2017-07-01/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️preview/containerservice/mgmt/2019-10-27-preview/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️preview/containerservice/mgmt/2019-09-30-preview/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️preview/containerservice/mgmt/2019-02-01-preview/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️preview/containerservice/mgmt/2018-09-30-preview/containerservice [View full logs]  
      info	[Changelog] No exported changes
    • ️✔️preview/containerservice/mgmt/2018-08-01-preview/containerservice [View full logs]  
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/containerservice/resource-manager/readme.md
    • ️✔️@azure/arm-containerservice [View full logs]  [Preview 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/containerServiceClient.js → ./dist/arm-containerservice.js...
cmderr	[npmPack] created ./dist/arm-containerservice.js in 505ms
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. 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/containerservice/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.ContainerService [View full logs]  [Preview SDK Changes] 
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild] /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(47,16): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,58): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Generated/Models/ManagedClusterPodIdentityProvisioningInfo.cs(32,85): error CS0246: The type or namespace name 'CloudError' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/containerservice/Microsoft.Azure.Management.ContainerService/src/Microsoft.Azure.Management.ContainerService.csproj]
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 577fb86e4e22d3d58d20b3f2a4dc6200f0c49000. 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]
cmderr	[initScript.sh]  The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh]  so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh]
cmderr	[initScript.sh]  This is a one-time fix-up, please be patient...
cmderr	[initScript.sh]
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
    • ️✔️containerservice [View full logs]  [Preview Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    matthchr
    matthchr commented Jun 7, 2021
    View reviewed changes
    ...erservice/resource-manager/Microsoft.ContainerService/stable/2021-05-01/managedClusters.json
    },
    "gpuInstanceProfile": {
    "$ref": "#/definitions/GPUInstanceProfile",
    "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g."
    "description": "GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU."
    Copy link
    Member Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    This is a lot of abbreviations. When can this be set? What is it for ? What does it enable? Needs significant clarification.

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Usually API argument doc is a brief introduction. It doesn't cover full details of the usage, which will be covered by feature doc. But the supported values should be kept to make it easier to use.

    @qinchen352 FYI.

    Copy link
    Member Author

    @matthchr matthchr Jun 15, 2021 •
    edited
    Loading

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @xuto2 - The type being ref'ed is an enum with these values. As you can see in the REST API Docs and in the Python SDK when something is defined as an enum it already gets a list of supported values following it.

    In the case of most SDKs (including Python) this results in the awkward:

    GPUInstanceProfile to be used to specify GPU MIG instance profile
    for supported GPU VM SKU. Supported values are MIG1g, MIG2g, MIG3g, MIG4g and MIG7g. Possible
    values include: "MIG1g", "MIG2g", "MIG3g", "MIG4g", "MIG7g".

    Where we say the same thing twice in a row.

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 7, 2021
    Draft
    @matthchr matthchr mentioned this pull request Jun 7, 2021
    Closed
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch from 24ed8eb to b8a60d3 Compare June 11, 2021 02:54
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch 2 times, most recently from 2217814 to f47bd2c Compare June 15, 2021 17:33
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jun 15, 2021
    Draft
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch 2 times, most recently from e4acda5 to df422a6 Compare June 17, 2021 16:02
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch from df422a6 to 4655fad Compare June 21, 2021 17:19
    This was referenced Jun 21, 2021
    Draft
    Draft
    Draft
    Draft
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch from 4655fad to 0f75def Compare June 21, 2021 18:03
    @matthchr matthchr force-pushed the feature/improve-aks-swagger-2 branch from 0f75def to d979edd Compare June 21, 2021 18:18
    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @PhoenixHe-NV
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @matthchr matthchr closed this Jun 22, 2021
    @matthchr
    Copy link
    Member Author

    Closed this PR and opened #14934 to clear breaking change tags that are no longer appropriate as all breaking changes have been removed.

    @matthchr matthchr deleted the feature/improve-aks-swagger-2 branch June 23, 2021 15:16
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @xuto2 xuto2 xuto2 left review comments

    @paulgmiller paulgmiller paulgmiller left review comments

    @Porges Porges Porges left review comments

    @wenwu449 wenwu449 Awaiting requested review from wenwu449

    @weinong weinong Awaiting requested review from weinong

    @robbiezhang robbiezhang Awaiting requested review from robbiezhang

    @thomas1206 thomas1206 Awaiting requested review from thomas1206

    @palma21 palma21 Awaiting requested review from palma21 palma21 will be requested when the pull request is marked ready for review palma21 is a code owner

    Assignees
    No one assigned
    Labels
    CI-BreakingChange-Go CI-BreakingChange-Python
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    6 participants
    @matthchr @ArcturusZhang @PhoenixHe-NV @Porges @paulgmiller @xuto2