Allow oneOf to be parsed. RE: #5 #81
Merged
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
brendo
force-pushed
the
issue-5-one-of-parser
branch
from
5d9fb57
to
f2e9ae0
Compare
quangkhoa
reviewed
Jun 6, 2017
src/parser/open-api/oneOfResolver.js
Outdated
| * @param {object} obj | ||
| * @return {array} | ||
| */ | ||
| function getOneOfPaths (obj) { |
There was a problem hiding this comment.
Nice!
If you want, you could rename k to key. It would be more descriptive.
quangkhoa
reviewed
Jun 6, 2017
src/parser/open-api/schemaParser.js
Outdated
| const resolvedJsonSchema = resolveAllOf(jsonSchema) | ||
| const outputSchema = getPropertiesNode(resolvedJsonSchema.properties, resolvedJsonSchema.required) | ||
| let resolved = resolveAllOf(jsonSchema) | ||
| resolved = resolveOneOf(jsonSchema) |
There was a problem hiding this comment.
It looks like the result of resolveAllOf is discarded.
quangkhoa
reviewed
Jun 6, 2017
| "required": ["foo"] | ||
| } | ||
| ] | ||
| } |
There was a problem hiding this comment.
I would reorder the elements in this file for better readability. Currently the order is as follows:
- string - bar
- integer - foo
- integer - bar
- string - foo
quangkhoa
reviewed
Jun 6, 2017
| return obj | ||
| } | ||
|
|
||
| const states = getStates(paths, obj) |
There was a problem hiding this comment.
What do you think about permutations, as opposed to states?
quangkhoa
reviewed
Jun 6, 2017
src/parser/open-api/oneOfResolver.js
Outdated
| * If no `oneOf` keys were found, an empty array is returned. | ||
| * | ||
| * @param {object} obj | ||
| * @return {array} |
There was a problem hiding this comment.
This should be {string[]} paths to be consistent with the docs on getStates function.
brendo
pushed a commit
to brendo/open-api-renderer
that referenced
this pull request
Jun 20, 2017
Allow oneOf to be parsed. RE: temando#5
brendo
pushed a commit
to brendo/open-api-renderer
that referenced
this pull request
Jun 20, 2017
Allow oneOf to be parsed. RE: temando#5
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 MR updates
schemaParserto be able to consumeoneOfdefinitions (using a helper,resolveOneOf).It works by creating full permutations of the object by applying each of the possible
oneOfstates.I expect performance will degrade on large schemas, but given we only run the schema parsing at a property level, I think this should be sufficient for the short term.
I have added three test cases:
oneOf, which is identical to our scenario for authentication with the Temando Platform APItype: [ array, of, types]Other:
getTestsFromFixturesthat helps load a set of inputs/outputs from a directoryschemaParser. Most objects in this logic are created as the result of aJSON.parse, so the checks tohasOwnPropertyare redundantNote this MR does introduce visualising of the
oneOfschema, that'll be handled in #32.