Skip to content

Commit 130cb76

Browse files
committed
docs(README): extend the documentation a bit
1 parent 7e0208c commit 130cb76

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
# ApiDOM Validator GitHub Actions
1+
# ApiDOM Validator GitHub Action
22

3-
This GitHub Actions validates OpenAPI 3.x.y / AsyncAPI 2.x definition file using ApiDOM Language Service.
4-
The validation is exactly the same as the one that https://editor-next.swagger.io/ uses.
3+
This GitHub Actions validates [OpenAPI](https://github.com/OAI/OpenAPI-Specification/tree/main/versions)
4+
3.x.y / [AsyncAPI](https://github.com/OAI/OpenAPI-Specification/tree/main/versions) 2.x definition file
5+
using [ApiDOM Language Service](https://github.com/swagger-api/apidom).
6+
7+
Validation rules are exactly the same as the one that https://editor-next.swagger.io/ uses.
8+
9+
**Supported specifications:**
10+
11+
- OpenAPI 3.0.0
12+
- OpenAPI 3.0.1
13+
- OpenAPI 3.0.2
14+
- OpenAPI 3.0.3
15+
- OpenAPI 3.1.0
16+
- AsyncAPI 2.0.0
17+
- AsyncAPI 2.1.0
18+
- AsyncAPI 2.2.0
19+
- AsyncAPI 2.3.0
20+
- AsyncAPI 2.4.0
21+
- AsyncAPI 2.5.0
22+
- AsyncAPI 2.6.0
523

624
## Inputs
725

@@ -13,7 +31,7 @@ The validation is exactly the same as the one that https://editor-next.swagger.i
1331
## Example usage
1432

1533
```yaml
16-
uses: char0n/apidom-validate@master
34+
uses: char0n/apidom-validate@v1
1735
with:
1836
definition-file: 'path/to/my/openapi.yaml'
1937
```

0 commit comments

Comments
 (0)