-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for "inline" objects in response and request body #22
Comments
What do you mean by inline? |
I think it's for jsodc object (schema) declaration like beelow
or something like that or directly in yml. I need this too ;) It's juste for convenience to declare schemas where they are used. |
Ah gotcha, I went with yaml because I don’t like dealing with whitespace in jsdoc. But it shouldn’t be too hard to add if people find it useful :) I’d also be happy to merge any pull requests if someone wanted to take a stab at building the feature? |
I could do that cause I need it ! :) |
two proposals.
or use the https://github.com/john-doherty/jsdoc-to-json-schema proposal /**
* @schema.name JWS
*/
const JWS = {
/**
* @schema.title Header
* @schema.type string
* @schema.required true
*/
header: '',
/**
* @schema.title Payload
* @schema.type string
* @schema.required true
*/
payload: '',
/**
* @schema.title Signature
* @schema.type string
* @schema.required true
*/
signature: '',
} John use the jsdoc I could try today an implementation of the second. Tel me @bourdakos1 if you think it's a good idea in order to merge it of course ! ;) |
I really like the second example! Would be more than happy to merge that feature 😁 |
I want to use the
responseContent
comment to specify an object responseThe text was updated successfully, but these errors were encountered: