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

added clientId to byos api response schema #12944

Merged
merged 4 commits into from
Mar 7, 2021

Conversation

tonykslee
Copy link
Contributor

@tonykslee tonykslee commented Feb 10, 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?
    • 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 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, @tonykslee 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 Feb 10, 2021

    Swagger Validation Report

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

    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[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: 6 Errors, 92 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined => "#/components/schemas/schemas:346" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined => "description":"The client ID of resource.",
    "readOnly":true,
    "$ref":"#/components/schemas/schemas:349" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Error: Plugin prechecker reported failure."
    PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined => "#/components/schemas/schemas:346" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined => "description":"The client ID of resource.",
    "readOnly":true,
    "$ref":"#/components/schemas/schemas:349" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'AnnotationsListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ApplicationInsightsComponentAPIKeyListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ComponentsResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ComponentsResource-tags' 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 Feb 10, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f793064. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
    • ️✔️@azure/arm-appinsights [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/applicationInsightsManagementClient.js → ./dist/arm-appinsights.js...
      cmderr	[npmPack] created ./dist/arm-appinsights.js in 230ms
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f793064. 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-07 23:55:29 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-applicationinsights"
      cmderr	[generate.py] 2021-03-07 23:55:29 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-03-07 23:55:29 INFO autorest --version=3.0.6369 --use=@autorest/java@4.0.17 --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/applicationinsights/azure-resourcemanager-applicationinsights --java.namespace=com.azure.resourcemanager.applicationinsights   --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/applicationinsights/resource-manager/readme.md
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-07 23:56:06 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-applicationinsights [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-07 23:59:19 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12944/azure-sdk-for-java/azure-resourcemanager-applicationinsights/azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar\" -o azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-applicationinsights -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️❌ azure-sdk-for-python failed [Detail]
    • Failed [Logs]Release - Generate from f793064. 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]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!Error happened during package
      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-python-track2 warning [Detail]
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f793064. 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/applicationinsights/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.ApplicationInsights [View full logs]  [Release SDK Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f793064. 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.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/applicationinsights/resource-manager/readme.md
    • ️✔️applicationinsights [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN
      cmderr	[resource-manager] Using request for node-pre-gyp https download
      cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
      cmderr	[resource-manager] WARN 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-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f793064. 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
    • ️✔️appinsights/mgmt/2015-05-01/insights [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details.

    @allenjzhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @tonykslee
    Copy link
    Contributor Author

    not sure why the validations are failing for python stuff when i didn't touch it. can someone else merge this please?

    @allenjzhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @openapi-workflow-bot
    Copy link

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

    @openapi-workflow-bot
    Copy link

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

    @tonykslee
    Copy link
    Contributor Author

    @allenjzhang Can you please help me understand what is causing the SDK Track 2 Validation error?

    Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined

    Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined

    @tonykslee tonykslee requested a review from allenjzhang March 2, 2021 07:35
    @jianyexi
    Copy link
    Contributor

    jianyexi commented Mar 5, 2021

    @allenjzhang Allen Zhang (DEVDIV) FTE Can you please help me understand what is causing the SDK Track 2 Validation error?

    Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined

    Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined

    As these error are existing errors, not introduced by this PR, I think you can ignore them .Also fixing these issue may bring breaking change.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants