Communication Chat - Update WIP preview version (2020-11-01-preview3)

[amrElroumy]

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

• Renaming $maxPageSize to maxPageSize
• Referenceing common Error Schema
• Add ChatMessageType property and allow sending RichText Html
• Mark required properties to indicate they are not nullable.
• Expose Message's sequenceId to allow clients to sort message within the same conversation.

Please ensure to add changelog with this PR by answering the following questions.

1. What's the purpose of the update?
   • new service onboarding
   • new API version
   • update existing version for new feature
   • update existing version to fix swagger quality issue in s360
   • Other, please clarify - Incremental update to our work in progress version in preparation for GA
2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
   We're currently in public preview
3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
   • SDK of .NET (need service team to ensure code readiness)
   • SDK of Python
   • SDK of Java
   • SDK of Js
   • SDK of Go
   • PowerShell
   • CLI
   • Terraform
   • No, no need to refresh for updates in this PR

Contribution checklist:

• I commit to follow the Breaking Change Policy of “no breaking changes
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

• Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

  • Adding new API(s)
  • Adding a new API version
  • Adding a new service

• Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

• Removing API(s) in stable version
• Removing properties in stable version
• Removing API version(s) in stable version
• Updating API in stable version with Breaking Change Validation errors
• Updating API(s) in preview over 1 year

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

[openapi-workflow-bot]

Hi, @amrElroumy Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 59 Errors, 0 Warnings failed [Detail]

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

• Compared Swaggers (Based on Oad v0.8.6)
  • original: preview/2020-11-01-preview3/communicationserviceschat.json <---> new: preview/2020-11-01-preview3/communicationserviceschat.json

Rule	Message
❌ 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ChatMessagePriority' removed or renamed? New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1182:3 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1180:3
❌ 1011 - AddingResponseCode	The new version adds a response code '200'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L125:11
❌ 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L125:11
❌ 1026 - TypeChanged	The new version has a different type 'object' than the previous one 'string'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1382:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1337:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1192:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1185:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1197:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1191:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1202:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1197:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1217:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1210:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1295:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1306:9
❌ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'true' to 'false'. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1366:9 Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1318:9

️⚠️LintDiff: 1 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
  • communication/data-plane/readme.md tag:package-2020-11-01-preview3
• Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
  • communication/data-plane/readme.md tag:package-2020-11-01-preview3

Rule

Message

⚠️ R2063 - OperationIdNounConflictingModelNames

OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ChatThreadModel'. Consider using the plural form of 'ChatThread' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L760

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger pipeline restarted successfully, please wait for status update in this comment.

[openapi-workflow-bot]

Hi @amrElroumy, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[openapi-workflow-bot]

Hi @amrElroumy, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

[amrElroumy]

Hello @tjprescott

We are rolling out more updates to our WIP API version in preparation for general availability. This version is not published yet so breaking changes in it would have no impact.

[tjprescott]

@lmazuel I don't have permissions to merge this. These are changes to a swagger that has not seen any release.