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.

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

Updating readme for MySQL and PostgreSQL to include new flexible server namespace #10710

Merged
merged 8 commits into from
Sep 15, 2020
14 changes: 14 additions & 0 deletions specification/mysql/resource-manager/readme.az.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## AZ

These settings apply only when `--az` is specified on the command line.

``` yaml $(az)
az:
extensions: mysql
namespace: azure.mgmt.mysql
package-name: azure-mgmt-mysql
az-output-folder: $(azure-cli-extension-folder)/src/mysql
python-sdk-output-folder: "$(az-output-folder)/azext_mysql/vendored_sdks/mysql"
# add additinal configuration here specific for Azure CLI
# refer to the faq.md for more details
```
16 changes: 15 additions & 1 deletion specification/mysql/resource-manager/readme.go.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,37 @@ These settings apply only when `--go` is specified on the command line.
``` yaml $(go)
go:
license-header: MICROSOFT_APACHE_NO_VERSION
namespace: mysql
clear-output-folder: true
```

### Go multi-api

``` yaml $(go) && $(multiapi)
batch:
- tag: package-2020-07-01-privatepreview
- tag: package-2020-01-01
- tag: package-2017-12-01-preview
- tag: package-2017-12-01
```

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

These settings apply only when `--tag=package-2020-07-01-privatepreview --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-07-01-privatepreview' && $(go)
rpname: mysql
namespace: mysqlflexibleservers
output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-07-01-preview/$(namespace)
Comment on lines +27 to +29
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not quite sure if we could add this new variable here... could we just hard code this rpname in? like this:

Suggested change
rpname: mysql
namespace: mysqlflexibleservers
output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-07-01-preview/$(namespace)
namespace: mysql
output-folder: $(go-sdk-folder)/services/preview/mysql/mgmt/2020-07-01-preview/mysqlflexibleservers

```

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

These settings apply only when `--tag=package-2020-01-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-01' && $(go)
namespace: mysql
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace)
```

Expand All @@ -33,6 +45,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2017-12-01-preview' && $(go)
namespace: mysql
output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-12-01-preview/$(namespace)
```

Expand All @@ -42,5 +55,6 @@ These settings apply only when `--tag=package-2017-12-01 --go` is specified on t
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2017-12-01' && $(go)
namespace: mysql
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2017-12-01/$(namespace)
```
26 changes: 1 addition & 25 deletions specification/mysql/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,33 +165,9 @@ csharp:
clear-output-folder: true
```


## 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)
python-mode: create
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: azure.mgmt.rdbms.mysql
package-name: azure-mgmt-rdbms
clear-output-folder: true
```
``` yaml $(python) && $(python-mode) == 'update'
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql
```
``` yaml $(python) && $(python-mode) == 'create'
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms
```
See configuration in [readme.python.md](./readme.python.md)

## Go

Expand Down
67 changes: 67 additions & 0 deletions specification/mysql/resource-manager/readme.python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
## 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 !$(track2)
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
package-name: azure-mgmt-rdbms
clear-output-folder: true
no-namespace-folders: true
```

These settings apply only when `--track2` is specified on the command line.

``` yaml $(track2)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-rdbms
no-namespace-folders: true
```

### Python multi-api

Generate all API versions currently shipped for this package

```yaml !$(track2)
batch:
- tag: package-2020-01-01
- tag: package-2020-07-01-privatepreview
```

```yaml $(track2)
clear-output-folder: true
batch:
- tag: package-2020-01-01
- tag: package-2020-07-01-privatepreview
```

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

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

### Tag: package-2020-07-01-privatepreview and python

These settings apply only when `--tag=package-2020-07-01-privatepreview --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-07-01-privatepreview' && $(python)
namespace: azure.mgmt.rdbms.mysql_flexibleservers
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers
python:
namespace: azure.mgmt.rdbms.mysql_flexibleservers
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql_flexibleservers
```
14 changes: 14 additions & 0 deletions specification/postgresql/resource-manager/readme.az.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## AZ

These settings apply only when `--az` is specified on the command line.

``` yaml $(az)
az:
extensions: postgresql
namespace: azure.mgmt.postgresql
package-name: azure-mgmt-postgresql
az-output-folder: $(azure-cli-extension-folder)/src/postgresql
python-sdk-output-folder: "$(az-output-folder)/azext_postgresql/vendored_sdks/postgresql"
# add additinal configuration here specific for Azure CLI
# refer to the faq.md for more details
```
16 changes: 15 additions & 1 deletion specification/postgresql/resource-manager/readme.go.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,37 @@ These settings apply only when `--go` is specified on the command line.
``` yaml $(go)
go:
license-header: MICROSOFT_APACHE_NO_VERSION
namespace: postgresql
clear-output-folder: true
```

### Go multi-api

``` yaml $(go) && $(multiapi)
batch:
- tag: package-2020-02-14-privatepreview
- tag: package-2020-01-01
- tag: package-2017-12-01-preview
- tag: package-2017-12-01
```

### Tag: package-2020-02-14 and go

These settings apply only when `--tag=package-2020-02-14-privatepreview --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-02-14-privatepreview' && $(go)
rpname: postgresql
namespace: postgresqlflexibleservers
output-folder: $(go-sdk-folder)/services/preview/$(rpname)/mgmt/2020-02-14-preview/$(namespace)
```

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

These settings apply only when `--tag=package-2020-01-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-01' && $(go)
namespace: postgresql
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-01-01/$(namespace)
```

Expand All @@ -33,6 +45,7 @@ These settings apply only when `--tag=package-2017-12-01-preview --go` is specif
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2017-12-01-preview' && $(go)
namespace: postgresql
output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-12-01-preview/$(namespace)
```

Expand All @@ -42,5 +55,6 @@ These settings apply only when `--tag=package-2017-12-01 --go` is specified on t
Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.

``` yaml $(tag) == 'package-2017-12-01' && $(go)
namespace: postgresql
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2017-12-01/$(namespace)
```
26 changes: 1 addition & 25 deletions specification/postgresql/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,33 +158,9 @@ csharp:
clear-output-folder: true
```


## 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)
python-mode: create
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: azure.mgmt.rdbms.postgresql
package-name: azure-mgmt-rdbms
clear-output-folder: true
```
``` yaml $(python) && $(python-mode) == 'update'
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql
```
``` yaml $(python) && $(python-mode) == 'create'
python:
basic-setup-py: true
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms
```
See configuration in [readme.python.md](./readme.python.md)

## Go

Expand Down
67 changes: 67 additions & 0 deletions specification/postgresql/resource-manager/readme.python.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
## 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 !$(track2)
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
package-name: azure-mgmt-rdbms
clear-output-folder: true
no-namespace-folders: true
```

These settings apply only when `--track2` is specified on the command line.

``` yaml $(track2)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-rdbms
no-namespace-folders: true
```

### Python multi-api

Generate all API versions currently shipped for this package

```yaml !$(track2)
batch:
- tag: package-2020-01-01
- tag: package-2020-02-14-privatepreview
```

```yaml $(track2)
clear-output-folder: true
batch:
- tag: package-2020-01-01
- tag: package-2020-02-14-privatepreview
```

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

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

### Tag: package-2020-02-14-privatepreview and python

These settings apply only when `--tag=package-2020-02-14-privatepreview --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-02-14-privatepreview' && $(python)
namespace: azure.mgmt.rdbms.postgresql_flexibleservers
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers
python:
namespace: azure.mgmt.rdbms.postgresql_flexibleservers
output-folder: $(python-sdks-folder)/rdbms/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql_flexibleservers
```