Skip to content

Conversation

@safeermohammed
Copy link

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 - fixing identity property indent/scope
  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.
    This is preview API already in production. Issue only with swagger

  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    Swagger was merged on 2/28. No CLI 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 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, @safeermohammed 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 3, 2021

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'identity' renamed or removed?
    New: Microsoft.KubernetesConfiguration/preview/2020-07-01-preview/extensions.json#L552:11
    Old: Microsoft.KubernetesConfiguration/preview/2020-07-01-preview/extensions.json#L552:11
    1041 - AddedPropertyInResponse The new version has a new property 'identity' in response that was not found in the old version.
    New: Microsoft.KubernetesConfiguration/preview/2020-07-01-preview/extensions.json#L547:7
    Old: Microsoft.KubernetesConfiguration/preview/2020-07-01-preview/extensions.json#L547:7
    ️️✔️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.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[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.
    ️⚠️[Staging] SDK Track2 Validation: 16 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'Result' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ErrorDefinition' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ConfigurationProtectedSettings' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'SourceControlConfiguration' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'SourceControlConfigurationList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ResourceProviderOperation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ResourceProviderOperation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ResourceProviderOperationList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"kubernetesconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ConfigurationSettings' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 3, 2021

    Swagger Generation Artifacts

    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b43b1a6fc12fc91efa4e07d9b818ac4f3c138a43. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6374 --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/kubernetesconfiguration/resource-manager/readme.md
    • ️✔️kubernetesconfiguration [View full logs]  [Preview Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN [email protected] No repository field.
      cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b43b1a6fc12fc91efa4e07d9b818ac4f3c138a43. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/kubernetesconfiguration/resource-manager/readme.md
    • ️✔️@azure/arm-kubernetesconfiguration [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/sourceControlConfigurationClient.js → ./dist/arm-kubernetesconfiguration.js...
      cmderr	[npmPack] created ./dist/arm-kubernetesconfiguration.js in 174ms
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b43b1a6fc12fc91efa4e07d9b818ac4f3c138a43. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.SourceControlConfiguration [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from b43b1a6fc12fc91efa4e07d9b818ac4f3c138a43. 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-03-05 00:11:31 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-kubernetesconfiguration"
      cmderr	[generate.py] 2021-03-05 00:11:31 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-03-05 00:11:31 INFO autorest --version=3.0.6369 --use=@autorest/[email protected] --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/kubernetesconfiguration/azure-resourcemanager-kubernetesconfiguration --java.namespace=com.azure.resourcemanager.kubernetesconfiguration   --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/kubernetesconfiguration/resource-manager/readme.md
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [POM][Skip] pom already has module azure-resourcemanager-kubernetesconfiguration
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-05 00:12:04 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2021-03-05 00:13:33 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-kubernetesconfiguration [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-03-05 00:14:40 DEBUG Got artifact_id: azure-resourcemanager-kubernetesconfiguration
      cmderr	[Inst] 2021-03-05 00:14:40 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-05 00:14:40 DEBUG Got artifact: azure-resourcemanager-kubernetesconfiguration-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-05 00:14:40 DEBUG Match jar package: azure-resourcemanager-kubernetesconfiguration-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-05 00:14:40 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13264/azure-sdk-for-java/azure-resourcemanager-kubernetesconfiguration/azure-resourcemanager-kubernetesconfiguration-1.0.0-beta.1.jar\" -o azure-resourcemanager-kubernetesconfiguration-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-kubernetesconfiguration -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-kubernetesconfiguration-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b43b1a6fc12fc91efa4e07d9b818ac4f3c138a43. 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
    • ️✔️kubernetesconfiguration/mgmt/2021-03-01/kubernetesconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/kubernetesconfiguration/mgmt/2020-07-01-preview/kubernetesconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/kubernetesconfiguration/mgmt/2019-11-01-preview/kubernetesconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

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

    @safeermohammed
    Copy link
    Author

    safeermohammed commented Mar 4, 2021

    Note to reviewers, Preview API, Identity property was incorrectly specified inside resource properties bag in swagger.
    Service already returns the property property. Fixing swagger bug.

    CLI/SDK etc are not generated yet for this resource

    @safeermohammed safeermohammed added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed BreakingChangeReviewRequired labels Mar 4, 2021
    @safeermohammed safeermohammed force-pushed the identitypropertybugfix branch from 860f137 to 499a657 Compare March 4, 2021 23:57
    @safeermohammed safeermohammed removed BreakingChangeReviewRequired WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 5, 2021
    @safeermohammed safeermohammed added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 5, 2021
    @filizt filizt self-requested a review March 10, 2021 21:15
    Copy link
    Contributor

    @filizt filizt left a comment

    Choose a reason for hiding this comment

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

    LGTM. However you still need to go through the breaking changes review process which is not part of the ARM API review. Please see above for the instructions for that.

    @ghost
    Copy link

    ghost commented Mar 28, 2021

    Hi, @safeermohammed. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Mar 28, 2021
    @ghost ghost closed this Apr 12, 2021
    @ghost
    Copy link

    ghost commented Apr 12, 2021

    Hi, @safeermohammed. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @safeermohammed. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn JackTn deleted the identitypropertybugfix branch July 5, 2022 01:21
    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    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.

    5 participants