Add reference to originating locations in YAML specs - step 1 #1007
Conversation
This file contains 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
reuvenharrison
changed the title
fenollp
requested changes
Oct 8, 2024
Comment on lines
+115
to
+167
| // UnmarshalJSON sets Callbacks to a copy of data. | ||
| func (callbacks *Callbacks) UnmarshalJSON(data []byte) (err error) { | ||
| *callbacks, _, err = unmarshalStringMapP[CallbackRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets Examples to a copy of data. | ||
| func (examples *Examples) UnmarshalJSON(data []byte) (err error) { | ||
| *examples, _, err = unmarshalStringMapP[ExampleRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets Headers to a copy of data. | ||
| func (headers *Headers) UnmarshalJSON(data []byte) (err error) { | ||
| *headers, _, err = unmarshalStringMapP[HeaderRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets Links to a copy of data. | ||
| func (links *Links) UnmarshalJSON(data []byte) (err error) { | ||
| *links, _, err = unmarshalStringMapP[LinkRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets ParametersMap to a copy of data. | ||
| func (parametersMap *ParametersMap) UnmarshalJSON(data []byte) (err error) { | ||
| *parametersMap, _, err = unmarshalStringMapP[ParameterRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets RequestBodies to a copy of data. | ||
| func (requestBodies *RequestBodies) UnmarshalJSON(data []byte) (err error) { | ||
| *requestBodies, _, err = unmarshalStringMapP[RequestBodyRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets ResponseBodies to a copy of data. | ||
| func (responseBodies *ResponseBodies) UnmarshalJSON(data []byte) (err error) { | ||
| *responseBodies, _, err = unmarshalStringMapP[ResponseRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets Schemas to a copy of data. | ||
| func (schemas *Schemas) UnmarshalJSON(data []byte) (err error) { | ||
| *schemas, _, err = unmarshalStringMapP[SchemaRef](data) | ||
| return | ||
| } | ||
|
|
||
| // UnmarshalJSON sets SecuritySchemes to a copy of data. | ||
| func (securitySchemes *SecuritySchemes) UnmarshalJSON(data []byte) (err error) { | ||
| *securitySchemes, _, err = unmarshalStringMapP[SecuritySchemeRef](data) | ||
| return | ||
| } |
There was a problem hiding this comment.
Please define these in their respective files
Comment on lines
-14
to
+15
| Mapping map[string]string `json:"mapping,omitempty" yaml:"mapping,omitempty"` | ||
| PropertyName string `json:"propertyName" yaml:"propertyName"` // required | ||
| Mapping StringMap `json:"mapping,omitempty" yaml:"mapping,omitempty"` |
There was a problem hiding this comment.
Please move the introduction of the StringMap type to another PR, with a breaking change note to README if applicable.
| AuthorizationURL string `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"` | ||
| TokenURL string `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"` | ||
| RefreshURL string `json:"refreshUrl,omitempty" yaml:"refreshUrl,omitempty"` | ||
| Scopes StringMap `json:"scopes" yaml:"scopes"` // required |
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.
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