Skip to content

readme.md

Latest commit

 

History

History
264 lines (188 loc) · 6.95 KB

readme.md

File metadata and controls

264 lines (188 loc) · 6.95 KB

communicationservices

see https://aka.ms/autorest

This is the AutoRest configuration file for communicationservices.

Getting Started

To build the SDKs for My API, simply install AutoRest via npm (npm install -g autorest) and then run:

autorest readme.md

To see additional help and options, run:

autorest --help

For other options on installation see Installing AutoRest on the AutoRest github page.

Configuration

Basic Information

These are the global settings for the communicationservices.

openapi-type: data-plane
tag: package-chat-2024-03-07

Tag: package-2020-09-21-preview2

These settings apply only when --tag=package-2020-09-21-preview2 is specified on the command line.

input-file:
  - preview/2020-09-21-preview2/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2020-11-01-preview3

These settings apply only when --tag=package-2020-11-01-preview3 is specified on the command line.

input-file:
  - preview/2020-11-01-preview3/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2021-01-27-preview4

These settings apply only when --tag=package-2021-01-27-preview4 is specified on the command line.

input-file:
  - preview/2021-01-27-preview4/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2021-03-01-preview5

These settings apply only when --tag=package-2021-03-01-preview5 is specified on the command line.

input-file:
  - preview/2021-03-01-preview5/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2021-03-07

These settings apply only when --tag=package-chat-2021-03-07 is specified on the command line.

input-file:
  - stable/2021-03-07/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2021-04-05-preview6

These settings apply only when --tag=package-2021-04-05-preview6 is specified on the command line.

input-file:
  - preview/2021-04-05-preview6/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2021-09-07

These settings apply only when --tag=package-2021-09-07 is specified on the command line.

input-file:
  - stable/2021-09-07/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2021-10-01-preview7

These settings apply only when --tag=2021-10-01-preview7 is specified on the command line.

input-file:
  - preview/2021-10-01-preview7/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2023-04-01-preview

These settings apply only when --tag=2023-04-01-preview is specified on the command line.

input-file:
  - preview/2023-04-01-preview/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2023-07-01-preview

These settings apply only when --tag=2023-07-01-preview is specified on the command line.

input-file:
  - preview/2023-07-01-preview/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2023-11-07

These settings apply only when --tag=package-chat-2023-11-07 is specified on the command line.

input-file:
  - stable/2023-11-07/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2023-11-15-preview

These settings apply only when --tag=package-2023-11-15-preview is specified on the command line.

input-file:
  - preview/2023-11-15-preview/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2024-03-01-preview

These settings apply only when --tag=package-2024-03-01-preview is specified on the command line.

input-file:
  - preview/2024-03-01-preview/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-chat-2024-03-07

These settings apply only when --tag=package-chat-2024-03-07 is specified on the command line.

input-file:
  - stable/2024-03-07/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2024-03-15-preview

These settings apply only when --tag=package-2024-03-15-preview is specified on the command line.

input-file:
  - preview/2024-03-15-preview/communicationserviceschat.json
title:
  Azure Communication Services

Tag: package-2024-06-05-preview

These settings apply only when --tag=package-2024-06-05-preview is specified on the command line.

input-file:
  - preview/2024-06-05-preview/communicationserviceschat.json
title:
  Azure Communication Services

Code Generation

Swagger to SDK

This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself.

Python

See configuration in readme.python.md

Ruby

See configuration in readme.ruby.md

TypeScript

See configuration in readme.typescript.md

CSharp

See configuration in readme.csharp.md

Swift

These settings apply only when --swift is specified on the command line.

clear-output-folder: false
namespace: AzureCommunicationChat
title: AzureCommunicationChat
package-name: AzureCommunicationChat
package-version: 1.0.0
license-header: MICROSOFT_MIT_NO_VERSION
add-credential: true
generate-as-internal: >
    AzureCommunicationChatClient=ChatClientInternal
    AzureCommunicationChatClientOptions=AzureCommunicationChatClientOptionsInternal
    AddChatParticipantsRequest=AddChatParticipantsRequestInternal
    CreateChatThreadResult=CreateChatThreadResultInternal
    CreateChatThreadRequest=CreateChatThreadRequestInternal
    ChatMessage=ChatMessageInternal
    ChatMessageContent=ChatMessageContentInternal
    ChatParticipant=ChatParticipantInternal
    ChatMessageReadReceipt=ChatMessageReadReceiptInternal
    ChatThreadProperties=ChatThreadPropertiesInternal
    CommunicationIdentifierModel=CommunicationIdentifierModelInternal
    UpdateChatThreadRequest=UpdateChatThreadRequestInternal
directive:
# Rename CommunicationError to ChatError
- from: swagger-document
  where: '$.definitions.CommunicationError'
  transform: >
    $["x-ms-client-name"] = "ChatError";
⚡