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

botservice: fixing an inconsistency with the URI Segments #27351

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

tombuildsstuff
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

Tip: overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

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:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    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)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.
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!

  • New API version. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • These URI Segments are inconsistent and should be made consistent, since this is the same URI with a different HTTP Method - therefore these should support the same values (and therefore the same constant)
    • Fixing this for API Versions 2021-05-01-preview, 2022-06-15-preview, 2023-09-15-preview, 2020-06-02, 2021-03-01 and 2022-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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    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

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the 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.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in 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.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

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.
Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes (label: BreakingChangeReviewRequired). See the PR description for help.
  • ❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Swagger Validation Report

️❌BreakingChange: 34 Errors, 0 Warnings failed [Detail]
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.

Rule Message
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2036:9
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2050:9
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2059:5
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2073:5
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2150:9
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2164:9
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2173:5
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2187:5
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2306:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2320:9
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2329:5
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L2343:5
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/stable/2021-03-01/botservice.json#L1755:9
Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L1769:9
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/stable/2021-03-01/botservice.json#L1778:5
Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L1792:5
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/stable/2022-09-15/botservice.json#L2150:9
Old: Microsoft.BotService/stable/2022-09-15/botservice.json#L2164:9
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'number'.
New: Microsoft.BotService/stable/2022-09-15/botservice.json#L2173:5
Old: Microsoft.BotService/stable/2022-09-15/botservice.json#L2187:5
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L464:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L523:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L464:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L523:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L464:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L523:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2020-06-02/botservice.json#L454:9
Old: Microsoft.BotService/stable/2020-06-02/botservice.json#L461:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2020-06-02/botservice.json#L506:9
Old: Microsoft.BotService/stable/2020-06-02/botservice.json#L520:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2021-03-01/botservice.json#L457:9
Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L464:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2021-03-01/botservice.json#L509:9
Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L523:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2022-09-15/botservice.json#L457:9
Old: Microsoft.BotService/stable/2022-09-15/botservice.json#L464:11
1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.BotService/stable/2022-09-15/botservice.json#L509:9
Old: Microsoft.BotService/stable/2022-09-15/botservice.json#L523:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L464:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L523:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L464:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L523:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L457:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L464:11
1048 - AddedXmsEnum The new version adds a x-ms-enum extension.
New: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L509:9
Old: Microsoft.BotService/preview/2023-09-15-preview/botservice.json#L523:11
️️✔️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]
Rule Message
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutChannel.json#L22:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutChannel.json#L35:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutAlexaChannel.json#L21:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutAlexaChannel.json#L35:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutLineChannel.json#L25:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutLineChannel.json#L44:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutDirectLineSpeechChannel.json#L21:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/PutDirectLineSpeechChannel.json#L33:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/GetChannel.json#L11:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/GetAlexaChannel.json#L11:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/GetLineChannel.json#L11:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/GetDirectLineSpeechChannel.json#L11:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/ListChannelsByBotService.json#L12:11
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L1306:19
ExampleUrl: stable/2020-06-02/examples/ListChannelsByBotService.json#L23:11
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.BotService/stable/2020-06-02/botservice.json#L2164:26
ExampleUrl: stable/2020-06-02/examples/ListConnectionsByBotService.json#L12:11
️️✔️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]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/botservice/armbotservice - 2.0.0-beta.1
+	Function `*ChannelsClient.Delete` parameter(s) have been changed from `(context.Context, string, string, string, *ChannelsClientDeleteOptions)` to `(context.Context, string, string, ChannelName, *ChannelsClientDeleteOptions)`
+	Function `*ChannelsClient.Get` parameter(s) have been changed from `(context.Context, string, string, string, *ChannelsClientGetOptions)` to `(context.Context, string, string, ChannelName, *ChannelsClientGetOptions)`
+	Type alias `EmailChannelAuthMethod` type has been changed from `float32` to `int32`


