Skip to content

Commit b4394cb

Browse files
authored
docs(parser-adapter-openapi-json-3-0): adapt to OpenAPI 3.0.4 support (#4619)
Refs #4612
1 parent b92891e commit b4394cb

File tree

1 file changed

+6
-4
lines changed
  • packages/apidom-parser-adapter-openapi-json-3-0

1 file changed

+6
-4
lines changed

packages/apidom-parser-adapter-openapi-json-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-json-3-0
22

3-
`@swagger-api/apidom-parser-adapter-openapi-json-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 [JSON format](https://www.json.org/json-en.html).
3+
`@swagger-api/apidom-parser-adapter-openapi-json-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 [JSON format](https://www.json.org/json-en.html).
44
Under the hood this adapter uses [apidom-parser-adapter-json](https://github.com/swagger-api/apidom/tree/main/packages/apidom-parser-adapter-json)
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+json;version=3.0.2',
3434
'application/vnd.oai.openapi;version=3.0.3',
3535
'application/vnd.oai.openapi+json;version=3.0.3',
36+
'application/vnd.oai.openapi;version=3.0.4',
37+
'application/vnd.oai.openapi+json;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-json-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.3"}', { 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(openApiJsonAdapter);
9092

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

0 commit comments

Comments
 (0)