Skip to content

Commit 0016a58

Browse files
committed
Updated and aligned README.md
1 parent a01f8b3 commit 0016a58

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

schemas/v3.0/README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,29 @@
1-
OpenAPI 3.0.X JSON Schema
2-
---
1+
# OpenAPI 3.0.X JSON Schema
32

4-
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.0.X.
3+
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.0.x.
54

6-
As a reminder, the JSON Schema is not the source of truth for the Specification. In cases of conflicts between the Specification itself and the JSON Schema, the Specification wins. Also, some Specification constraints cannot be represented with the JSON Schema so it's highly recommended to employ other methods to ensure compliance.
5+
As a reminder, the JSON Schema is not the source of truth for the Specification.
6+
In cases of conflicts between the Specification itself and the JSON Schema, the
7+
Specification wins. Also, some Specification constraints cannot be represented
8+
with the JSON Schema so it's highly recommended to employ other methods to
9+
ensure compliance.
710

8-
The iteration version of the JSON Schema can be found in the `id` field. For example, the value of `id: https://spec.openapis.org/oas/3.0/schema/2019-04-02` means this iteration was created on April 2nd, 2019.
11+
The iteration version of the JSON Schema can be found in the `id` field.
12+
For example, the value of `id: https://spec.openapis.org/oas/3.0/schema/2019-04-02` means this iteration was created on April 2nd, 2019.
913

10-
To submit improvements to the schema, modify the schema.yaml file only.
14+
To submit improvements to the schema, modify the `schema.yaml` file only.
1115

1216
The TSC will then:
1317
- Run tests on the updated schema
1418
- Update the iteration version
15-
- Convert the schema.yaml to schema.json
19+
- Convert the `schema.yaml` to `schema.json`
1620
- Publish the new version
21+
22+
## Tests
23+
24+
The test suite is part of this package.
25+
26+
```bash
27+
npm install
28+
npm test
29+
```

schemas/v3.1/README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,36 @@
11
# OpenAPI 3.1.X JSON Schema
22

3-
Here you can find the JSON Schema for validating OpenAPI definitions of versions
4-
3.1.X.
3+
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.1.x.
54

65
As a reminder, the JSON Schema is not the source of truth for the Specification.
76
In cases of conflicts between the Specification itself and the JSON Schema, the
87
Specification wins. Also, some Specification constraints cannot be represented
98
with the JSON Schema so it's highly recommended to employ other methods to
109
ensure compliance.
1110

12-
The iteration version of the JSON Schema can be found in the `$id` field. For
13-
example, the value of `$id: https://spec.openapis.org/oas/3.1/schema/2021-03-02`
14-
means this iteration was created on March 2nd, 2021.
11+
The iteration version of the JSON Schema can be found in the `$id` field.
12+
For example, the value of `$id: https://spec.openapis.org/oas/3.1/schema/2021-03-02` means this iteration was created on March 2nd, 2021.
1513

1614
The `schema.yaml` schema doesn't validate the JSON Schemas in your OpenAPI
1715
document because 3.1 allows you to use any JSON Schema dialect you choose. We
1816
have also included `schema-base.yaml` that extends the main schema to validate
1917
that all schemas use the default OAS base vocabulary.
2018

2119
## Contributing
22-
To submit improvements to the schema, modify the schema.yaml file only.
20+
21+
To submit improvements to the schema, modify the `schema.yaml` file only.
2322

2423
The TSC will then:
2524
- Run tests on the updated schema
2625
- Update the iteration version
27-
- Convert the schema.yaml to schema.json
26+
- Convert the `schema.yaml` to `schema.json`
2827
- Publish the new version
2928

3029
## Tests
31-
The test suite is included as a git submodule of https://github.com/Mermade/openapi3-examples.
32-
33-
```bash
34-
npx mocha --recursive tests
35-
```
3630

37-
You can also validate a document individually.
31+
The test suite is part of this package.
3832

3933
```bash
40-
scripts/validate.js path/to/document/to/validate.yaml
34+
npm install
35+
npm test
4136
```

0 commit comments

Comments
 (0)