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

GA api version changes #12483

Merged
merged 63 commits into from
Jan 29, 2021
Merged

GA api version changes #12483

merged 63 commits into from
Jan 29, 2021

Conversation

sirireddy12
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

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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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, @sirireddy12 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 Jan 19, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 3 Warnings warning [Detail]

    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: clientProxy
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L793
    ⚠️ R4020 - DescriptiveDescriptionRequired The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation.
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L798
    ⚠️ R4021 - DescriptionAndTitleMissing 'ListClusterUserCredentialsProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L774
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 14 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Kubernetes/connectedClusters/{clusterName}/listClusterUserCredentials' removed or restructured?
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L238:5
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConnectedClusterAADProfile' removed or renamed?
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L413:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L416:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuthenticationDetails' removed or renamed?
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L413:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L416:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ConnectedClusterAADProfile' removed or renamed?
    New: Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json#L358:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L416:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AuthenticationDetails' removed or renamed?
    New: Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json#L358:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L416:3
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ClientProxy' removed or renamed?
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L801:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L782:3
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ClientProxy' removed or renamed?
    New: Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json#L659:3
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L782:3
    ⚠️ 1010 - AddingRequiredParameter The required parameter 'Properties' was added in the new version.
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L267:11
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L526:9
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L524:9
    ⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Kubernetes/stable/2021-03-01/connectedClusters.json#L471:9
    Old: Microsoft.Kubernetes/preview/2020-01-01-preview/connectedClusters.json#L524:9
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 19, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 84ff253. 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-01-29 04:55:17 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-hybridkubernetes"
      cmderr	[generate.py] 2021-01-29 04:55:17 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-29 04:55:17 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --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/hybridkubernetes/azure-resourcemanager-hybridkubernetes --java.namespace=com.azure.resourcemanager.hybridkubernetes   --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/hybridkubernetes/resource-manager/readme.md
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [POM][Skip] pom already has module azure-resourcemanager-hybridkubernetes
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-29 04:55:58 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
      cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
      cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
      cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
      cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-hybridkubernetes [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Got artifact_id: azure-resourcemanager-hybridkubernetes
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG Match jar package: azure-resourcemanager-hybridkubernetes-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-01-29 04:58:50 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12483/azure-sdk-for-java/azure-resourcemanager-hybridkubernetes/azure-resourcemanager-hybridkubernetes-1.0.0-beta.1.jar\" -o azure-resourcemanager-hybridkubernetes-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-hybridkubernetes -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-hybridkubernetes-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 84ff253. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/hybridkubernetes/resource-manager/readme.md
    • ️✔️hybridkubernetes [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 84ff253. 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/hybridkubernetes/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
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 84ff253. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
      cmderr	[automation_init.sh]   Failed building wheel for yarl
      cmderr	[automation_init.sh]   Failed building wheel for wrapt
      cmderr	[automation_init.sh]   Failed building wheel for multidict
      cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
      cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-hybridkubernetes [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model CredentialResults has a new parameter hybrid_connection_config
      info	[Changelog]   - Model ConnectedCluster has a new parameter infrastructure
      info	[Changelog]   - Model ConnectedCluster has a new parameter connectivity_status
      info	[Changelog]   - Model ConnectedCluster has a new parameter distribution
      info	[Changelog]   - Model ConnectedCluster has a new parameter offering
      info	[Changelog]   - Model ConnectedCluster has a new parameter managed_identity_certificate_expiration_time
      info	[Changelog]   - Model ConnectedCluster has a new parameter last_connectivity_time
      info	[Changelog]   - Model ConnectedCluster has a new parameter total_core_count
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation ConnectedClusterOperations.list_cluster_user_credentials has a new signature
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 84ff253. 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
    • ️✔️preview/hybridkubernetes/mgmt/2020-01-01-preview/hybridkubernetes [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @sirireddy12, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 27, 2021
    @ArcturusZhang ArcturusZhang merged commit 84ff253 into master Jan 29, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * GA api version changes
    
    * removing listcluster from GA
    
    * Add example references
    
    * prettier fix
    
    * Adding to readme
    
    * adding examples
    
    * adding examples
    
    * removing listcluster dependent models from GA
    
    * adding system data
    
    * adding system data
    
    * workaround for c# sdk bug
    
    * workaround for c# sdk bug
    
    * Resolving PR comments
    
    * Resolving PR comments
    
    * prettier fix
    
    * directory change
    
    * directory change
    
    * addressing ARM requested changes
    
    * addressing ARM requested changes
    
    * Moving client proxy and tokenauth to body
    
    * Moving client proxy and tokenauth to body
    
    * prettier check
    
    * prettier check
    
    * body fix
    
    * body fix
    
    * fix
    
    * fix
    
    * NIT
    
    * nit fix
    
    * examples fix
    
    * setting default identity to systemassigned
    
    Co-authored-by: sikasire <sikasire@microsoft.com>
    @JackTn JackTn deleted the GA branch August 9, 2021 09:54
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants