-
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
botservice
: fixing an inconsistency with the URI Segments
#27351
base: main
Are you sure you want to change the base?
botservice
: fixing an inconsistency with the URI Segments
#27351
Conversation
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
The URI Segment `channelName` is defined as a Constant for some HTTP Methods and a String value for others - this makes this consistent.
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
botservice.json | 2021-05-01-preview(d7bde14) | 2021-05-01-preview(main) |
botservice.json | 2022-06-15-preview(d7bde14) | 2022-06-15-preview(main) |
botservice.json | 2023-09-15-preview(d7bde14) | 2023-09-15-preview(main) |
botservice.json | 2020-06-02(d7bde14) | 2020-06-02(main) |
botservice.json | 2021-03-01(d7bde14) | 2021-03-01(main) |
botservice.json | 2022-09-15(d7bde14) | 2022-09-15(main) |
Only 28 items are listed, please refer to log for more details.
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 10 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) | new version | base version |
---|---|---|
package-preview-2023-09 | package-preview-2023-09(d7bde14) | package-preview-2023-09(main) |
package-2022-09 | package-2022-09(d7bde14) | package-2022-09(main) |
package-preview-2022-06 | package-preview-2022-06(d7bde14) | package-preview-2022-06(main) |
package-preview-2021-05 | package-preview-2021-05(d7bde14) | package-preview-2021-05(main) |
package-2021-03-01 | package-2021-03-01(d7bde14) | package-2021-03-01(main) |
package-2020-06-02 | package-2020-06-02(d7bde14) | package-2020-06-02(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2023-09-15-preview/botservice.json'. Errors encountered: TypeError: Cannot read property 'additionalProperties' of null Location: azure-rest-api-specs/blob/d7bde14390faee008eb0cd2626350c19cd492180/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json'. Errors encountered: TypeError: Cannot read property 'additionalProperties' of null Location: azure-rest-api-specs/blob/d7bde14390faee008eb0cd2626350c19cd492180/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2022-06-15-preview/botservice.json'. Errors encountered: TypeError: Cannot read property 'additionalProperties' of null Location: azure-rest-api-specs/blob/d7bde14390faee008eb0cd2626350c19cd492180/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json'. Errors encountered: TypeError: Cannot read property 'additionalProperties' of null Location: azure-rest-api-specs/blob/d7bde14390faee008eb0cd2626350c19cd492180/#L1 |
|
FATAL |
spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json'. Errors encountered: TypeError: Cannot read property 'additionalProperties' of null Location: azure-rest-api-specs/blob/d7bde14390faee008eb0cd2626350c19cd492180/#L1 |
|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2059 |
|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2173 |
|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2329 |
|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L1778 |
|
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.BotService/stable/2022-09-15/botservice.json#L2173 |
The following errors/warnings exist before current PR submission:
Only 28 items are listed, please refer to log for more details.
Rule | Message |
---|---|
MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1412 |
MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1465 |
MissingTypeObject |
The schema 'BotProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1536 |
MissingTypeObject |
The schema 'BotResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1749 |
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/2021-05-01-preview/botservice.json#L1797 |
MissingTypeObject |
The schema 'AlexaChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1914 |
MissingTypeObject |
The schema 'FacebookChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1957 |
MissingTypeObject |
The schema 'FacebookPage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1997 |
MissingTypeObject |
The schema 'EmailChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2030 |
MissingTypeObject |
The schema 'MsTeamsChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2109 |
MissingTypeObject |
The schema 'SkypeChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2161 |
MissingTypeObject |
The schema 'KikChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2226 |
MissingTypeObject |
The schema 'WebChatChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2267 |
MissingTypeObject |
The schema 'DirectLineChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2303 |
MissingTypeObject |
The schema 'TelegramChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2345 |
MissingTypeObject |
The schema 'SmsChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2382 |
MissingTypeObject |
The schema 'SlackChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2429 |
MissingTypeObject |
The schema 'LineChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2504 |
MissingTypeObject |
The schema 'LineRegistration' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2529 |
MissingTypeObject |
The schema 'DirectLineSpeechChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2568 |
MissingTypeObject |
The schema 'ChannelResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2704 |
MissingTypeObject |
The schema 'ConnectionItemName' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2977 |
MissingTypeObject |
The schema 'ConnectionSettingParameter' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2987 |
MissingTypeObject |
The schema 'ConnectionSettingProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L3001 |
AllTrackedResourcesMustHaveDelete |
The resource ConnectionSetting does not have a corresponding delete operation. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L3052 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'ConnectionSetting'. Properties [properties.name] conflict with ARM top level properties. Please rename these. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L3052 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'ConnectionSetting'. Properties [properties.id] conflict with ARM top level properties. Please rename these. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L3052 |
TrackedResourcePatchOperation |
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#L3052 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 15 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌
SpellCheck: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1520:24 |
HowToFix |
Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1530:26 |
HowToFix |
Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1576:26 |
HowToFix |
Unknown word (networksecurityperimeter), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L1612:24 |
️️✔️
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]
Swagger Generation Artifacts
|
Generated ApiView
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
Please address or respond to feedback from the ARM API reviewer. |
…9-15 `tools/importer-rest-api-specs`: adding a data workaround for `Azure/azure-rest-api-specs#27351` / importing `BotService` @ `2022-09-15`
… than a float `type: number` without a format means float whereas `type: integer` means integer. Since an integer is defined in the possible values, this should be marked as an integer.
…re-rest-api-specs#27351 to account for the constant being incorrectly defined This should be explicitly defined as an integer, since `number` means float.
…re-rest-api-specs#27351 to account for the constant being incorrectly defined This should be explicitly defined as an integer, since `number` means float.
…ound tools/importer-rest-api-specs: extending the workaround for Azure/azure-rest-api-specs#27351 to account for the constant being incorrectly defined
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.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReview
label.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
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] 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!
2021-05-01-preview
,2022-06-15-preview
,2023-09-15-preview
,2020-06-02
,2021-03-01
and2022-09-15
.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 the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
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
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.