Skip to content

[ACS][Communication][Chat] Added New API for Image Upload#25697

Closed
jpeng-ms wants to merge 13 commits intomainfrom
jpeng-ms-communication-Chat-2023-12-01-preview
Closed

[ACS][Communication][Chat] Added New API for Image Upload#25697
jpeng-ms wants to merge 13 commits intomainfrom
jpeng-ms-communication-Chat-2023-12-01-preview

Conversation

@jpeng-ms
Copy link
Member

@jpeng-ms jpeng-ms commented Sep 6, 2023

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 6, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR requires an API stewardship board review. See the PR description for help.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 6, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 6 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
communicationserviceschat.json 2023-12-01-preview(75e9c45) 2021-09-07(main)
communicationserviceschat.json 2023-12-01-preview(75e9c45) 2023-07-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1516:9
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1398:9
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'teamsInlineImage, teamsImage' from the old version.
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1513:9
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1395:9
⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'teamsInlineImage, teamsImage' from the old version.
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1487:5
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1368:5
⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1507:7
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1389:7
⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1513:9
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1395:9
⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'modelAsString' than the previous one.
New: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1487:5
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1368:5
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 10 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.5) new version base version
package-preview-2023-12 package-preview-2023-12(75e9c45) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L30
⚠️ DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L50
⚠️ Post201Response Using post for a create operation is discouraged.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L51
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L57
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L64
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L71
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L78
⚠️ PatchContentType A post operation should not consume 'application/merge-patch+json' content type.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1216
⚠️ RequestBodyOptional The body parameter is not marked as required.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1234
⚠️ SchemaNamesConvention Schema name should be Pascal case.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1482


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L865
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L942
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'ChatThread' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1018
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'ChatThread' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1090
OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Chat' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1153
HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L1942
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L104
⚠️ DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L129
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L136
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L143
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L150
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L157
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L188
⚠️ DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L208
⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L209
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L212
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L219
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L226
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L233
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L262
⚠️ DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L282
⚠️ Post201Response Using post for a create operation is discouraged.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L283
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L289
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L296
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L303
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L310
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L334
⚠️ DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L359
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L366
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-12-01-preview/communicationserviceschat.json#L373
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 6, 2023

Swagger Generation Artifacts

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

Breaking Changes Tracking

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Sep 6, 2023

Generated ApiView

Language Package Name ApiView Link
Swagger communication-data-plane-Chat https://apiview.dev/Assemblies/Review/29df7b3c301a403886289190650125fc

Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I flagged a couple minor problems. The examples one needs to be fixed to clear the CI errors.

Copy link
Member

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Azure Communications Gateway - Azure Communications Gateway] API Review

4 participants