Skip to content

Commit 9a75793

Browse files
author
David R. Williamson
authored
Add DPS lang readmes (#13392)
1 parent a2b6c11 commit 9a75793

File tree

6 files changed

+129
-103
lines changed

6 files changed

+129
-103
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# C# DPS
2+
3+
> see https://aka.ms/autorest
4+
5+
This is the AutoRest configuration file for the Device Provisioning Service.
6+
7+
## C# common settings
8+
9+
These settings apply only when `--csharp` is specified on the command line.
10+
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`.
11+
12+
``` yaml $(csharp)
13+
csharp:
14+
azure-arm: true
15+
license-header: MICROSOFT_MIT_NO_VERSION
16+
payload-flattening-threshold: 1
17+
client-side-validation: false
18+
clear-output-folder: true
19+
namespace: Microsoft.Azure.Management.DeviceProvisioningServices
20+
output-folder: $(csharp-sdks-folder)/deviceprovisioningservcies/Management.Azure.Management.DeviceProvisioningServcies/src/Generated
21+
```
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Java DPS
2+
3+
> see https://aka.ms/autorest
4+
5+
This is the AutoRest configuration file for the Device Provisioning Service.
6+
7+
## Java common settings
8+
9+
These settings apply only when `--java` is specified on the command line.
10+
Please also specify `--azure-libraries-for-java-folder=<path to "SDKs" directory of your azure-sdk-for-java clone>`.
11+
12+
``` yaml $(java)
13+
java:
14+
azure-arm: true
15+
regenerate-manager: true
16+
license-header: MICROSOFT_MIT_NO_CODEGEN
17+
payload-flattening-threshold: 1
18+
client-side-validation: false
19+
generate-interface: true
20+
clear-output-folder: true
21+
output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices
22+
```
23+
24+
## Tag: package-2020-03 and java
25+
26+
These settings apply only when `--tag=package-2020-03 --java` is specified on the command line.
27+
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
28+
29+
``` yaml $(tag) == 'package-2020-03' && $(java)
30+
java:
31+
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2020_03_01
32+
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2020_03_01
33+
```
34+
35+
## Tag: package-2018-01 and java
36+
37+
These settings apply only when `--tag=package-2018-01 --java` is specified on the command line.
38+
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
39+
40+
``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi)
41+
java:
42+
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2018_01_22
43+
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2018_01_22
44+
```
45+
46+
## Tag: package-2017-11 and java
47+
48+
These settings apply only when `--tag=package-2017-11 --java` is specified on the command line.
49+
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
50+
51+
``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi)
52+
java:
53+
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_11_15
54+
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_11_15
55+
```
56+
57+
## Tag: package-2017-08 and java
58+
59+
These settings apply only when `--tag=package-2017-08 --java` is specified on the command line.
60+
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
61+
62+
``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi)
63+
java:
64+
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_08_21_preview
65+
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_08_21_preview
66+
```

specification/deviceprovisioningservices/resource-manager/readme.md

Lines changed: 10 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ openapi-type: arm
2929
tag: package-preview-2020-09
3030
```
3131
32-
3332
### Tag: package-preview-2020-09
3433
3534
These settings apply only when `--tag=package-preview-2020-09` is specified on the command line.
@@ -38,6 +37,7 @@ These settings apply only when `--tag=package-preview-2020-09` is specified on t
3837
input-file:
3938
- Microsoft.Devices/preview/2020-09-01-preview/iotdps.json
4039
```
40+
4141
### Tag: package-2020-03
4242

4343
These settings apply only when `--tag=package-2020-03` is specified on the command line.
@@ -85,9 +85,9 @@ input-file:
8585

8686
---
8787

88-
# Code Generation
88+
## Code Generation
8989

90-
## Swagger to SDK
90+
### Swagger to SDK
9191

9292
This section describes what SDK should be generated by the automatic system.
9393
This is not used by Autorest itself.
@@ -105,21 +105,11 @@ swagger-to-sdk:
105105
- node sdkauto_afterscript.js deviceprovisioningservices/resource-manager
106106
```
107107

108-
## C#
108+
### C#
109109

110-
These settings apply only when `--csharp` is specified on the command line.
111-
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`.
112-
113-
``` yaml $(csharp)
114-
csharp:
115-
azure-arm: true
116-
license-header: MICROSOFT_MIT_NO_VERSION
117-
namespace: Microsoft.Azure.Management.DeviceProvisioningServices
118-
output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/Microsoft.Azure.Management.DeviceProvisioningServices/src/Generated
119-
clear-output-folder: true
120-
```
110+
See configuration in [readme.csharp.md](./readme.csharp.md)
121111

122-
## Python
112+
### Python
123113

