-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[Hub Generated] Review request for Microsoft.BotService to add version stable/2022-09-15 #25441
[Hub Generated] Review request for Microsoft.BotService to add version stable/2022-09-15 #25441
Conversation
Next Steps to Merge⌛ Please wait, next steps to merge this PR are being evaluated by automation. ⌛ |
Swagger Validation Report
|
Swagger Generation Artifacts
|
Generated ApiView
|
...source-manager/Microsoft.BotService/preview/2023-09-15-preview/networksecurityperimeter.json
Outdated
Show resolved
Hide resolved
Please address or respond to feedback from the ARM API reviewer. |
You are at step 2. If u have addressed the review comments, pl remove the ARMChangesRequested label as indicated in the PR workflow diagram. Pl request a merge again once u get to step 4 |
The first commit needs to be an exact copy of the previous api version. All new changes should only be added in the subsequent commits. |
...source-manager/Microsoft.BotService/preview/2023-09-15-preview/networksecurityperimeter.json
Show resolved
Hide resolved
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
botservice.json | 2023-09-15-preview(81be8fe) | 2022-09-15(main) |
botservice.json | 2023-09-15-preview(81be8fe) | 2022-06-15-preview(main) |
privatelinks.json | 2023-09-15-preview(81be8fe) | 2022-09-15(main) |
privatelinks.json | 2023-09-15-preview(81be8fe) | 2022-06-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The read only property has changed from 'true' to 'false'. New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2747:9 Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2591:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 10 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-preview-2023-09 | package-preview-2023-09(81be8fe) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PutRequestResponseSchemeArm |
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/2023-09-15-preview/botservice.json#L31 |
PatchResponseCodes |
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L86 |
UnSupportedPatchProperties |
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L104 |
ResourceNameRestriction |
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L304 |
RepeatedPathInfo |
The 'channelName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L335 |
PatchResponseCodes |
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L375 |
UnSupportedPatchProperties |
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L405 |
ResourceNameRestriction |
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L556 |
ResourceNameRestriction |
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L646 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.BotService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L807 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L808 |
PatchResponseCodes |
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1009 |
UnSupportedPatchProperties |
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1030 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1222 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1265 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1265 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1272 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1308 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1325 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1370 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1497 |
MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1660 |
MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1713 |
MissingTypeObject |
The schema 'BotProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1784 |
MissingTypeObject |
The schema 'BotResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2005 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'BotChannel'. Properties [properties.location] conflict with ARM top level properties. Please rename these. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2082 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2111 |
MissingTypeObject |
The schema 'AlexaChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2198 |
MissingTypeObject |
The schema 'FacebookChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2241 |
MissingTypeObject |
The schema 'FacebookPage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2281 |
️❌
Avocado: 6 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /providers/Microsoft.BotService/botServices/checkNameAvailability is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2017-12-01/botservice.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.BotService/botServices/{}/Connections/{}/listWithSecrets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2018-07-12/botservice.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.BotService/botServices/{}/Connections/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2018-07-12/botservice.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /providers/Microsoft.BotService/checkEnterpriseChannelNameAvailability is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2018-07-12/botservice.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.BotService/enterpriseChannels is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2018-07-12/botservice.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.BotService/enterpriseChannels/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/botservice/resource-manager/readme.md json: Microsoft.BotService/preview/2018-07-12/botservice.json |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
/pr RequestMerge |
/azp run |
Azure Pipelines successfully started running 3 pipeline(s). |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
…n stable/2022-09-15 (#25441) * exactly copy * new version * fix validation * fix swagger lint * fix comments * fix comments * fix refer error * fix swagger modal validation * change common-types from v1 to v5 * remove duplicate schema * fix new lint error * fix lint error * fix example * prettier * fix comments
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.