Conversation
There was a problem hiding this comment.
Pull request overview
Adds retrievalURI metadata to Arazzo “source-description” parse/dereference results so consumers can identify the normalized, resolved URI a source description was fetched/dereferenced from.
Changes:
- Set
meta.retrievalURIon source-descriptionParseResultElements in both parse and dereference flows. - Add/extend tests to assert
retrievalURIis present for JSON/YAML parsing and dereferencing. - Update README and JSDoc to document/access the new
retrievalURImetadata.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/apidom-reference/src/parse/parsers/arazzo-json-1/source-descriptions.ts | Sets retrievalURI meta on source-description parse results; updates JSDoc to mention it. |
| packages/apidom-reference/src/dereference/strategies/arazzo-1/source-descriptions.ts | Sets retrievalURI meta on source-description dereference results; updates JSDoc to mention it. |
| packages/apidom-reference/test/parse/parsers/arazzo-json-1/index.ts | Adds assertion that source-description parse result contains retrievalURI. |
| packages/apidom-reference/test/parse/parsers/arazzo-yaml-1/index.ts | Adds assertion that YAML source-description parse result contains retrievalURI. |
| packages/apidom-reference/test/parse/parsers/arazzo-json-1/source-descriptions.ts | Adds low-level API test asserting retrievalURI is set. |
| packages/apidom-reference/test/dereference/strategies/arazzo-1/source-descriptions/index.ts | Adds dereference test asserting retrievalURI is set. |
| packages/apidom-reference/README.md | Documents retrievalURI access in examples (currently missing toValue import in snippets). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/apidom-reference/src/parse/parsers/arazzo-json-1/source-descriptions.ts
Outdated
Show resolved
Hide resolved
packages/apidom-reference/src/dereference/strategies/arazzo-1/source-descriptions.ts
Outdated
Show resolved
Hide resolved
packages/apidom-reference/test/parse/parsers/arazzo-json-1/source-descriptions.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/apidom-reference/src/parse/parsers/arazzo-json-1/source-descriptions.ts
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.