Skip to content
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

Field specs missing in request/response model #13

Closed
robbito opened this issue Sep 10, 2019 · 4 comments
Closed

Field specs missing in request/response model #13

robbito opened this issue Sep 10, 2019 · 4 comments

Comments

@robbito
Copy link

robbito commented Sep 10, 2019

I have specified @SiZe annotations, which are not rendered in the model:
image
image

@mrin9
Copy link
Owner

mrin9 commented Sep 13, 2019

can you provide an open-api spec, where you see this issue

@robbito
Copy link
Author

robbito commented Sep 13, 2019

Here is a minimal api spec:

openapi.zip

I guess the problem is, that schemaToPdf does not use getTypeInfo(). Maybe this could be added with an option

BTW: I think the code needs a general refactoring. Works in general, good job, but structure, naming, etc. needs to be improved (no offense intended :-))

@mrin9
Copy link
Owner

mrin9 commented Sep 13, 2019

Currently we show type, format, patterns and constrain info for query, form, path and header params.
For request-body which generally is an object we are having some internal discussion on how best we can put this info in a printable manner without skewing the objects indentation structure. We have some designs that we are running through our test cases and collecting feedbacks from some of our clients.

we do have a plan to show this info and as you correctly mentioned we already have done some ground work for it getTypeInfo().

Regarding the code, one of our top priority is apply a JS style linter . If you are willing, I am happy to take a PR on this. the first step would be to just lint it without changing any names, thereafter we visit the rest

@mrin9
Copy link
Owner

mrin9 commented Sep 23, 2019

in release 2.0.0 code has been refactored and JS linter is applied. Type info about field types are now printed in the object model.

@mrin9 mrin9 closed this as completed Sep 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants