openapi3: reference originating locations in YAML specs - step 1#1007
Merged
fenollp merged 46 commits intogetkin:masterfrom Oct 21, 2024
oasdiff:master
Merged
openapi3: reference originating locations in YAML specs - step 1#1007fenollp merged 46 commits intogetkin:masterfrom oasdiff:master
fenollp merged 46 commits intogetkin:masterfrom
oasdiff:master
Conversation
fenollp
requested changes
Oct 8, 2024
Collaborator
fenollp
left a comment
There was a problem hiding this comment.
A few minor edits otherwise LGTM
* Add github.com/pb33f/libopenapi it looks like a reasonable alternative * Update README.md --------- Co-authored-by: Pierre Fenoll <pierrefenoll@gmail.com>
* fix: issue unmarshalling when discriminator field is set in openapi2.0 * revert original approach * update with different approach * Revert "update with different approach" This reverts commit 2db2b39. * v2 schema with discriminator field set as string * update ref link and comment * run docs.sh
fenollp
approved these changes
Oct 21, 2024
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
7 participants
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.
This PR adds the ability to correlate OpenAPI components with the location in the originating YAML spec.
Here's a summary of the changes required to achieve this:
UnmarshalWithOrigin(see https://github.com/oasdiff/yaml)Originstruct to OpenAPI components. This requires changes to the UnmarshalJSON functions and, in some cases, replacing native types, likemap[string]string, by dedicated types that include the original native type and an Origin member.This PR addresses issue #986
Follow up tasks to be addressed by future PRs:
originto more elements, namelyComponentsand some types that are unmarshalled withunmarshalStringMapPorunmarshalStringMapreplacedirectives from go.modoriginto include end line and column and YAML comments as proposed by @fenollp