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

Healthbot - Update Python.md based on az cli extension doc & Create Java.md file. #12263

Merged
merged 21 commits into from
Jan 7, 2021

Conversation

guy-microsoft
Copy link
Contributor

@guy-microsoft guy-microsoft commented Dec 31, 2020

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. Jan 3rd 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. Today if possible
  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, @guy-microsoft 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 Dec 31, 2020

    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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 31, 2020

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 96ba256. 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-07 06:31:03 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-healthbot"
      cmderr	[generate.py] 2021-01-07 06:31:03 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-01-07 06:31:03 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.8 --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/healthbot/azure-resourcemanager-healthbot --java.namespace=com.azure.resourcemanager.healthbot  --package-version=1.0.0-beta.1 --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/healthbot/resource-manager/readme.md
      cmderr	[generate.py] 2021-01-07 06:31:41 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-01-07 06:31:41 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-01-07 06:31:41 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-01-07 06:31:41 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-01-07 06:31:41 ERROR [POM][Skip] find more than one <modules> in pom
      cmderr	[generate.py] 2021-01-07 06:31:50 ERROR [GENERATE] Maven build fail
    • ️✔️azure-resourcemanager-healthbot [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-01-07 06:32:29 DEBUG Got artifact_id: azure-resourcemanager-healthbot
      cmderr	[Inst] 2021-01-07 06:32:29 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-01-07 06:32:29 ERROR Unmatch any jar in artifacts
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 96ba256. 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/healthbot/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-python-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 96ba256. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --version=3.0.6272 --use=@autorest/python@5.4.3 --python --python-mode=update --multiapi --track2 --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'HealthBotProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ValidationResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Error' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'BotResponseList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (PreNamer/DeduplicateName): Deduplicating schema name: 'Error' -> 'ErrorAutoGenerated'
    • ️✔️track2_azure-mgmt-healthbot [View full logs]  [Release SDK Changes]
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-healthbot
      cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
      cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
      cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-healthbot
      cmderr	[buildPackage] /home/vsts/work/1/s/azure-sdk-for-python_tmp/venv/lib/python3.6/site-packages/setuptools/dist.py:470: UserWarning: The version specified ('2020-10-20-preview') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
      cmderr	[buildPackage]   "details." % version
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[buildPackage] /home/vsts/work/1/s/azure-sdk-for-python_tmp/venv/lib/python3.6/site-packages/setuptools/dist.py:470: UserWarning: The version specified ('2020-10-20-preview') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.
      cmderr	[buildPackage]   "details." % version
      cmderr	[buildPackage] warning: no files found matching '*.py' under directory 'tests'
      cmderr	[buildPackage] warning: no files found matching '*.yaml' under directory 'tests'
      cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
      cmderr	[changelogReport] INFO:__main__:Building code report of azure-mgmt-healthbot for version None in default folder (False/False/False)
      cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.healthbot
      cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.healthbot
      cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.healthbot
      cmderr	[changelogReport] INFO:__main__:Report written to sdk/healthbot/azure-mgmt-healthbot/code_reports/latest/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Building code report of azure-mgmt-healthbot for version None in default folder (False/False/True)
      cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-healthbot on PyPI
      cmderr	[changelogReportLatest] INFO:__main__:Got ['1.0.0b1']
      cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
      cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0b1 of azure-mgmt-healthbot in a venv
      cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
      cmderr	[changelogReportLatest] INFO:__main__:Building code report of azure-mgmt-healthbot for version 1.0.0b1 in default folder (True/False/False)
      cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.healthbot
      cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.healthbot
      cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.healthbot
      cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/healthbot/azure-mgmt-healthbot/code_reports/1.0.0b1/report.json
      cmderr	[changelogReportLatest] INFO:__main__:Writing metadata: {'reports': ['sdk/healthbot/azure-mgmt-healthbot/code_reports/1.0.0b1/report.json']}
      cmdout	[Changelog] Size of delta 0.025% size of original (original: 7875 chars, delta: 2 chars)
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 96ba256. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'HealthBotProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ValidationResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Error' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'BotResponseList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (PreNamer/DeduplicateName): Deduplicating schema name: 'error' -> 'errorAutoGenerated'
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /Bots/put/BotCreate
      cmderr	[Autorest]     - name: /Bots/get/List Bots by Resource Group
      cmderr	[Autorest]     - name: /Bots/get/List Bots by Subscription
      cmderr	[Autorest]     - name: /Bots/get/ResourceInfoGet
      cmderr	[Autorest]     - name: /Bots/patch/BotUpdate
      cmderr	[Autorest]     - name: /Bots/delete/BotDelete
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest] /bin/sh: 1: cd: can't cd to home/vsts/work/1/s/azure-rest-api-specs
      cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
      cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
    • ️✔️healthbot [View full logs]  [Release Azure CLI Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 96ba256. 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
    • ️✔️healthbot/mgmt/2020-12-08/healthbot [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @guy-microsoft
    Copy link
    Contributor Author

    guy-microsoft commented Dec 31, 2020

    1. Created a Java.ms file based on this comment.
    2. Updated Python.md based on az cli extension documentation.

    @lirenhe Ready for review.

    @qiaozha
    Copy link
    Member

    qiaozha commented Jan 3, 2021

    @ChenTanyi Does the readme.java.md look good to you ?

    @qiaozha
    Copy link
    Member

    qiaozha commented Jan 3, 2021

    @guy-microsoft Hi, Considering healthbot is a new service. I think it's better to add the python track2 configuration as well. You can change the readme.python.md following the sample here https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/documentation/samplefiles/readme.python.md

    @guy-microsoft
    Copy link
    Contributor Author

    Thanks @qiaozha, added.

    guy-microsoft and others added 3 commits January 3, 2021 16:49
    Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
    Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com>
    Copy link
    Contributor

    @ChenTanyi ChenTanyi left a comment

    Choose a reason for hiding this comment

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

    Java readme is OK

    @xseeseesee
    Copy link
    Contributor

    @guy-microsoft You might want to add title like this. According to autorest generic-extensions, the setting of x-ms-code-generation-settings is already deprecated.

    @guy-microsoft
    Copy link
    Contributor Author

    guy-microsoft commented Jan 5, 2021

    According to @00Kai0, only track2 is needed for new services python SDK, so I'm reverting the changes for python.md file. Only changes to java.md remain, which were approved.

    @ChenTanyi
    Copy link
    Contributor

    @guy-microsoft As @xccc-msft said, you might need to add title in java.md. Otherwise, the generation will fail.

    @guy-microsoft
    Copy link
    Contributor Author

    @ChenTanyi When you say "title in java.md", what do you mean?
    I looked at @xccc-msft comment now and it talks about readme.md file..

    @guy-microsoft
    Copy link
    Contributor Author

    @ChenTanyi Ok, but I'm still not sure what I should add to the readme.md file? Something like that?
    image

    @ChenTanyi
    Copy link
    Contributor

    @guy-microsoft yes, you need to add a Java section in the readme.md

    @guy-microsoft
    Copy link
    Contributor Author

    @ChenTanyi Thanks for clarifying, I added the Java section. Please let me know it's fine.

    @ChenTanyi
    Copy link
    Contributor

    @guy-microsoft You still didn't add title

    @guy-microsoft
    Copy link
    Contributor Author

    guy-microsoft commented Jan 6, 2021

    @lirenhe, this PR is ready for approval and merge. Thanks.

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

    Successfully merging this pull request may close these issues.

    5 participants