Skip to content

Commit bb4817d

Browse files
jianyexianandanthony
authored andcommitted
Update ci-fix.md (Azure#21443)
1 parent ac741e7 commit bb4817d

File tree

1 file changed

+2
-24
lines changed

1 file changed

+2
-24
lines changed

documentation/ci-fix.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ npm install -g autorest
7979

8080
#### Given a swagger spec, run linter:
8181
```
82-
autorest --validation --azure-validator --use=@microsoft.azure/classic-openapi-validator@latest --use=@microsoft.azure/openapi-validator@latest --input-file=<path-to-spec>
82+
autorest --v3 --spectral --validation --azure-validator --use=@microsoft.azure/openapi-validator@latest --input-file=<path-to-spec>
8383
```
8484
#### Given a readme file, run linter:
8585
```
86-
autorest --validation --azure-validator --use=@microsoft.azure/classic-openapi-validator@latest --use=@microsoft.azure/openapi-validator@latest [--tag=<readme tag>] <path-to-readme>
86+
autorest --v3 --spectral --validation --azure-validator --use=@microsoft.azure/openapi-validator@latest [--tag=<readme tag>] <path-to-readme>
8787
```
8888

8989
Please see [readme](https://github.com/Azure/azure-openapi-validator/blob/main/README.md) for how to install or run tool in details.
@@ -129,28 +129,6 @@ Note: Currently only applicable to management plane APIs, and target ARM region
129129

130130
To fix the check, download the artifact `api_scenario_test_output` from Azure pipeline where you can find the report.html and auto generated API Scenario file as baseline, then refer to [API Scenario documentation](./api-scenario/readme.md) to run and debug it locally. After local debug, commit the API Scenario file and `readme.test.md` file into your working branch and then the CI check will use the committed API Scenario file to re-run the test.
131131

132-
## SDK Track2 Validation
133-
134-
This CI check is to run [autorest.modelerfour](https://github.com/Azure/autorest.modelerfour) for each changing tag in a PR.
135-
Since the code generators of track2 SDK are based on the autorest.modelerfour, it's recommended ensure this validation is passed without any error and warning.
136-
The `modelerfour` has several plugins. If a plugin report an error, you can refer to the following plugin documentations:
137-
- [PreChecker](https://github.com/Azure/autorest/blob/main/docs/openapi/prechecker.md)
138-
139-
### Run locally:
140-
141-
#### Prerequisites:
142-
143-
```
144-
npm install -g autorest
145-
```
146-
#### Given a swagger spec, run the validator:
147-
```
148-
autorest --v3 --azure-validator --use=@microsoft.azure/openapi-validator@latest --input-file=<path-to-spec>
149-
```
150-
#### Given a readme file, run the validator:
151-
```
152-
autorest --v3 --azure-validator --semantic-validator=false --model-validator=false --use=@microsoft.azure/openapi-validator@latest [--tag=<readme tag>] <path-to-readme>
153-
```
154132

155133
## Cadl Validation
156134

0 commit comments

Comments
 (0)