docs(parser): remove phantom function from README Public API table#44739
Merged
Conversation
5 tasks
…from parser README Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix phantom function in parser specification
docs(parser): remove phantom function from README Public API table
Jul 10, 2026
pelikhan
approved these changes
Jul 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Removes a non-existent function (LocateJSONPathInYAMLWithAdditionalProperties) from the pkg/parser README’s Public API table so the documentation accurately reflects the actual exported JSON-path helpers in pkg/parser.
Changes:
- Removed the phantom
LocateJSONPathInYAMLWithAdditionalPropertiesrow from the “JSON Path Location” Public API table. - Leaves the table listing only the three exported functions that exist in source:
ExtractJSONPathFromValidationError,LocateJSONPathInYAML, andLocateJSONPathForPathInfo.
Show a summary per file
| File | Description |
|---|---|
| pkg/parser/README.md | Removes a documented-but-nonexistent API entry so the Public API table matches the actual exported functions. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
This was referenced Jul 10, 2026
Contributor
|
🎉 This pull request is included in a new release. Release: |
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
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.
pkg/parser/README.mddocumentedLocateJSONPathInYAMLWithAdditionalProperties(yamlContent, jsonPath, errorMessage string)which does not exist in the source — its functionality was absorbed intoLocateJSONPathForPathInfoduring a past refactor.Changes
pkg/parser/README.md: Remove the phantomLocateJSONPathInYAMLWithAdditionalPropertiesrow from the Public API table. The table now accurately reflects the three exported functions:ExtractJSONPathFromValidationError,LocateJSONPathInYAML, andLocateJSONPathForPathInfo.