@speclynx/apidom-reference 5.2.1 → 5.2.2
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 +6 -0
- package/README.md +18 -0
- package/dist/apidom-reference.browser.js +1095 -584
- package/dist/apidom-reference.browser.min.js +1 -1
- package/package.json +30 -30
- package/src/dereference/strategies/arazzo-1/source-descriptions.cjs +40 -43
- package/src/dereference/strategies/arazzo-1/source-descriptions.mjs +41 -44
- package/src/dereference/strategies/arazzo-1/util.cjs +47 -2
- package/src/dereference/strategies/arazzo-1/util.mjs +43 -1
- package/src/parse/parsers/arazzo-json-1/source-descriptions.cjs +38 -42
- package/src/parse/parsers/arazzo-json-1/source-descriptions.mjs +39 -43
- package/types/dereference/strategies/arazzo-1/source-descriptions.d.ts +7 -0
- package/types/dereference/strategies/arazzo-1/util.d.ts +12 -1
- package/types/parse/parsers/arazzo-json-1/source-descriptions.d.ts +7 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
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
|
+
## [5.2.2](https://github.com/speclynx/apidom/compare/v5.2.1...v5.2.2) (2026-09-03)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
- **reference:** distinguish shared source descriptions from cycles ([#518](https://github.com/speclynx/apidom/issues/518)) ([b66bac4](https://github.com/speclynx/apidom/commit/b66bac4f5f8f91f5cc1010fb8dd12aed399d5dfa)), closes [usearazzo/arazzo-toolkit#139](https://github.com/usearazzo/arazzo-toolkit/issues/139)
|
|
11
|
+
|
|
6
12
|
## [5.2.1](https://github.com/speclynx/apidom/compare/v5.2.0...v5.2.1) (2026-08-29)
|
|
7
13
|
|
|
8
14
|
**Note:** Version bump only for package @speclynx/apidom-reference
|
package/README.md
CHANGED
|
@@ -309,6 +309,12 @@ Parser-specific options take precedence over global options.
|
|
|
309
309
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for parsing nested Arazzo source descriptions.
|
|
310
310
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
311
311
|
|
|
312
|
+
A document referenced from more than one place (e.g., one OpenAPI description shared by several Arazzo documents)
|
|
313
|
+
is parsed only once. Every later source description referencing it gets its own `ParseResultElement` with the usual
|
|
314
|
+
metadata, an `'info'` annotation, and a `'parseResult'` meta pointing at the `ParseResultElement` where the document was parsed.
|
|
315
|
+
The `SourceDescriptionElement`'s `'parseResult'` meta points at that same `ParseResultElement`, so the parsed
|
|
316
|
+
document is reachable from every source description that references it.
|
|
317
|
+
|
|
312
318
|
##### Error handling
|
|
313
319
|
|
|
314
320
|
The source descriptions parsing uses annotations instead of throwing errors, allowing parsing to continue
|
|
@@ -465,6 +471,12 @@ Parser-specific options take precedence over global options. See [arazzo-json-1]
|
|
|
465
471
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for parsing nested Arazzo source descriptions.
|
|
466
472
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
467
473
|
|
|
474
|
+
A document referenced from more than one place (e.g., one OpenAPI description shared by several Arazzo documents)
|
|
475
|
+
is parsed only once. Every later source description referencing it gets its own `ParseResultElement` with the usual
|
|
476
|
+
metadata, an `'info'` annotation, and a `'parseResult'` meta pointing at the `ParseResultElement` where the document was parsed.
|
|
477
|
+
The `SourceDescriptionElement`'s `'parseResult'` meta points at that same `ParseResultElement`, so the parsed
|
|
478
|
+
document is reachable from every source description that references it.
|
|
479
|
+
|
|
468
480
|
##### Error handling
|
|
469
481
|
|
|
470
482
|
See [arazzo-json-1 Error handling](#error-handling) - the behavior is identical for both JSON and YAML parsers.
|
|
@@ -2053,6 +2065,12 @@ Strategy-specific options take precedence over global options.
|
|
|
2053
2065
|
- **sourceDescriptionsMaxDepth** - Maximum recursion depth for dereferencing nested Arazzo source descriptions.
|
|
2054
2066
|
Defaults to `+Infinity`. Circular references are automatically detected and skipped.
|
|
2055
2067
|
|
|
2068
|
+
A document referenced from more than one place (e.g., one OpenAPI description shared by several Arazzo documents)
|
|
2069
|
+
is dereferenced only once. Every later source description referencing it gets its own `ParseResultElement` with the usual
|
|
2070
|
+
metadata, an `'info'` annotation, and a `'parseResult'` meta pointing at the `ParseResultElement` where the document was dereferenced.
|
|
2071
|
+
The `SourceDescriptionElement`'s `'parseResult'` meta points at that same `ParseResultElement`, so the dereferenced
|
|
2072
|
+
document is reachable from every source description that references it.
|
|
2073
|
+
|
|
2056
2074
|
###### Error handling
|
|
2057
2075
|
|
|
2058
2076
|
The source descriptions dereferencing uses annotations instead of throwing errors, allowing dereferencing to continue
|