-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issues/communicationautorest (#13363)
* [Communication] WIP testing new location readme * [Identity] WIP new read me * [WIP] read me update * [communication] identity remove duplicate files * [communication] adding phonenumber tag * [readme] moving new read me into identity * [autorest] adding read me to packages * [autorest] fixing chat path * [readme.csharp] removing some properties of the yaml * [autorest] removing the readme from the shared folder * [readme] updating read from upstream master * [readme] fixing the tag * [readme] clean up * [readme] clean up * [readme] clean up for identity * [readme] clean up phonenumbers * [readme] clean up identity * [readme] clean up sms * [readme] clean up admin * [readme] adding stable version * [readme] update the tag * [readme] remove the admin readme * [readme] delete root read me * [Admin] Readding the admin package * [readme] adding read me to admin and turn packages
- Loading branch information
Showing
36 changed files
with
961 additions
and
199 deletions.
There are no files selected for viewing
File renamed without changes.
66 changes: 66 additions & 0 deletions
66
...ommunication/data-plane/Microsoft.CommunicationServicesAdministration/readme.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# 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](https://aka.ms/autorest/install) on the AutoRest github page. | ||
|
||
--- | ||
|
||
## Configuration | ||
|
||
### Basic Information | ||
|
||
These are the global settings for the communicationservices. | ||
|
||
```yaml | ||
openapi-type: data-plane | ||
tag: package-2020-07-20-preview1 | ||
``` | ||
### Tag: package-2020-07-20-preview1 | ||
These settings apply only when `--tag=package-2020-07-20-preview1` is specified on the command line. | ||
|
||
```yaml $(tag) == 'package-2020-07-20-preview1' | ||
input-file: | ||
- preview/2020-07-20-preview1/communicationservicesadministration.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](./readme.python.md) | ||
|
||
## Ruby | ||
|
||
See configuration in [readme.ruby.md](./readme.ruby.md) | ||
|
||
## TypeScript | ||
|
||
See configuration in [readme.typescript.md](./readme.typescript.md) | ||
|
||
## CSharp | ||
|
||
See configuration in [readme.csharp.md](./readme.csharp.md) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions
15
...n/communication/data-plane/Microsoft.CommunicationServicesChat/readme.csharp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## C | ||
|
||
These settings apply only when `--csharp` is specified on the command line. | ||
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`. | ||
|
||
```yaml $(csharp) | ||
csharp: | ||
azure-arm: true | ||
license-header: MICROSOFT_MIT_NO_VERSION | ||
payload-flattening-threshold: 1 | ||
clear-output-folder: true | ||
client-side-validation: false | ||
namespace: Microsoft.CommunicationServices | ||
output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol | ||
``` |
110 changes: 110 additions & 0 deletions
110
...fication/communication/data-plane/Microsoft.CommunicationServicesChat/readme.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
# 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](https://aka.ms/autorest/install) on the AutoRest github page. | ||
|
||
--- | ||
|
||
## Configuration | ||
|
||
### Basic Information | ||
|
||
These are the global settings for the communicationservices. | ||
|
||
```yaml | ||
openapi-type: data-plane | ||
tag: package-2020-07-20-preview1 | ||
``` | ||
### Tag: package-2020-09-21-preview2 | ||
These settings apply only when `--tag=package-2020-09-21-preview2` is specified on the command line. | ||
|
||
```yaml $(tag) == 'package-2020-09-21-preview2' | ||
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. | ||
|
||
```yaml $(tag) == 'package-2020-11-01-preview3' | ||
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. | ||
|
||
```yaml $(tag) == 'package-2021-01-27-preview4' | ||
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. | ||
|
||
```yaml $(tag) == 'package-2021-03-01-preview5' | ||
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. | ||
|
||
```yaml $(tag) == 'package-chat-2021-03-07' | ||
input-file: | ||
- stable/2021-03-07/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](./readme.python.md) | ||
|
||
## Ruby | ||
|
||
See configuration in [readme.ruby.md](./readme.ruby.md) | ||
|
||
## TypeScript | ||
|
||
See configuration in [readme.typescript.md](./readme.typescript.md) | ||
|
||
## CSharp | ||
|
||
See configuration in [readme.csharp.md](./readme.csharp.md) |
21 changes: 21 additions & 0 deletions
21
...n/communication/data-plane/Microsoft.CommunicationServicesChat/readme.python.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Python | ||
|
||
These settings apply only when `--python` is specified on the command line. | ||
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`. | ||
|
||
```yaml $(python) | ||
python: | ||
azure-arm: true | ||
license-header: MICROSOFT_MIT_NO_VERSION | ||
payload-flattening-threshold: 2 | ||
namespace: Microsoft.CommunicationServices | ||
package-name: communicationservices | ||
package-version: 2020-04-16-privatepreview | ||
clear-output-folder: true | ||
``` | ||
```yaml $(python) | ||
python: | ||
no-namespace-folders: true | ||
output-folder: $(python-sdks-folder)/azure-mgmt/communicationservices | ||
``` |
19 changes: 19 additions & 0 deletions
19
...ion/communication/data-plane/Microsoft.CommunicationServicesChat/readme.ruby.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Ruby | ||
|
||
These settings apply only when `--ruby` is specified on the command line. | ||
|
||
```yaml | ||
package-name: azure_mgmt_communicationservices | ||
package-version: 2020-04-16-privatepreview | ||
azure-arm: true | ||
``` | ||
### Tag: package-2020-04-16-privatepreview and ruby | ||
These settings apply only when `--tag=package-2020-04-16-privatepreview --ruby` is specified on the command line. | ||
Please also specify `--ruby-sdks-folder=<path to the root directory of your azure-sdk-for-ruby clone>`. | ||
|
||
```yaml $(tag) == 'package-2020-04-16-privatepreview' && $(ruby) | ||
namespace: Microsoft.CommunicationServices | ||
output-folder: $(ruby-sdks-folder)/communicationservices | ||
``` |
13 changes: 13 additions & 0 deletions
13
...mmunication/data-plane/Microsoft.CommunicationServicesChat/readme.typescript.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## TypeScript | ||
|
||
These settings apply only when `--typescript` is specified on the command line. | ||
Please also specify `--typescript-sdks-folder=<path to root folder of your azure-sdk-for-js clone>`. | ||
|
||
```yaml $(typescript) | ||
typescript: | ||
azure-arm: true | ||
package-name: "communicationservices" | ||
output-folder: "$(typescript-sdks-folder)/packages/communicationservices" | ||
payload-flattening-threshold: 1 | ||
generate-metadata: true | ||
``` |
15 changes: 15 additions & 0 deletions
15
...communication/data-plane/Microsoft.CommunicationServicesCommon/readme.csharp.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
## C | ||
|
||
These settings apply only when `--csharp` is specified on the command line. | ||
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`. | ||
|
||
```yaml $(csharp) | ||
csharp: | ||
azure-arm: true | ||
license-header: MICROSOFT_MIT_NO_VERSION | ||
payload-flattening-threshold: 1 | ||
clear-output-folder: true | ||
client-side-validation: false | ||
namespace: Microsoft.CommunicationServices | ||
output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol | ||
``` |
73 changes: 73 additions & 0 deletions
73
...cation/communication/data-plane/Microsoft.CommunicationServicesCommon/readme.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# 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](https://aka.ms/autorest/install) on the AutoRest github page. | ||
|
||
--- | ||
|
||
## Configuration | ||
|
||
### Basic Information | ||
|
||
These are the global settings for the communicationservices. | ||
|
||
```yaml | ||
openapi-type: data-plane | ||
tag: package-2020-07-20-preview1 | ||
``` | ||
### Tag: package-common-2020-11-19-preview1 | ||
These settings apply only when `--tag=package-common-2020-11-19-preview1` is specified on the command line. | ||
|
||
```yaml $(tag) == 'package-common-2020-11-19-preview1' | ||
input-file: | ||
- preview/2020-11-19-preview1/common.json | ||
``` | ||
|
||
### Tag: package-2021-03-07-stable | ||
These settings apply only when `--tag=package-2021-03-07-stable` is specified on the command line. | ||
|
||
```yaml $(tag) == 'package-2020-11-19-preview1' | ||
input-file: | ||
- stable/2021-03-07/common.json | ||
``` | ||
|
||
--- | ||
|
||
# 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](./readme.python.md) | ||
|
||
## Ruby | ||
|
||
See configuration in [readme.ruby.md](./readme.ruby.md) | ||
|
||
## TypeScript | ||
|
||
See configuration in [readme.typescript.md](./readme.typescript.md) | ||
|
||
## CSharp | ||
|
||
See configuration in [readme.csharp.md](./readme.csharp.md) |
21 changes: 21 additions & 0 deletions
21
...communication/data-plane/Microsoft.CommunicationServicesCommon/readme.python.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## Python | ||
|
||
These settings apply only when `--python` is specified on the command line. | ||
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`. | ||
|
||
```yaml $(python) | ||
python: | ||
azure-arm: true | ||
license-header: MICROSOFT_MIT_NO_VERSION | ||
payload-flattening-threshold: 2 | ||
namespace: Microsoft.CommunicationServices | ||
package-name: communicationservices | ||
package-version: 2020-04-16-privatepreview | ||
clear-output-folder: true | ||
``` | ||
```yaml $(python) | ||
python: | ||
no-namespace-folders: true | ||
output-folder: $(python-sdks-folder)/azure-mgmt/communicationservices | ||
``` |
19 changes: 19 additions & 0 deletions
19
...n/communication/data-plane/Microsoft.CommunicationServicesCommon/readme.ruby.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Ruby | ||
|
||
These settings apply only when `--ruby` is specified on the command line. | ||
|
||
```yaml | ||
package-name: azure_mgmt_communicationservices | ||
package-version: 2020-04-16-privatepreview | ||
azure-arm: true | ||
``` | ||
### Tag: package-2020-04-16-privatepreview and ruby | ||
These settings apply only when `--tag=package-2020-04-16-privatepreview --ruby` is specified on the command line. | ||
Please also specify `--ruby-sdks-folder=<path to the root directory of your azure-sdk-for-ruby clone>`. | ||
|
||
```yaml $(tag) == 'package-2020-04-16-privatepreview' && $(ruby) | ||
namespace: Microsoft.CommunicationServices | ||
output-folder: $(ruby-sdks-folder)/communicationservices | ||
``` |
13 changes: 13 additions & 0 deletions
13
...unication/data-plane/Microsoft.CommunicationServicesCommon/readme.typescript.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
## TypeScript | ||
|
||
These settings apply only when `--typescript` is specified on the command line. | ||
Please also specify `--typescript-sdks-folder=<path to root folder of your azure-sdk-for-js clone>`. | ||
|
||
```yaml $(typescript) | ||
typescript: | ||
azure-arm: true | ||
package-name: "communicationservices" | ||
output-folder: "$(typescript-sdks-folder)/packages/communicationservices" | ||
payload-flattening-threshold: 1 | ||
generate-metadata: true | ||
``` |
Oops, something went wrong.