@speclynx/apidom-parser-adapter-overlay-yaml-1 5.2.6 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,20 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [6.0.1](https://github.com/speclynx/apidom/compare/v6.0.0...v6.0.1) (2026-10-15)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @speclynx/apidom-parser-adapter-overlay-yaml-1
|
|
9
|
+
|
|
10
|
+
# [6.0.0](https://github.com/speclynx/apidom/compare/v5.2.7...v6.0.0) (2026-10-15)
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
- **parser-adapter-overlay-yaml-1:** support Overlay 1.2.0 ([b5f3072](https://github.com/speclynx/apidom/commit/b5f30722995bb3dabf2445f789242f7a70ff8df0))
|
|
15
|
+
|
|
16
|
+
## [5.2.7](https://github.com/speclynx/apidom/compare/v5.2.6...v5.2.7) (2026-10-13)
|
|
17
|
+
|
|
18
|
+
**Note:** Version bump only for package @speclynx/apidom-parser-adapter-overlay-yaml-1
|
|
19
|
+
|
|
6
20
|
## [5.2.6](https://github.com/speclynx/apidom/compare/v5.2.5...v5.2.6) (2026-09-19)
|
|
7
21
|
|
|
8
22
|
**Note:** Version bump only for package @speclynx/apidom-parser-adapter-overlay-yaml-1
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @speclynx/apidom-parser-adapter-overlay-yaml-1
|
|
2
2
|
|
|
3
|
-
`@speclynx/apidom-parser-adapter-overlay-yaml-1` is a parser adapter for the [Overlay 1.
|
|
3
|
+
`@speclynx/apidom-parser-adapter-overlay-yaml-1` is a parser adapter for the [Overlay 1.x.y specification](https://spec.openapis.org/overlay/v1.2.0.html) in [YAML format](https://yaml.org/spec/1.2/spec.html).
|
|
4
4
|
Under the hood this adapter uses [apidom-parser-adapter-yaml-1-2](https://github.com/speclynx/apidom/tree/main/packages/apidom-parser-adapter-yaml-1-2)
|
|
5
5
|
to parse a source string into generic ApiDOM in [base ApiDOM namespace](https://github.com/speclynx/apidom/tree/main/packages/apidom#base-namespace)
|
|
6
6
|
which is then refracted with [Overlay 1.x.y Refractors](https://github.com/speclynx/apidom/tree/main/packages/apidom-ns-overlay-1#refractors).
|
|
@@ -28,16 +28,18 @@ Defines list of media types that this parser adapter recognizes.
|
|
|
28
28
|
'application/vnd.oai.overlay+yaml;version=1.0.0',
|
|
29
29
|
'application/vnd.oai.overlay;version=1.1.0',
|
|
30
30
|
'application/vnd.oai.overlay+yaml;version=1.1.0',
|
|
31
|
+
'application/vnd.oai.overlay;version=1.2.0',
|
|
32
|
+
'application/vnd.oai.overlay+yaml;version=1.2.0',
|
|
31
33
|
]
|
|
32
34
|
```
|
|
33
35
|
|
|
34
36
|
### detect
|
|
35
37
|
|
|
36
|
-
[Detection](https://github.com/speclynx/apidom/blob/main/packages/apidom-parser-adapter-overlay-yaml-1/src/adapter.ts#L13) is based on a regular expression matching required Overlay 1.
|
|
38
|
+
[Detection](https://github.com/speclynx/apidom/blob/main/packages/apidom-parser-adapter-overlay-yaml-1/src/adapter.ts#L13) is based on a regular expression matching required Overlay 1.x.y specification symbols in YAML format.
|
|
37
39
|
|
|
38
40
|
### namespace
|
|
39
41
|
|
|
40
|
-
This adapter exposes an instance of [Overlay 1.x.y ApiDOM namespace](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-overlay-1/README.md#overlay-
|
|
42
|
+
This adapter exposes an instance of [Overlay 1.x.y ApiDOM namespace](https://github.com/speclynx/apidom/blob/main/packages/apidom-ns-overlay-1/README.md#overlay-120-namespace).
|
|
41
43
|
|
|
42
44
|
### parse
|
|
43
45
|
|
|
@@ -64,11 +66,11 @@ with [supported media types](#mediatypes).
|
|
|
64
66
|
import { parse, detect } from '@speclynx/apidom-parser-adapter-overlay-yaml-1';
|
|
65
67
|
|
|
66
68
|
// detecting
|
|
67
|
-
await detect('overlay: 1.
|
|
69
|
+
await detect('overlay: 1.2.0'); // => true
|
|
68
70
|
await detect('test'); // => false
|
|
69
71
|
|
|
70
72
|
// parsing
|
|
71
|
-
const parseResult = await parse('overlay: 1.
|
|
73
|
+
const parseResult = await parse('overlay: 1.2.0', { sourceMap: true });
|
|
72
74
|
```
|
|
73
75
|
|
|
74
76
|
### Indirect usage
|
|
@@ -83,5 +85,5 @@ const parser = new ApiDOMParser();
|
|
|
83
85
|
|
|
84
86
|
parser.use(overlayYamlAdapter);
|
|
85
87
|
|
|
86
|
-
const parseResult = await parser.parse('overlay: 1.
|
|
88
|
+
const parseResult = await parser.parse('overlay: 1.2.0', { mediaType: overlayYamlAdapter.mediaTypes.latest('yaml') });
|
|
87
89
|
```
|