Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readmes for SDK Auto-gen #17328

Merged
merged 10 commits into from
Jan 20, 2022
Merged

Update readmes for SDK Auto-gen #17328

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9d25a45
Update readme.python.md
leigharubin Jan 12, 2022
c38e486
Update readme.python.md
leigharubin Jan 12, 2022
9e3e70f
Update readme.python.md
leigharubin Jan 12, 2022
794cc95
Update readme.md
leigharubin Jan 12, 2022
036df02
Update readme.java.md
leigharubin Jan 12, 2022
a1646ad
Update readme.go.md
leigharubin Jan 12, 2022
fbfc29c
Update readme.md
leigharubin Jan 12, 2022
9e0f088
Remove multiapi
leigharubin Jan 14, 2022
56f7818
Update readme.md
msyyc Jan 19, 2022
08897b1
Update readme.python.md
msyyc Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 44 additions & 5 deletions specification/deviceprovisioningservices/resource-manager/readme.go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,50 @@ azure-arm: true

``` yaml $(go) && $(multiapi)
batch:
- tag: package-2017-11
- tag: package-2017-08
- tag: package-2021-10
- tag: package-preview-2020-09
- tag: package-2020-03
- tag: package-2020-01
- tag: package-2018-01
- tag: package-2017-11
- tag: package-preview-2017-08
```

### Tag: package-2021-10 and go

These settings apply only when `--tag=package-2021-10 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag)=='package-2021-10' && $(go)
output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2021-10-15/$(namespace)
```

### Tag: package-preview-2020-09 and go

These settings apply only when `--tag=package-preview-2020-09 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag)=='package-preview-2020-09' && $(go)
output-folder: $(go-sdk-folder)/services/preview/provisioningservices/mgmt/2020-09-01-preview/$(namespace)
```

### Tag: package-2020-03 and go

These settings apply only when `--tag=package-2020-03 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag)=='package-2020-03' && $(go)
output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2020-03-01/$(namespace)
```

### Tag: package-2020-01 and go

These settings apply only when `--tag=package-2020-01 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag)=='package-2020-01' && $(go)
output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2020-01-01/$(namespace)
```

### Tag: package-2018-01 and go

Expand All @@ -45,11 +84,11 @@ Please also specify `--go-sdk-folder=<path to the root directory of your azure-s
output-folder: $(go-sdk-folder)/services/provisioningservices/mgmt/2017-11-15/$(namespace)
```

### Tag: package-2017-08 and go
### Tag: package-preview-2017-08 and go

These settings apply only when `--tag=package-2017-08 --go` is specified on the command line.
These settings apply only when `--tag=package-preview-2017-08 --go` is specified on the command line.
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag)=='package-2017-08' && $(go)
``` yaml $(tag)=='package-preview-2017-08' && $(go)
output-folder: $(go-sdk-folder)/services/preview/provisioningservices/mgmt/2017-08-21-preview/$(namespace)
```
28 changes: 25 additions & 3 deletions specification/deviceprovisioningservices/resource-manager/readme.java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,28 @@ directive:
to: SharedAccessSignatureAuthorizationRule
```

## Tag: package-2021-10 and java

These settings apply only when `--tag=package-2021-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-2021-10' && $(java) && $(multiapi)
java:
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2021_10_15
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2021_10_15
```

## Tag: package-preview-2020-09 and java

These settings apply only when `--tag=package-preview-2020-09 --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-preview-2020-09' && $(java) && $(multiapi)
java:
namespace: com.microsoft.azure.management.deviceprovisioningservices.v2020_09_01_preview
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2020_09_01_preview
```

## Tag: package-2020-03 and java

These settings apply only when `--tag=package-2020-03 --java` is specified on the command line.
Expand Down Expand Up @@ -59,12 +81,12 @@ java:
output-folder: $(azure-libraries-for-java-folder)/sdk/deviceprovisioningservices/mgmt-v2017_11_15
```

