Add DPS lang readmes (Azure#13392)

mkarmark · Jul 20, 2021 · 22932cc · 22932cc
1 parent 0ef8f53
commit 22932cc
Show file tree

Hide file tree

Showing 6 changed files with 129 additions and 103 deletions.
diff --git a/specification/deviceprovisioningservices/resource-manager/readme.csharp.md b/specification/deviceprovisioningservices/resource-manager/readme.csharp.md
@@ -0,0 +1,21 @@
+# C# DPS
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for the Device Provisioning Service.
+
+## C# common settings
+
+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
+  client-side-validation: false
+  clear-output-folder: true
+  namespace: Microsoft.Azure.Management.DeviceProvisioningServices
+  output-folder: $(csharp-sdks-folder)/deviceprovisioningservcies/Management.Azure.Management.DeviceProvisioningServcies/src/Generated
+```
diff --git a/specification/deviceprovisioningservices/resource-manager/readme.java.md b/specification/deviceprovisioningservices/resource-manager/readme.java.md
@@ -0,0 +1,66 @@
+# Java DPS
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for the Device Provisioning Service.
+
+## Java common settings
+
+These settings apply only when `--java` is specified on the command line.
+Please also specify `--azure-libraries-for-java-folder=<path to "SDKs" directory of your azure-sdk-for-java clone>`.
+
+``` yaml $(java)
+java:
+  azure-arm: true
+  regenerate-manager: true
+  license-header: MICROSOFT_MIT_NO_CODEGEN
+  payload-flattening-threshold: 1
+  client-side-validation: false
+  generate-interface: true
+  clear-output-folder: true
+  output-folder: $(azure-libraries-for-java-folder)/deviceprovisioningservices
+```
+
+## Tag: package-2020-03 and java
+
+These settings apply only when `--tag=package-2020-03 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
+
+``` yaml $(tag) == 'package-2020-03' && $(java)
+java:
+  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2020_03_01
+  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2020_03_01
+```
+
+## Tag: package-2018-01 and java
+
+These settings apply only when `--tag=package-2018-01 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
+
+``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi)
+java:
+  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2018_01_22
+  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2018_01_22
+```
+
+## Tag: package-2017-11 and java
+
+These settings apply only when `--tag=package-2017-11 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
+
+``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi)
+java:
+  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_11_15
+  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_11_15
+```
+
+## Tag: package-2017-08 and java
+
+These settings apply only when `--tag=package-2017-08 --java` is specified on the command line.
+Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
+
+``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi)
+java:
+  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_08_21_preview
+  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_08_21_preview
+```
diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md
@@ -29,7 +29,6 @@ openapi-type: arm
 tag: package-preview-2020-09
 ```
 
-
 ### Tag: package-preview-2020-09
 
 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
 input-file:
   - Microsoft.Devices/preview/2020-09-01-preview/iotdps.json
 ```
+
 ### Tag: package-2020-03
 
 These settings apply only when `--tag=package-2020-03` is specified on the command line.
@@ -85,9 +85,9 @@ input-file:
 
 ---
 
-# Code Generation
+## Code Generation
 
-## Swagger to SDK
+### Swagger to SDK
 
 This section describes what SDK should be generated by the automatic system.
 This is not used by Autorest itself.
@@ -105,21 +105,11 @@ swagger-to-sdk:
       - node sdkauto_afterscript.js deviceprovisioningservices/resource-manager
 ```
 
-## C#
+### 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
-  namespace: Microsoft.Azure.Management.DeviceProvisioningServices
-  output-folder: $(csharp-sdks-folder)/deviceprovisioningservices/Microsoft.Azure.Management.DeviceProvisioningServices/src/Generated
-  clear-output-folder: true
-```
+See configuration in [readme.csharp.md](./readme.csharp.md)
 
-## Python
+### 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>`.
@@ -148,73 +138,14 @@ python:
   output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices
 ```
 
-## Go
+### Go
 
 See configuration in [readme.go.md](./readme.go.md)
 
-## Java
-
-These settings apply only when `--java` is specified on the command line.
-Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.
-
-``` yaml $(java)
-azure-arm: true
-fluent: true
-namespace: com.microsoft.azure.management.provisioningservices
-license-header: MICROSOFT_MIT_NO_CODEGEN
-payload-flattening-threshold: 1
-output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-provisioningservices
-```
-
-### Java multi-api
-
-``` yaml $(java) && $(multiapi)
-batch:
-  - tag: package-2017-08
-  - tag: package-2017-11
-  - tag: package-2018-01
-```
+### Java
 
-### Tag: package-2017-08 and java
+See configuration in [readme.java.md](./readme.java.md)
 
-These settings apply only when `--tag=package-2017-08 --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
-
-``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi)
-java:
-  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_08_21_preview
-  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_08_21_preview
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2017-11 and java
-
-These settings apply only when `--tag=package-2017-11 --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
-
-``` yaml $(tag) == 'package-2017-11' && $(java) && $(multiapi)
-java:
-  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2017_11_15
-  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_11_15
-regenerate-manager: true
-generate-interface: true
-```
-
-### Tag: package-2018-01 and java
-
-These settings apply only when `--tag=package-2018-01 --java` is specified on the command line.
-Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
-
-``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi)
-java:
-  namespace: com.microsoft.azure.management.deviceprovisioningservices.v2018_01_22
-  output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2018_01_22
-regenerate-manager: true
-generate-interface: true
-```
-
-## AzureResourceSchema
+### AzureResourceSchema
 
 See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
