Release botservice microsoft.bot service 2022 09 15#20803
Closed
thatChang wants to merge 12 commits into
Closed
Conversation
…-06-15-preview to version 2022-09-15
|
Hi, @thatChang Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
openapi-workflow-bot
Bot
added
FixS360
ARMReview
WaitForARMFeedback
|
Hi, @thatChang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| botservice.json | 2021-05-01-preview(c0b556f) | 2021-05-01-preview(main) |
| privatelinks.json | 2021-05-01-preview(c0b556f) | 2021-05-01-preview(main) |
| botservice.json | 2022-06-15-preview(c0b556f) | 2022-06-15-preview(main) |
| privatelinks.json | 2022-06-15-preview(c0b556f) | 2022-06-15-preview(main) |
| botservice.json | 2021-03-01(c0b556f) | 2021-03-01(main) |
Only 17 items are listed, please refer to log for more details.
️❌Breaking Change(Cross-Version): 19 Errors, 20 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| botservice.json | 2022-09-15(c0b556f) | 2021-03-01(main) |
| botservice.json | 2022-09-15(c0b556f) | 2022-06-15-preview(main) |
| privatelinks.json | 2022-09-15(c0b556f) | 2022-06-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 17 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 20 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(c0b556f) | package-preview-2022-06(main) |
| package-preview-2021-05 | package-preview-2021-05(c0b556f) | package-preview-2021-05(main) |
| package-2021-03-01 | package-2021-03-01(c0b556f) | package-2021-03-01(main) |
| package-2022-09 | package-2022-09(c0b556f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 17 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L31 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1864 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2630 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2673 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2817 |
||
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L31 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L1986 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2752 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2795 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2939 |
||
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L31 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L1591 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2366 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2409 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2553 |
||
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/stable/2022-09-15/botservice.json#L31 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2022-09-15/botservice.json#L1986 |
The following errors/warnings exist before current PR submission:
Only 17 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L304 |
|
The 'channelName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L335 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L556 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L646 |
|
The response schema of operations API '/providers/Microsoft.BotService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L765 |
|
Tracked resource 'ConnectionSetting' must have patch operation that at least supports the update of tags. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L818 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The get operation should only return 200. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1178 |
|
A 202 response should include an Location response header. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1178 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @thatChang, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
NewApiVersionRequired reason: |
AzureRestAPISpecReview
added
the
ReadyForApiTest
|
Hi @thatChang, 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. |
|
Hi, @thatChang. 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 |
ghost
added
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi, @thatChang, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
added 5 commits
December 20, 2022 06:31
…into release-botservice-Microsoft.BotService-2022-09-15
jianyexi
reviewed
Dec 23, 2022
| "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices", | ||
| "location": "global", | ||
| "etag": "etag1", | ||
| "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection", |
Contributor
There was a problem hiding this comment.
this id is duplicated with line 57
Member
|
@thatChang - Couple of things:
|
Member
|
I've re-reviewed the breaking changes report and while there appear to be a few new issues reported these all appear to be benign. |
openapi-workflow-bot
Bot
added
the
WaitForARMFeedback
Member
|
@thatChang - I didn't see any response to my comments: #20803 (comment). Note, at minimum before your new API can be reviewed by ARM you will need to provide a PR that has the correct base commit for the new API being added. |
openapi-workflow-bot
Bot
removed
the
WaitForARMFeedback
Contributor
Author
|
@mentat9 I have a new PR #22077 with the base required. |
Member
Thank-you @thatChang - I will follow up on that PR. |
11 tasks
Member
|
@thatChang - Please close this PR if it's no longer needed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Sep/2022
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[X] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.