Skip to content

Commit 55075d0

Browse files
committed
Updates readme
1 parent 9246d62 commit 55075d0

File tree

1 file changed

+37
-12
lines changed

1 file changed

+37
-12
lines changed

specification/web/resource-manager/readme.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@
44
55
This is the AutoRest configuration file for Web.
66

7-
87
The App service RP comprises of services where each service has its own tag.
98
Hence, each sub-service has its own swagger spec.
109

1110
All of them are tied together using this configuration and are packaged together into one compute client library.
1211
This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service.
1312

14-
1513
---
14+
1615
## Getting Started
16+
1717
To build the SDK for Web, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run:
1818

1919
> `autorest`
2020
2121
To see additional help and options, run:
2222

2323
> `autorest --help`
24+
2425
---
2526

2627
## Configuration
2728

28-
29-
3029
### Basic Information
30+
3131
These are the global settings for the Web API.
3232

3333
``` yaml
3434
title: WebSiteManagementClient
3535
description: WebSite Management Client
3636
openapi-type: arm
37-
tag: package-2020-12
37+
tag: package-2021-01
3838
```
3939
4040
### Suppression
@@ -55,9 +55,32 @@ directive:
5555
reason: Model type is not an Azure resource
5656
```
5757
58+
59+
### Tag: package-2021-01
60+
61+
These settings apply only when `--tag=package-2021-01` is specified on the command line.
62+
63+
```yaml $(tag) == 'package-2021-01'
64+
input-file:
65+
- Microsoft.Web/stable/2021-01-01/AppServiceEnvironments.json
66+
- Microsoft.Web/stable/2021-01-01/AppServicePlans.json
67+
- Microsoft.Web/stable/2021-01-01/Certificates.json
68+
- Microsoft.Web/stable/2021-01-01/CommonDefinitions.json
69+
- Microsoft.Web/stable/2021-01-01/DeletedWebApps.json
70+
- Microsoft.Web/stable/2021-01-01/Diagnostics.json
71+
- Microsoft.Web/stable/2021-01-01/Global.json
72+
- Microsoft.Web/stable/2021-01-01/Provider.json
73+
- Microsoft.Web/stable/2021-01-01/Recommendations.json
74+
- Microsoft.Web/stable/2021-01-01/ResourceHealthMetadata.json
75+
- Microsoft.Web/stable/2021-01-01/ResourceProvider.json
76+
- Microsoft.Web/stable/2021-01-01/StaticSites.json
77+
- Microsoft.Web/stable/2021-01-01/WebApps.json
78+
```
5879
### Tag: package-2020-12
80+
5981
These settings apply only when `--tag=package-2020-12` or `--tag=package-2020-12-only` is specified on the command line.
6082
NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included.
83+
6184
``` yaml $(tag) == 'package-2020-12' || $(tag) == 'package-2020-12-only'
6285
input-file:
6386
- Microsoft.CertificateRegistration/stable/2020-12-01/AppServiceCertificateOrders.json
@@ -150,8 +173,10 @@ directive:
150173
```
151174

152175
### Tag: package-2020-10
176+
153177
These settings apply only when `--tag=package-2020-10` or `--tag=package-2020-10-only` is specified on the command line.
154178
NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included.
179+
155180
``` yaml $(tag) == 'package-2020-10' || $(tag) == 'package-2020-10-only'
156181
input-file:
157182
- Microsoft.CertificateRegistration/stable/2020-10-01/AppServiceCertificateOrders.json
@@ -188,8 +213,10 @@ directive:
188213
```
189214

190215
### Tag: package-2020-09
216+
191217
These settings apply only when `--tag=package-2020-09` or `--tag=package-2020-09-only` is specified on the command line.
192218
NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2020-06-01 are included.
219+
193220
``` yaml $(tag) == 'package-2020-09' || $(tag) == 'package-2020-09-only'
194221
input-file:
195222
- Microsoft.CertificateRegistration/stable/2020-09-01/AppServiceCertificateOrders.json
@@ -230,9 +257,11 @@ directive:
230257
```
231258

232259
### Tag: package-2020-06
260+
233261
These settings apply only when `--tag=package-2020-06` or `--tag=package-2020-06-only` is specified on the command line.
234262
NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2019-08-01 are included.
235-
``` yaml $(tag) == 'package-2020-06' || $(tag) == 'package-2020-06-only'
263+
264+
``` yaml $(tag) == 'package-2020-06' || $(tag) == 'package-2020-06-only'
236265
input-file:
237266
- Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json
238267
- Microsoft.CertificateRegistration/stable/2020-06-01/CertificateRegistrationProvider.json
@@ -264,7 +293,7 @@ directive:
264293
These settings apply only when `--tag=package-2019-08` or `--tag=package-2019-08-only` is specified on the command line.
265294
NOTE: Currently these tags are the same, but it will need to be split if any files from folders other than 2019-08-01 are included.
266295

267-
``` yaml $(tag) == 'package-2019-08' || $(tag) == 'package-2019-08-only'
296+
``` yaml $(tag) == 'package-2019-08' || $(tag) == 'package-2019-08-only'
268297
269298
input-file:
270299
- Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json
@@ -1237,8 +1266,8 @@ input-file:
12371266
```
12381267

12391268
---
1240-
# Code Generation
12411269

1270+
# Code Generation
12421271

12431272
## Swagger to SDK
12441273

@@ -1273,7 +1302,6 @@ See configuration in [readme.go.md](./readme.go.md)
12731302

12741303
See configuration in [readme.python.md](./readme.python.md)
12751304

1276-
12771305
## Java
12781306

12791307
See configuration in [readme.java.md](./readme.java.md)
@@ -1327,6 +1355,3 @@ input-file:
13271355
- Microsoft.Web/stable/2018-02-01/ResourceProvider.json
13281356
- Microsoft.Web/stable/2018-02-01/Recommendations.json
13291357
```
1330-
1331-
1332-

0 commit comments

Comments
 (0)