Skip to content

Commit 1d0b4a5

Browse files
authored
docs(parser-adapter-openapi-yaml-3-0): adapt to OpenAPI 3.0.4 support (#4623)
Refs #4612
1 parent d736090 commit 1d0b4a5

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

packages/apidom-parser-adapter-openapi-yaml-3-0/README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @swagger-api/apidom-parser-adapter-openapi-yaml-3-0
22

3-
`@swagger-api/apidom-parser-adapter-openapi-yaml-3-0` is a parser adapter for the [OpenAPI 3.0.x specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) in [YAML format](https://yaml.org/spec/1.2/spec.html).
3+
`@swagger-api/apidom-parser-adapter-openapi-yaml-3-0` is a parser adapter for the [OpenAPI 3.0.x specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.4.md) in [YAML format](https://yaml.org/spec/1.2/spec.html).
44
Under the hood this adapter uses [apidom-parser-adapter-yaml-1-2](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-yaml-1-2)
55
to parse a source string into generic ApiDOM in [base ApiDOM namespace](https://github.com/swagger-api/apidom/tree/main/packages/apidom#base-namespace)
66
which is then refracted with [OpenAPI 3.0.x Refractors](https://github.com/swagger-api/apidom/tree/main/packages/apidom-ns-openapi-3-0#refractors).
@@ -33,6 +33,8 @@ Defines list of media types that this parser adapter recognizes.
3333
'application/vnd.oai.openapi+yaml;version=3.0.2',
3434
'application/vnd.oai.openapi;version=3.0.3',
3535
'application/vnd.oai.openapi+yaml;version=3.0.3',
36+
'application/vnd.oai.openapi;version=3.0.4',
37+
'application/vnd.oai.openapi+yaml;version=3.0.4',
3638
]
3739
```
3840

@@ -69,11 +71,11 @@ with [supported media types](#mediatypes).
6971
import { parse, detect } from '@swagger-api/apidom-parser-adapter-openapi-yaml-3-0';
7072

7173
// detecting
72-
await detect('openapi: 3.0.3'); // => true
74+
await detect('openapi: 3.0.4'); // => true
7375
await detect('test'); // => false
7476

7577
// parsing
76-
const parseResult = await parse('openapi: 3.0.0', { sourceMap: true });
78+
const parseResult = await parse('openapi: 3.0.4', { sourceMap: true });
7779
```
7880

7981
### Indirect usage
@@ -88,5 +90,5 @@ const parser = new ApiDOMParser();
8890

8991
parser.use(openApiYamlAdapter);
9092

91-
const parseResult = await parser.parse('openapi: 3.0.3', { mediaType: openApiYamlAdapter.mediaTypes.latest('yaml') });
93+
const parseResult = await parser.parse('openapi: 3.0.4', { mediaType: openApiYamlAdapter.mediaTypes.latest('yaml') });
9294
```

packages/apidom-parser-adapter-openapi-yaml-3-0/test/media-types.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,25 +46,25 @@ describe('given adapter is used in parser', function () {
4646
});
4747
});
4848

49-
context('given OpenAPI 3.0.3-rc2 definition in YAML format', function () {
49+
context('given OpenAPI 3.0.0-rc2 definition in YAML format', function () {
5050
specify('should not find appropriate media type', async function () {
51-
const mediaType = await parser.findMediaType('openapi: "3.0.3-rc2"');
51+
const mediaType = await parser.findMediaType('openapi: "3.0.0-rc2"');
5252

5353
assert.strictEqual(mediaType, 'application/octet-stream');
5454
});
5555
});
5656

57-
context('given OpenAPI 3.0.3-rc1 definition in YAML format', function () {
57+
context('given OpenAPI 3.0.0-rc1 definition in YAML format', function () {
5858
specify('should not find appropriate media type', async function () {
59-
const mediaType = await parser.findMediaType('openapi: "3.0.3-rc1"');
59+
const mediaType = await parser.findMediaType('openapi: "3.0.0-rc1"');
6060

6161
assert.strictEqual(mediaType, 'application/octet-stream');
6262
});
6363
});
6464

65-
context('given OpenAPI 3.0.3-rc0 definition in YAML format', function () {
65+
context('given OpenAPI 3.0.0-rc0 definition in YAML format', function () {
6666
specify('should not find appropriate media type', async function () {
67-
const mediaType = await parser.findMediaType('openapi: "3.0.3-rc0"');
67+
const mediaType = await parser.findMediaType('openapi: "3.0.0-rc0"');
6868

6969
assert.strictEqual(mediaType, 'application/octet-stream');
7070
});

0 commit comments

Comments
 (0)