Helpers for building JSON/OpenAPI schema referencing shared definitions#2971
Merged
Helpers for building JSON/OpenAPI schema referencing shared definitions#2971
Conversation
f10a806 to
6a41e9e
Compare
raymondfeng
reviewed
May 28, 2019
| * ``` | ||
| * | ||
| * @param modelCtor The model constructor (e.g. `Product`) | ||
| * @param options Additional options |
Contributor
There was a problem hiding this comment.
Please use @param modelCtor - The model ... and @param options - Additional options
Member
Author
There was a problem hiding this comment.
Will do.
It's annoying that VSCode is generating tsdoc comments in a format that's not recognized by api-extractor :(
Member
Author
There was a problem hiding this comment.
@raymondfeng How can we automate this part of review process, so that npm test fails when there are any tsdoc comments violating api-extractor requirements?
…initions Introduce the following helpers: - `getModelSchemaRef` returning OpenAPI spec - `getJsonSchemaRef` returning JSON Schema Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
6a41e9e to
808da4f
Compare
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.
Introduce the following helpers:
getModelSchemaRefreturning OpenAPI specgetJsonSchemaRefreturning JSON SchemaExample usage in controllers:
Resolve #2631.
See also #1352, #2652 and #2653.
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