azure-sdk-for-js - @azure/arm-botservice - 5.0.0-beta.1
+	Operation Channels.delete has a new signature
+	Operation Channels.get has a new signature
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.BotService [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.3 -> 10.3.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.3.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.3.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-botservice [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group NetworkSecurityPerimeterConfigurationsOperations
    info	[Changelog]   - Model BotProperties has a new parameter network_security_perimeter_configurations
    info	[Changelog]   - Model ConnectionSettingProperties has a new parameter id
    info	[Changelog]   - Model ConnectionSettingProperties has a new parameter name
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.3 -> 10.3.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.3.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.3.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-botservice [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group NetworkSecurityPerimeterConfigurationsOperations
    info	[Changelog]   - Model BotProperties has a new parameter network_security_perimeter_configurations
    info	[Changelog]   - Model ConnectionSettingProperties has a new parameter id
    info	[Changelog]   - Model ConnectionSettingProperties has a new parameter name
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/botservice/armbotservice [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Type alias `EmailChannelAuthMethod` type has been changed from `float32` to `int32`
    info	[Changelog] - Function `*ChannelsClient.Delete` parameter(s) have been changed from `(context.Context, string, string, string, *ChannelsClientDeleteOptions)` to `(context.Context, string, string, ChannelName, *ChannelsClientDeleteOptions)`
    info	[Changelog] - Function `*ChannelsClient.Get` parameter(s) have been changed from `(context.Context, string, string, string, *ChannelsClientGetOptions)` to `(context.Context, string, string, ChannelName, *ChannelsClientGetOptions)`
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `PublicNetworkAccessSecuredByPerimeter` added to enum type `PublicNetworkAccess`
    info	[Changelog] - New enum type `AccessMode` with values `AccessModeAudit`, `AccessModeEnforced`, `AccessModeLearning`
    info	[Changelog] - New enum type `NspAccessRuleDirection` with values `NspAccessRuleDirectionInbound`, `NspAccessRuleDirectionOutbound`
    info	[Changelog] - New enum type `ProvisioningState` with values `ProvisioningStateAccepted`, `ProvisioningStateCreating`, `ProvisioningStateDeleting`, `ProvisioningStateFailed`, `ProvisioningStateSucceeded`, `ProvisioningStateUpdating`
    info	[Changelog] - New enum type `Severity` with values `SeverityError`, `SeverityWarning`
    info	[Changelog] - New function `*ClientFactory.NewNetworkSecurityPerimeterConfigurationsClient() *NetworkSecurityPerimeterConfigurationsClient`
    info	[Changelog] - New function `NewNetworkSecurityPerimeterConfigurationsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*NetworkSecurityPerimeterConfigurationsClient, error)`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.Get(context.Context, string, string, string, *NetworkSecurityPerimeterConfigurationsClientGetOptions) (NetworkSecurityPerimeterConfigurationsClientGetResponse, error)`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.NewListPager(string, string, *NetworkSecurityPerimeterConfigurationsClientListOptions) *runtime.Pager[NetworkSecurityPerimeterConfigurationsClientListResponse]`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.BeginReconcile(context.Context, string, string, string, *NetworkSecurityPerimeterConfigurationsClientBeginReconcileOptions) (*runtime.Poller[NetworkSecurityPerimeterConfigurationsClientReconcileResponse], error)`
    info	[Changelog] - New struct `ErrorAdditionalInfo`
    info	[Changelog] - New struct `ErrorDetail`
    info	[Changelog] - New struct `ErrorResponse`
    info	[Changelog] - New struct `NetworkSecurityPerimeter`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfiguration`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationList`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationProperties`
    info	[Changelog] - New struct `NspAccessRule`
    info	[Changelog] - New struct `NspAccessRuleProperties`
    info	[Changelog] - New struct `NspAccessRulePropertiesSubscriptionsItem`
    info	[Changelog] - New struct `Profile`
    info	[Changelog] - New struct `ProvisioningIssue`
    info	[Changelog] - New struct `ProvisioningIssueProperties`
    info	[Changelog] - New struct `ResourceAssociation`
    info	[Changelog] - New field `NetworkSecurityPerimeterConfigurations` in struct `BotProperties`
    info	[Changelog] - New field `ID`, `Name` in struct `ConnectionSettingProperties`
    info	[Changelog]
    info	[Changelog] Total 3 breaking change(s), 53 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh]  notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.3 -> 10.3.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.3.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.3.0` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
  • ️✔️botservice [View full logs]  [Preview Schema Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-botservice [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group NetworkSecurityPerimeterConfigurations
    info	[Changelog]   - Added Interface ErrorAdditionalInfo
    info	[Changelog]   - Added Interface ErrorDetail
    info	[Changelog]   - Added Interface ErrorResponse
    info	[Changelog]   - Added Interface NetworkSecurityPerimeter
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfiguration
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationList
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationProperties
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationsGetOptionalParams
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationsListNextOptionalParams
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationsListOptionalParams
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationsReconcileHeaders
    info	[Changelog]   - Added Interface NetworkSecurityPerimeterConfigurationsReconcileOptionalParams
    info	[Changelog]   - Added Interface NspAccessRule
    info	[Changelog]   - Added Interface NspAccessRuleProperties
    info	[Changelog]   - Added Interface NspAccessRulePropertiesSubscriptionsItem
    info	[Changelog]   - Added Interface Profile
    info	[Changelog]   - Added Interface ProvisioningIssue
    info	[Changelog]   - Added Interface ProvisioningIssueProperties
    info	[Changelog]   - Added Interface ResourceAssociation
    info	[Changelog]   - Added Type Alias AccessMode
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsGetResponse
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsListNextResponse
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsListResponse
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsReconcileResponse
    info	[Changelog]   - Added Type Alias NspAccessRuleDirection
    info	[Changelog]   - Added Type Alias ProvisioningState
    info	[Changelog]   - Added Type Alias Severity
    info	[Changelog]   - Interface BotProperties has a new optional parameter networkSecurityPerimeterConfigurations
    info	[Changelog]   - Interface ConnectionSettingProperties has a new optional parameter id
    info	[Changelog]   - Interface ConnectionSettingProperties has a new optional parameter name
    info	[Changelog]   - Added Enum KnownAccessMode
    info	[Changelog]   - Added Enum KnownNspAccessRuleDirection
    info	[Changelog]   - Added Enum KnownProvisioningState
    info	[Changelog]   - Added Enum KnownSeverity
    info	[Changelog]   - Enum KnownPublicNetworkAccess has a new value SecuredByPerimeter
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Operation Channels.delete has a new signature
    info	[Changelog]   - Operation Channels.get has a new signature
    info	[Changelog]   - Class AzureBotService has a new signature
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning [Logs] Generate from ef2302ee87f94b8fbcb5862490b9d612066c60e1. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ⚠️Az.botservice.DefaultTag [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Jan 11, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/botservice/armbotservice Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net Azure.ResourceManager.BotService Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript @azure/arm-botservice Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Swagger Microsoft.BotService Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

@microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 11, 2024
Copy link
Contributor

Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.

Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

tombuildsstuff added a commit to hashicorp/pandora that referenced this pull request Jan 17, 2024
…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.
tombuildsstuff added a commit to hashicorp/pandora that referenced this pull request Jan 17, 2024
…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.
tombuildsstuff added a commit to hashicorp/pandora that referenced this pull request Jan 17, 2024
…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.
tombuildsstuff added a commit to hashicorp/pandora that referenced this pull request Jan 17, 2024
…ound

tools/importer-rest-api-specs: extending the workaround for Azure/azure-rest-api-specs#27351 to account for the constant being incorrectly defined
@wuxu92
Copy link

wuxu92 commented Jan 18, 2024

Hey @rkmanda @sgellock, could you take a look at this PR that addresses the BotService API issue?

@boydc2014
Copy link

Hi @wuxu92 @rkmanda, I can approve this changes from Bot Service POV, this is a good and safe change. Please help proceed this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. FixS360 resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants