azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Update communicationserviceschat.json

Open LuChen-Microsoft opened this issue 2 years ago • 5 comments

The Data Retention property is not going to be supported in Chat Thread Item.

The data retention feature has not been released or implemented yet. The change is not a breaking change.

LuChen-Microsoft avatar Jul 14 '23 22:07 LuChen-Microsoft

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
communicationserviceschat.json 2023-07-01-preview(4fffdc3) 2023-07-01-preview(main)
Rule Message
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'retentionPolicy' renamed or removed?
New: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1691:7
Old: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1691:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.3) new version base version
package-chat-2023-07-01-preview package-chat-2023-07-01-preview(4fffdc3) package-chat-2023-07-01-preview(main)

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-07-01-preview/communicationserviceschat.json#L781
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-07-01-preview/communicationserviceschat.json#L858
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-07-01-preview/communicationserviceschat.json#L934
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-07-01-preview/communicationserviceschat.json#L1006
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-07-01-preview/communicationserviceschat.json#L1069
HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L1844
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L20
:warning: DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L45
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L52
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L59
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L66
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L73
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L104
:warning: DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L124
:warning: SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L125
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L128
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L135
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L142
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L149
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L178
:warning: DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L198
:warning: Post201Response Using post for a create operation is discouraged.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L199
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L205
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L212
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L219
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L226
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L250
:warning: DefaultResponse Operation is missing a default response.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L275
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L282
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: Chat/preview/2023-07-01-preview/communicationserviceschat.json#L289
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Please ignore, experimental check succeeded [Detail] [Expand]
Validation passes for 'Please ignore, experimental check'.
Posted by Swagger Pipeline | How to fix these errors?

Hi, @LuChen-Microsoft! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • 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.
  • Swagger pipeline restarted successfully, please wait for status update in this comment.

    Generated ApiView

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

    Hi @LuChen-Microsoft! The automation detected breaking changes in this pull request. As a result, it added the BreakingChangeReviewRequired label.

    You cannot proceed with merging this PR until you complete one of the following action items:

    ACTION ITEM ALTERNATIVE A: Fix the breaking change.
    Please consult the documentation provided in the relevant validation failures.

    ACTION ITEM ALTERNATIVE B: Request approval.
    Alternatively, if you cannot fix the breaking changes, then you can request an approval for them. Please follow the process described in the High-level Breaking Change Process doc.

    ACTION ITEM ALTERNATIVE C: Report false positive.
    If you think there are no breaking changes, i.e. the validation should pass yet it fails, then proceed as explained in ACTION ITEM ALTERNATIVE B.
    This applies even if the breaking change tool fails with internal runtime error. In such case a manual breaking change review is necessary.

    @LuChen-Microsoft What is the new planned release date for this unreleased version, if it's far away from 2023-07-01, should we rename the version?

    DominikMe avatar Jul 18 '23 14:07 DominikMe