-
diff --git a/specification/digitaltwins/resource-manager/readme.csharp.md b/specification/digitaltwins/resource-manager/readme.csharp.md
@@ -1,4 +1,6 @@
-## C
+# C# ADT
+
+## C# common settings
 
 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>`.

diff --git a/specification/digitaltwins/resource-manager/readme.java.md b/specification/digitaltwins/resource-manager/readme.java.md
@@ -1,9 +1,15 @@
-## Java
+# Java ADT
+
+> see https://aka.ms/autorest
+
+This is the AutoRest configuration file for Azure Digital Twins.
+
+## Java common settings
 
 These settings apply only when `--java` is specified on the command line.
 Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.
 
-``` yaml $(java)
+```yaml $(java)
 azure-arm: true
 fluent: true
 namespace: com.microsoft.azure.management.digitaltwins
@@ -14,7 +20,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-digitaltwins
 
 ### Java multi-api
 
-``` yaml $(java) && $(multiapi)
+```yaml $(java) && $(multiapi)
 batch:
   - tag: package-2020-12
   - tag: package-2020-10
@@ -26,36 +32,36 @@ batch:
 These settings apply only when `--tag=package-2020-12 --java` is specified on the command line.
 Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
 
-``` yaml $(tag) == 'package-2020-12' && $(java) && $(multiapi)
+```yaml $(tag) == 'package-2020-12' && $(java) && $(multiapi)
 java:
   namespace: com.microsoft.azure.management.digitaltwins.v2020_12_01
   output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_12_01
-regenerate-manager: true
-generate-interface: true
+  regenerate-manager: true
+  generate-interface: true
 ```
 
 ### Tag: package-2020-10 and java
 
 These settings apply only when `--tag=package-2020-10 --java` is specified on the command line.
 Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
 
-``` yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi)
+```yaml $(tag) == 'package-2020-10' && $(java) && $(multiapi)
 java:
   namespace: com.microsoft.azure.management.digitaltwins.v2020_10_31
   output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_10_31
-regenerate-manager: true
-generate-interface: true
+  regenerate-manager: true
+  generate-interface: true
 ```
 
 ### Tag: package-2020-03-01-preview and java
 
 These settings apply only when `--tag=package-2020-03-01-preview --java` is specified on the command line.
 Please also specify `--azure-libraries-for-java=<path to the root directory of your azure-sdk-for-java clone>`.
 
-``` yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi)
+```yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi)
 java:
   namespace: com.microsoft.azure.management.digitaltwins.v2020_03_01_preview
   output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_03_01_preview
-regenerate-manager: true
-generate-interface: true
+  regenerate-manager: true
+  generate-interface: true
 ```
diff --git a/specification/digitaltwins/resource-manager/readme.md b/specification/digitaltwins/resource-manager/readme.md
@@ -29,7 +29,6 @@ openapi-type: arm
 tag: package-2020-12
 ```
 
-
 ### Tag: package-2020-12
 
 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
 input-file:
   - Microsoft.DigitalTwins/stable/2020-12-01/digitaltwins.json
 ```
+
 ### Tag: package-2020-10
 
 These settings apply only when `--tag=package-2020-10` is specified on the command line.
@@ -58,9 +58,9 @@ input-file:
 
 ---
 
-# Code Generation
+## Code Generation
 
-## Swagger to SDK
+### Swagger to SDK
 
 This section describes what SDK should be generated by the automatic system.
 This is not used by Autorest itself.
@@ -80,35 +80,35 @@ swagger-to-sdk:
       - node sdkauto_afterscript.js digitaltwins/resource-manager
 ```
 
-## Go
+### Go
 
 See configuration in [readme.go.md](./readme.go.md)
 
-## Python
+### Python
 
 See configuration in [readme.python.md](./readme.python.md)
 
-## Ruby
+### Ruby
 
 See configuration in [readme.ruby.md](./readme.ruby.md)
 
-## TypeScript
+### TypeScript
 
 See configuration in [readme.typescript.md](./readme.typescript.md)
 
-## CSharp
+### CSharp
 
 See configuration in [readme.csharp.md](./readme.csharp.md)
 
-## Java
+### Java
 
 See configuration in [readme.java.md](./readme.java.md)
 
-## AzureResourceSchema
+### AzureResourceSchema
 
 See configuration in [readme.azureresourceschema.md](./readme.azureresourceschema.md)
 
-## Suppression
+### Suppression
 
 ``` yaml
 directive: