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

task1212475-addtrack2 #10860

Merged
merged 42 commits into from
Nov 3, 2020
Merged
Show file tree
Hide file tree
Changes from 40 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
da01d4c
Update for test
Nov 12, 2019
9e855ba
Merge pull request #8 from Azure/master
JackTn Sep 21, 2020
08af3f0
Create readme.azureresourceschema.md
JackTn Sep 21, 2020
affb5f1
Create readme.azureresourceschema.md
JackTn Sep 21, 2020
cf061bb
Update readme.chsarp.md
JackTn Sep 21, 2020
e86efe8
Update readme.typescript.md
JackTn Sep 21, 2020
90941aa
Update readme.ruby.md
JackTn Sep 21, 2020
0f8950e
Update readme.go.md
JackTn Sep 21, 2020
4398fa0
Update readme.python.md
JackTn Sep 21, 2020
4f0c4ad
Update samplereadme.md
JackTn Sep 21, 2020
4c4c512
Merge pull request #9 from JackTn/1212475-addazureresourceschema
JackTn Sep 21, 2020
509cbc5
Update readme.chsarp.md
JackTn Sep 21, 2020
169db53
Update samplereadme.md
JackTn Sep 21, 2020
4c8bce3
Update readme.chsarp.md
JackTn Sep 21, 2020
d3918b7
Update readme.python.md
JackTn Sep 21, 2020
0920cee
Update readme.go.md
JackTn Sep 21, 2020
b2f0bd8
Update readme.ruby.md
JackTn Sep 21, 2020
5a8a71b
Update readme.typescript.md
JackTn Sep 21, 2020
fef885f
Update samplereadme.md
JackTn Sep 21, 2020
36bc60c
Update readme.python.md
JackTn Sep 21, 2020
a9b26ac
Merge branch 'master' into patch-3
JackTn Sep 22, 2020
18f08ee
Revert "Merge branch 'master' into patch-3"
JackTn Sep 24, 2020
26f77dc
Merge pull request #12 from JackTn/pr/10860
JackTn Sep 24, 2020
793d65a
Merge branch 'master' into patch-3
JackTn Sep 24, 2020
edaa233
Update readme.azureresourceschema.md
JackTn Sep 24, 2020
c39635f
Update samplereadme.md
JackTn Sep 24, 2020
2bff1e4
Update readme.go.md
JackTn Sep 24, 2020
4b22541
Update readme.go.md
JackTn Sep 24, 2020
297ba9d
Update readme.go.md
JackTn Sep 24, 2020
c930e69
Update readme.azureresourceschema.md
JackTn Sep 24, 2020
fab6ae2
Update samplereadme.md
JackTn Sep 24, 2020
62067c5
Update samplereadme.md
JackTn Sep 24, 2020
31d3d4c
Update readme.python.md
JackTn Sep 27, 2020
22e8faf
Update readme.azureresourceschema.md
JackTn Sep 27, 2020
1f719d2
Update readme.go.md
JackTn Sep 27, 2020
734cd85
Update documentation/samplefiles/readme.go.md
leniatgh Sep 27, 2020
90d3ff5
Update readme.typescript.md
JackTn Sep 28, 2020
b2fdfb1
Delete readme.ruby.md
JackTn Sep 28, 2020
431874b
Update readme.go.md
JackTn Sep 30, 2020
023e70c
Update readme.typescript.md
JackTn Oct 23, 2020
0fb0fa4
Rename readme.chsarp.md to readme.csharp.md
JackTn Oct 23, 2020
cc20458
Update samplereadme.md
JackTn Oct 26, 2020
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
11 changes: 5 additions & 6 deletions documentation/samplefiles/readme.azureresourceschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,18 @@ These settings apply only when `--azureresourceschema` is specified on the comma

``` yaml $(azureresourceschema) && $(multiapi)
batch:
- tag: schema-yourservicename-YYYY-MM-DD

- tag: schema-[[ServiceName]]-[[Version]]
```

Please also specify `--azureresourceschema-folder=<path to the root directory of your azure-resource-manager-schemas clone>`.

### Tag: schema-yourservicename-YYYY-MM-DD and azureresourceschema
### Tag: schema-[[ServiceName]]-[[Version]] and azureresourceschema

``` yaml $(tag) == 'schema-yourservicename-YYYY-MM-DD' && $(azureresourceschema)
``` yaml $(tag) == 'schema-[[ServiceName]]-[[Version]]' && $(azureresourceschema)
output-folder: $(azureresourceschema-folder)/schemas

# all the input files in this apiVersion
input-file:
- Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json

- [[ResourceProviderName]]/[[ReleaseState]]/[[Version]]/[[ServiceName]].json
```
4 changes: 2 additions & 2 deletions documentation/samplefiles/readme.chsarp.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ csharp:
payload-flattening-threshold: 1
clear-output-folder: true
client-side-validation: false
namespace: Microsoft.YourServiceName
output-folder: $(csharp-sdks-folder)/YourServiceName/management/Microsoft.YourServiceName/GeneratedProtocol
namespace: [[ResourceProviderName]]
output-folder: $(csharp-sdks-folder)/[[ServiceName]]/management/[[ResourceProviderName]]/GeneratedProtocol
```
32 changes: 6 additions & 26 deletions documentation/samplefiles/readme.go.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,22 @@ These settings apply only when `--go` is specified on the command line.
```yaml $(go)
go:
license-header: MICROSOFT_APACHE_NO_VERSION
namespace: [[ServiceName]]
clear-output-folder: true
```

### Go multi-api

``` yaml $(go) && $(multiapi)
batch:
- tag: package-2019-12-01
- tag: package-2020-07-01-preview
# add every tag listed below
- tag: package-[[Version]][[-ReleaseState]]
```

### Tag: package-2019-12-01 and go
### Tag: package-[[Version]][[-ReleaseState]] and go

These settings apply only when `--tag=package-2019-12-01 --go` is specified on the command line.
These settings apply only when `--tag=package-[[Version]][[-ReleaseState]] --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-2019-12-01' && $(go)
# NOTE: a stable tag must not contain any preview swagger files included
# NOTE: go namespace can only consist of lower case letters, numbers and underscores
namespace: yourservicename
# NOTE: for special cases, you can hard code the namespace in the output-folder
# NOTE: the output-folder of a stable tag must not be under the preview subdirectory
output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-12-01/$(namespace)
```

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

These settings apply only when `--tag=package-2020-07-01-preview --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-preview' && $(go)
# NOTE: a preview tag must not contain at least one preview swagger file included
# NOTE: go namespace can only consist of lower case letters, numbers and underscores
namespace: yourservicename
# NOTE: a preview api-version must be under the preview sub-directory
# NOTE: the output-folder of a preview tag must be under the preview subdirectory
output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-07-01-preview/$(namespace)
```yaml $(tag) == 'package-[[Version]][[-ReleaseState]]' && $(go)
output-folder: $(go-sdk-folder)/services[[/ReleaseState]]/$(namespace)/mgmt/[[Version]]/$(namespace)
```
25 changes: 12 additions & 13 deletions documentation/samplefiles/readme.python.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,18 @@
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>`.

```yaml $(python)
python:
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
payload-flattening-threshold: 2
namespace: Microsoft.YourServiceName
package-name: YourServiceName
package-version: 2019-12-01
clear-output-folder: true
``` yaml $(python)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-[[ServiceName]]
no-namespace-folders: true
package-version: 1.0.0b1
```

```yaml $(python)
python:
no-namespace-folders: true
output-folder: $(python-sdks-folder)/azure-mgmt/YourServiceName
``` yaml $(python-mode) == 'update'
output-folder: $(python-sdks-folder)/[[ServiceName]]/azure-mgmt-[[ServiceName]]/azure/mgmt/[[ServiceName]]
```
``` yaml $(python-mode) == 'create'
basic-setup-py: true
output-folder: $(python-sdks-folder)/[[ServiceName]]/azure-mgmt-[[ServiceName]]
```
19 changes: 0 additions & 19 deletions documentation/samplefiles/readme.ruby.md

This file was deleted.

7 changes: 4 additions & 3 deletions documentation/samplefiles/readme.typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
These settings apply only when `--typescript` is specified on the command line.
Please also specify `--typescript-sdks-folder=<path to root folder of your azure-sdk-for-js clone>`.

```yaml $(typescript)
``` yaml $(typescript)
typescript:
azure-arm: true
package-name: "YourServiceName"
output-folder: "$(typescript-sdks-folder)/packages/YourServiceName"
package-name: "@azure/arm-[[ServiceName]]"
output-folder: "$(typescript-sdks-folder)/sdk/[[ServiceName]]/arm-[[ServiceName]]"
payload-flattening-threshold: 1
clear-output-folder: true
generate-metadata: true
```
22 changes: 11 additions & 11 deletions documentation/samplefiles/samplereadme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# YourServiceName
# [[ServiceName]]

> see https://aka.ms/autorest

This is the AutoRest configuration file for YourServiceName.
This is the AutoRest configuration file for [[ServiceName]].

## Getting Started

Expand All @@ -22,20 +22,20 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor

### Basic Information

These are the global settings for the YourServiceName.
These are the global settings for the [[ServiceName]].

```yaml
openapi-type: arm
tag: package-YYYY-MM-DD
openapi-type: [[OpenApiType]]
tag: package-[[Version]]
```

### Tag: package-YYYY-MM-DD
### Tag: package-[[Version]]

These settings apply only when `--tag=package-YYYY-MM-DD` is specified on the command line.
These settings apply only when `--tag=package-[[Version]]` is specified on the command line.

```yaml $(tag) == 'package-YYYY-MM-DD'
```yaml $(tag) == 'package-[[Version]]'
input-file:
- Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json
- [[ResourceProviderName]]/[[ReleaseState]]/[[Version]]/[[ServiceName]].json
```

---
Expand All @@ -55,10 +55,10 @@ swagger-to-sdk:
- repo: azure-sdk-for-js
- repo: azure-sdk-for-ruby
after_scripts:
- bundle install && rake arm:regen_all_profiles['azure_mgmt_YourServiceName']
- bundle install && rake arm:regen_all_profiles['azure_mgmt_[[ServiceName]]']
- repo: azure-resource-manager-schemas
after_scripts:
- node sdkauto_afterscript.js yourservicename/resource-manager
- node sdkauto_afterscript.js [[ServiceName]]/resource-manager
```

## Go
Expand Down