Skip to content

Commit 176cdf1

Browse files
committed
Updates readme
1 parent 27a6e86 commit 176cdf1

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

specification/webpubsub/data-plane/readme.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,35 @@ To see additional help and options, run:
2424

2525
These are the global settings for the Web PubSub Service API.
2626

27-
```yaml
27+
``` yaml
2828
openapi-type: data-plane
29-
tag: package-2022-11-01
29+
tag: package-2023-07
3030
```
3131
3232
### Suppression
3333
34-
```yaml
34+
``` yaml
3535
directive:
3636
- suppress: LROStatusCodesReturnTypeSchema
3737
reason: For this data plane API, it is not a long run operation and the status code indicates the results.
3838
- suppress: XmsExamplesRequired
3939
reason: There are a lot of APIs that does not have the example. While it is being worked upon disabling this to ensure that we catch and fix other violations
4040
```
4141
42+
43+
### Tag: package-2023-07
44+
45+
These settings apply only when `--tag=package-2023-07` is specified on the command line.
46+
47+
```yaml $(tag) == 'package-2023-07'
48+
input-file:
49+
- WebPubSub/stable/2023-07-01/webpubsub.json
50+
```
4251
### Tag: package-2022-11-01
4352

4453
These settings apply only when `--tag=package-2022-11-01` is specified on the command line.
4554

46-
```yaml $(tag) == 'package-2022-11-01'
55+
``` yaml $(tag) == 'package-2022-11-01'
4756
input-file:
4857
- WebPubSub/stable/2022-11-01/webpubsub.json
4958
title: AzureMessagingWebPubSubServiceClient
@@ -53,7 +62,7 @@ title: AzureMessagingWebPubSubServiceClient
5362

5463
These settings apply only when `--tag=package-2021-10-01` is specified on the command line.
5564

56-
```yaml $(tag) == 'package-2021-10-01'
65+
``` yaml $(tag) == 'package-2021-10-01'
5766
input-file:
5867
- WebPubSub/stable/2021-10-01/webpubsub.json
5968
title: AzureMessagingWebPubSubServiceClient
@@ -63,7 +72,7 @@ title: AzureMessagingWebPubSubServiceClient
6372

6473
These settings apply only when `--tag=package-2021-08-01-preview` is specified on the command line.
6574

66-
```yaml $(tag) == 'package-2021-08-01-preview'
75+
``` yaml $(tag) == 'package-2021-08-01-preview'
6776
input-file:
6877
- WebPubSub/preview/2021-08-01-preview/webpubsub.json
6978
title: AzureMessagingWebPubSubServiceClient
@@ -73,7 +82,7 @@ title: AzureMessagingWebPubSubServiceClient
7382

7483
These settings apply only when `--tag=package-2021-05-01-preview` is specified on the command line.
7584

76-
```yaml $(tag) == 'package-2021-05-01-preview'
85+
``` yaml $(tag) == 'package-2021-05-01-preview'
7786
input-file:
7887
- WebPubSub/preview/2021-05-01-preview/webpubsub.json
7988
title: AzureMessagingWebPubSubServiceClient
@@ -86,7 +95,7 @@ title: AzureMessagingWebPubSubServiceClient
8695
This section describes what SDK should be generated by the automatic system.
8796
This is not used by Autorest itself.
8897

89-
```yaml $(swagger-to-sdk)
98+
``` yaml $(swagger-to-sdk)
9099
swagger-to-sdk:
91100
- repo: azure-sdk-for-net-track2
92101
```
@@ -96,7 +105,7 @@ swagger-to-sdk:
96105
These settings apply only when `--csharp` is specified on the command line.
97106
Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`.
98107

99-
```yaml $(csharp)
108+
``` yaml $(csharp)
100109
csharp:
101110
# last generated with AutoRest.0.17.3
102111
azure-arm: false
@@ -112,7 +121,7 @@ These settings apply only when `--python` is specified on the command line.
112121
Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`.
113122
Use `--python-mode=update` if you already have a setup.py and just want to update the code itself.
114123

115-
```yaml $(python)
124+
``` yaml $(python)
116125
python-mode: create
117126
azure-arm: false
118127
license-header: MICROSOFT_MIT_NO_VERSION
@@ -122,12 +131,12 @@ package-version: 1.0.0b1
122131
clear-output-folder: true
123132
```
124133

125-
```yaml $(python) && $(python-mode) == 'update'
134+
``` yaml $(python) && $(python-mode) == 'update'
126135
no-namespace-folders: true
127136
output-folder: $(python-sdks-folder)/webpubsub/azure-messaging-webpubsubservice/azure/messaging/webpubsubservice
128137
```
129138

130-
```yaml $(python) && $(python-mode) == 'create'
139+
``` yaml $(python) && $(python-mode) == 'create'
131140
basic-setup-py: true
132141
output-folder: $(python-sdks-folder)/webpubsub/azure-messaging-webpubsubservice
133142
```
@@ -138,7 +147,7 @@ AutoRest V3 generators require the use of `--tag=all-api-versions` to select api
138147

139148
This block is updated by an automatic script. Edits may be lost!
140149

141-
```yaml $(tag) == 'all-api-versions' /* autogenerated */
150+
``` yaml $(tag) == 'all-api-versions' /* autogenerated */
142151
# include the azure profile definitions from the standard location
143152
require: $(this-folder)/../../../profiles/readme.md
144153
@@ -150,7 +159,7 @@ input-file:
150159
If there are files that should not be in the `all-api-versions` set,
151160
uncomment the `exclude-file` section below and add the file paths.
152161

153-
```yaml $(tag) == 'all-api-versions'
162+
``` yaml $(tag) == 'all-api-versions'
154163
#exclude-file:
155164
# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json
156165
```

0 commit comments

Comments
 (0)