[Example] make sure all versions use the same shared components$ref
#198
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
acunniffe
changed the title
$ref$ref
acunniffe
commented
Mar 8, 2022
| @@ -9,6 +9,9 @@ servers: | |||
| tags: | |||
| - name: Thing | |||
| description: Short description of what Thing represents | |||
| x-v3-schemas: | |||
There was a problem hiding this comment.
one time import of your shared schemas
acunniffe
commented
Mar 8, 2022
| @@ -9,6 +9,9 @@ servers: | |||
| tags: | |||
| - name: Thing | |||
| description: Short description of what Thing represents | |||
| x-v3-schemas: | |||
| $ref: https://raw.githubusercontent.com/snyk/sweater-comb/v1.5.0/components/parameters/version.yaml | |||
| # ^ tag | |||
There was a problem hiding this comment.
specify the tag in one place, for every subsequent $ref
acunniffe
commented
Mar 8, 2022
| @@ -18,7 +21,7 @@ paths: | |||
| tags: | |||
| - Thing | |||
| parameters: | |||
| - { $ref: "../../../../../components/parameters/version.yaml#/Version" } | |||
| - { $ref: '#/x-v3-schemas/Version' } | |||
There was a problem hiding this comment.
usage is a lot cleaner
cmars
added a commit
to cmars/sweater-comb
that referenced
this pull request
Mar 8, 2022
This reorganizes common components into a single components file so that it may be referenced once in an OpenAPI spec using JSON References. End-to-end tests are updated to use the updated references. The component name rule is adjusted to allow this change. It might be tightened up in a followup to check the names of component leaf-nodes. Credit for this awesome idea to @acunniffe, originally proposed in snyk#198 as a proof-of-concept.
cmars
added a commit
to cmars/sweater-comb
that referenced
this pull request
Mar 8, 2022
This reorganizes common components into a single components file so that it may be referenced once in an OpenAPI spec using JSON References. End-to-end tests are updated to use the updated references. The component name rule is adjusted to allow this change. It might be tightened up in a followup to check the names of component leaf-nodes. Credit for this awesome idea to @acunniffe, originally proposed in snyk#198 as a proof-of-concept.
cmars
added a commit
to cmars/sweater-comb
that referenced
this pull request
Mar 8, 2022
This reorganizes common components into a single components file so that it may be referenced once in an OpenAPI spec using JSON References. End-to-end tests are updated to use the updated references. The component name rule is adjusted to allow this change. It might be tightened up in a followup to check the names of component leaf-nodes. Credit for this awesome idea to @acunniffe, originally proposed in snyk#198 as a proof-of-concept.
|
Closing as this is superseded by #199. Thanks again for the example! |
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.
[Example Only] -- do not merge
You all have shared that you plan to put shared schema on GitHub and let users consume them using
$refThis has some challenges I think using JSON Schema Refs differently could solve.
This is a really simple example where we import your shared schemas to an extension ie
x-v3-schemasand then, everywhere else, resolve those via#/x-v3-schemas/TargetRight now your shared schemas are still spread across multiple files. To make this work best, I'd suggest having one "entry point" that follows the standard components section OpenAPI conventions:
https://swagger.io/docs/specification/components/
This probably just means adding a registry-like schema that
$refout to all the subcomponents you want in the shared schemas users import.