Skip to content

Commit

Permalink
Update readmes for SDK Auto-gen (Azure#17328)
Browse files Browse the repository at this point in the history
* Update readme.python.md

* Update readme.python.md

* Update readme.python.md

* Update readme.md

* Update readme.java.md

* Update readme.go.md

* Update readme.md

* Remove multiapi

* Update readme.md

* Update readme.python.md

Co-authored-by: Yuchao Yan <[email protected]>
  • Loading branch information
2 people authored and mstrisoline committed Feb 1, 2022
1 parent ede697f commit ac49080
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 36 deletions.
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)
```
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
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 @@ -106,7 +106,6 @@ This is not used by Autorest itself.
``` yaml $(swagger-to-sdk)
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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,6 @@ 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
Expand All @@ -26,18 +15,6 @@ package-version: 1.0.0b1
clear-output-folder: true
```
``` yaml $(python) && $(python-mode) == 'update' && !$(track2)
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices
```
``` yaml $(python) && $(python-mode) == 'create' && !$(track2)
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices
```
``` yaml $(python) && $(python-mode) == 'update' && $(track2)
no-namespace-folders: true
output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iothubprovisioningservices/azure/mgmt/iothubprovisioningservices
Expand Down

0 comments on commit ac49080

Please sign in to comment.