## Tag: package-2017-08 and java
## Tag: package-preview-2017-08 and java

These settings apply only when `--tag=package-2017-08 --java` is specified on the command line.
These settings apply only when `--tag=package-preview-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)
``` yaml $(tag) == 'package-preview-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
Expand Down
9 changes: 4 additions & 5 deletions specification/deviceprovisioningservices/resource-manager/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ These are the global settings for the API.

``` yaml
openapi-type: arm
tag: package-2020-03
tag: package-2021-10
```

### Tag: package-preview-2020-09
Expand All @@ -47,11 +47,11 @@ input-file:
- Microsoft.Devices/stable/2020-03-01/iotdps.json
```

### Tag: package-2017-08
### Tag: package-preview-2017-08

These settings apply only when `--tag=package-2017-08` is specified on the command line.
These settings apply only when `--tag=package-preview-2017-08` is specified on the command line.

``` yaml $(tag) == 'package-2017-08'
``` yaml $(tag) == 'package-preview-2017-08'
input-file:
- Microsoft.Devices/preview/2017-08-21-preview/iotdps.json
```
Expand Down Expand Up @@ -107,7 +107,6 @@ This is not used by Autorest itself.
swagger-to-sdk:
- repo: azure-sdk-for-net
- repo: azure-sdk-for-python
- repo: azure-sdk-for-python-track2
- repo: azure-sdk-for-java
- repo: azure-sdk-for-go
- repo: azure-sdk-for-go-track2
Expand Down
92 changes: 64 additions & 28 deletions specification/deviceprovisioningservices/resource-manager/readme.python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,85 @@
### 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>`.
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.

``` yaml $(python) && !$(track2)
python-mode: create
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: azure.mgmt.iothubprovisioningservices
package-name: azure-mgmt-iothubprovisioningservices
package-version: 0.1.0
clear-output-folder: true
```

``` yaml $(python) && $(track2)
python-mode: create
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
namespace: azure.mgmt.iothubprovisioningservices
package-name: azure-mgmt-iothubprovisioningservices
package-version: 1.0.0b1
clear-output-folder: true
no-namespace-folders: true
```

``` yaml $(python) && $(python-mode) == 'update' && !$(track2)
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices
### Tag: package-2021-10 and python

These settings apply only when `--tag=package-2021-10 --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 $(tag) == 'package-2021-10' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2021_10_15
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2021_10_15
```

``` yaml $(python) && $(python-mode) == 'create' && !$(track2)
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices
### Tag: package-preview-2020-09 and python

These settings apply only when `--tag=package-preview-2020-09 --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 $(tag) == 'package-preview-2020-09' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2020_09_01_preview
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2020_09_01_preview
```

``` yaml $(python) && $(python-mode) == 'update' && $(track2)
no-namespace-folders: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices
### Tag: package-2020-03 and python

These settings apply only when `--tag=package-2020-03 --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 $(tag) == 'package-2020-03' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2020_03_01
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2020_03_01
```

``` yaml $(python) && $(python-mode) == 'create' && $(track2)
basic-setup-py: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices
### Tag: package-2020-03 and python

These settings apply only when `--tag=package-2020-01 --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 $(tag) == 'package-2020-01' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2020_01_01
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2020_01_01
```

### Tag: package-2018-01 and python

These settings apply only when `--tag=package-2018_01 --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 $(tag) == 'package-2018_01' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2018_01_22
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2018_01_22
```

### Tag: package-2017-11 and python

These settings apply only when `--tag=package-2017-11 --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 $(tag) == 'package-2017-11' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2017_11_15
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2017_11_15
```

### Tag: package-preview-2017-08 and python

These settings apply only when `--tag=package-preview-2017-08 --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 $(tag) == 'package-preview-2017-08' && $(python)
namespace: azure.mgmt.iothubprovisioningservices.v2017_08_21_preview
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices/v2017_08_21_preview
```