124114
These settings apply only when `--python` is specified on the command line.
125115
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
@@ -148,73 +138,14 @@ python:
148138
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices
149139
```
150140

151-
## Go
141+
### Go
152142

153143
See configuration in [readme.go.md](./readme.go.md)
154144

155-
## Java
156-
157-
These settings apply only when `--java` is specified on the command line.
158-
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.
159-
160-
``` yaml $(java)
161-
azure-arm: true
162-
fluent: true
163-
namespace: com.microsoft.azure.management.provisioningservices
164-
license-header: MICROSOFT_MIT_NO_CODEGEN
165-
payload-flattening-threshold: 1
166-
output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-provisioningservices
167-
```
168-
169-
### Java multi-api
170-
171-
``` yaml $(java) && $(multiapi)
172-
batch:
173-
- tag: package-2017-08
174-
- tag: package-2017-11
175-
- tag: package-2018-01
176-
```
145+
### Java
177146

178-
### Tag: package-2017-08 and java
147+
See configuration in [readme.java.md](./readme.java.md)
179148

180-
These settings apply only when `--tag=package-2017-08 --java` is specified on the command line.
181-
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
182-
183-
``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi)
184-
java:
185-
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_08_21_preview
186-
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_08_21_preview
187-
regenerate-manager: true
188-
generate-interface: true
189-
```
190-
191-
### Tag: package-2017-11 and java
192-
193-
These settings apply only when `--tag=package-2017-11 --java` is specified on the command line.
194-
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
195-
196-
``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi)
197-
java:
198-
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_11_15
199-
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_11_15
200-
regenerate-manager: true
201-
generate-interface: true
202-
```
203-
204-
### Tag: package-2018-01 and java
205-
206-
These settings apply only when `--tag=package-2018-01 --java` is specified on the command line.
207-
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
208-
209-
``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi)
210-
java:
211-
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2018_01_22
212-
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2018_01_22
213-
regenerate-manager: true
214-
generate-interface: true
215-
```
216-
217-
## AzureResourceSchema
149+
### AzureResourceSchema
218150

219151
See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
220-

specification/digitaltwins/resource-manager/readme.csharp.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
## C
1+
# C# ADT
2+
3+
## C# common settings
24

35
These settings apply only when `--csharp` is specified on the command line.
46
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`.
Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
1-
## Java
1+
# Java ADT
2+
3+
> see https://aka.ms/autorest
4+
5+
This is the AutoRest configuration file for Azure Digital Twins.
6+
7+
## Java common settings
28

39
These settings apply only when `--java` is specified on the command line.
410
Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.
511

6-
``` yaml $(java)
12+
```yaml $(java)
713
azure-arm: true
814
fluent: true
915
namespace: com.microsoft.azure.management.digitaltwins
@@ -14,7 +20,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-digitaltwins
1420
1521
### Java multi-api
1622
17-
``` yaml $(java) && $(multiapi)
23+
```yaml $(java) && $(multiapi)
1824
batch:
1925
- tag: package-2020-12
2026
- tag: package-2020-10
@@ -26,36 +32,36 @@ batch:
2632
These settings apply only when `--tag=package-2020-12 --java` is specified on the command line.
2733
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
2834

29-
``` yaml $(tag) == 'package-2020-12' && $(java) && $(multiapi)
35+
```yaml $(tag) == 'package-2020-12' && $(java) && $(multiapi)
3036
java:
3137
namespace: com.microsoft.azure.management.digitaltwins.v2020_12_01
3238
output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_12_01
33-
regenerate-manager: true
34-
generate-interface: true
39+
regenerate-manager: true
40+
generate-interface: true
3541
```
3642

3743
### Tag: package-2020-10 and java
3844

3945
These settings apply only when `--tag=package-2020-10 --java` is specified on the command line.
4046
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
4147

42-
``` yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi)
48+
```yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi)
4349
java:
4450
namespace: com.microsoft.azure.management.digitaltwins.v2020_10_31
4551
output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_10_31
46-
regenerate-manager: true
47-
generate-interface: true
52+
regenerate-manager: true
53+
generate-interface: true
4854
```
4955

5056
### Tag: package-2020-03-01-preview and java
5157

5258
These settings apply only when `--tag=package-2020-03-01-preview --java` is specified on the command line.
5359
Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
5460

55-
``` yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi)
61+
```yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi)
5662
java:
5763
namespace: com.microsoft.azure.management.digitaltwins.v2020_03_01_preview
5864
output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_03_01_preview
59-
regenerate-manager: true
60-
generate-interface: true
65+
regenerate-manager: true
66+
generate-interface: true
6167
```

specification/digitaltwins/resource-manager/readme.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ openapi-type: arm
2929
tag: package-2020-12
3030
```
3131
32-
3332
### Tag: package-2020-12
3433
3534
These settings apply only when `--tag=package-2020-12` is specified on the command line.
@@ -38,6 +37,7 @@ These settings apply only when `--tag=package-2020-12` is specified on the comma
3837
input-file:
3938
- Microsoft.DigitalTwins/stable/2020-12-01/digitaltwins.json
4039
```
40+
4141
### Tag: package-2020-10
4242

4343
These settings apply only when `--tag=package-2020-10` is specified on the command line.
@@ -58,9 +58,9 @@ input-file:
5858

5959
---
6060

61-
# Code Generation
61+
## Code Generation
6262

63-
## Swagger to SDK
63+
### Swagger to SDK
6464

6565
This section describes what SDK should be generated by the automatic system.
6666
This is not used by Autorest itself.
@@ -80,35 +80,35 @@ swagger-to-sdk:
8080
- node sdkauto_afterscript.js digitaltwins/resource-manager
8181
```
8282

83-
## Go
83+
### Go
8484

8585
See configuration in [readme.go.md](./readme.go.md)
8686

87-
## Python
87+
### Python
8888

8989
See configuration in [readme.python.md](./readme.python.md)
9090

91-
## Ruby
91+
### Ruby
9292

9393
See configuration in [readme.ruby.md](./readme.ruby.md)
9494

95-
## TypeScript
95+
### TypeScript
9696

9797
See configuration in [readme.typescript.md](./readme.typescript.md)
9898

99-
## CSharp
99+
### CSharp
100100

101101
See configuration in [readme.csharp.md](./readme.csharp.md)
102102

103-
## Java
103+
### Java
104104

105105
See configuration in [readme.java.md](./readme.java.md)
106106

107-
## AzureResourceSchema
107+
### AzureResourceSchema
108108

109109
See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
110110

111-
## Suppression
111+
### Suppression
112112

113113
``` yaml
114114
directive:

0 commit comments

Comments
 (0)