Healthbot - update preview api #11981

guy-microsoft · 2020-12-07T11:31:09Z

Add support for async operations for DELETE and PATCH.

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.

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
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. December 2020
When you expect to publish swagger? Please provide date, or month to public if date is not available yet. December 2020
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:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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.

2. Add support for async operations for DELETE and PATCH.

openapi-pipeline-app · 2020-12-07T11:31:14Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.1)
- original: preview/2020-10-20-preview/healthbot.json <---> new: preview/2020-10-20-preview/healthbot.json

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '201'. New: Microsoft.HealthBot/preview/2020-10-20-preview/healthbot.json#L214:11
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.HealthBot/preview/2020-10-20-preview/healthbot.json#L254:11

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- healthbot/resource-manager/readme.md tag:package-2020-10-20-preview
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- healthbot/resource-manager/readme.md tag:package-2020-10-20-preview

️️✔️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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2020-12-07T11:31:14Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌ azure-sdk-for-java failed [Detail]

❌Failed [Logs] Generate from 26f5fca29ed6ef0b36f460ec62f70c99d6d23f4d. 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] 2020-12-07 12:45:02 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-healthbot"
cmderr	[generate.py] 2020-12-07 12:45:02 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2020-12-07 12:45:02 INFO autorest --version=3.0.6327 --use=@autorest/java@4.0.5 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/w/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/w/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 --pipeline.modelerfour.flatten-payloads=false --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] 2020-12-07 12:45:36 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2020-12-07 12:45:36 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2020-12-07 12:45:36 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2020-12-07 12:45:36 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2020-12-07 12:45:36 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
ENOTDIR: not a directory, scandir 'azure-sdk-for-java/pom.xml'
Error: ENOTDIR: not a directory, scandir 'azure-sdk-for-java/pom.xml'

️✔️azure-resourcemanager-healthbot [View full logs]

error	Fatal error: ENOTDIR: not a directory, scandir 'azure-sdk-for-java/pom.xml'
error	The following packages are still pending:
error		azure-resourcemanager-healthbot

️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 26f5fca29ed6ef0b36f460ec62f70c99d6d23f4d. 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=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/w/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
warn	No package detected after generation

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs] Generate from 26f5fca29ed6ef0b36f460ec62f70c99d6d23f4d. 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/w/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

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2020-12-07T12:22:20Z

Hi @guy-microsoft, 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 think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

guy-microsoft · 2020-12-07T15:21:21Z

The resource type is not yet used in Prod, so no external customers use it.

Business justification for breaking change:
The PR consists of 2 changes:

Support async DELETE and PATCH (in order to meet the KPI requirements).
Added a new tier, "C0", per product team request.

openapi-workflow-bot · 2020-12-07T15:26:34Z

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.

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

raych1 · 2020-12-08T01:10:20Z

Hi @guy-microsoft, 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 think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

@guy-microsoft , again please follow the action in above comment for the breaking change review process.

guy-microsoft · 2020-12-08T12:22:57Z

@raych1 In case my breaking change is not due to compliance/security, would it be better (and faster to review) to create a new api-version instead?
I created a PR with a new api version: #12006 that can replace this breaking change PR.

raych1 · 2020-12-09T09:02:54Z

@raych1 In case my breaking change is not due to compliance/security, would it be better (and faster to review) to create a new api-version instead?
I created a PR with a new api version: #12006 that can replace this breaking change PR.

@guy-microsoft , for the change of adding response code, it is still breaking change even in new api version. So, the breaking change review process is the same.

guy-microsoft · 2020-12-15T07:00:35Z

Closing, replaced by this PR:
#12006

openapi-workflow-bot · 2021-07-15T03:09:45Z

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

1. Add C0 tier.

bc09dd8

2. Add support for async operations for DELETE and PATCH.

openapi-assignment-bot bot assigned raych1 Dec 7, 2020

guy-microsoft added 2 commits December 7, 2020 13:34

Fix.

01a3e8b

Fix.

725ebf5

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Dec 7, 2020

Run prettier.

8701e09

guy-microsoft added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Dec 7, 2020

guy-microsoft mentioned this pull request Dec 7, 2020

Azure HealthBot - New tier and async support for DELETE and PATCH #11967

Closed

25 tasks

guy-microsoft removed the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Dec 7, 2020

guy-microsoft closed this Dec 15, 2020

zhenglaizhang removed the BreakingChangeReviewRequired label Jul 15, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jul 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Healthbot - update preview api #11981

Healthbot - update preview api #11981

guy-microsoft commented Dec 7, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2020 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Dec 7, 2020

guy-microsoft commented Dec 7, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 7, 2020

raych1 commented Dec 8, 2020

guy-microsoft commented Dec 8, 2020 •

edited

Loading

raych1 commented Dec 9, 2020

guy-microsoft commented Dec 15, 2020

openapi-workflow-bot bot commented Jul 15, 2021

Healthbot - update preview api #11981

Healthbot - update preview api #11981

Conversation

guy-microsoft commented Dec 7, 2020 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 7, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 7, 2020 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Dec 7, 2020

guy-microsoft commented Dec 7, 2020 • edited Loading

openapi-workflow-bot bot commented Dec 7, 2020

raych1 commented Dec 8, 2020

guy-microsoft commented Dec 8, 2020 • edited Loading

raych1 commented Dec 9, 2020

guy-microsoft commented Dec 15, 2020

openapi-workflow-bot bot commented Jul 15, 2021

guy-microsoft commented Dec 7, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 7, 2020 •

edited

Loading

guy-microsoft commented Dec 7, 2020 •

edited

Loading

guy-microsoft commented Dec 8, 2020 •

edited

Loading