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

Modify structure of Swagger specs #40

Closed
isaacvr opened this issue Oct 31, 2019 · 0 comments
Closed

Modify structure of Swagger specs #40

isaacvr opened this issue Oct 31, 2019 · 0 comments
Labels
Milestone

Comments

@isaacvr
Copy link

isaacvr commented Oct 31, 2019

Feature description

Add models definitions sections in Swagger spec.

Is your feature request related to a problem? Please describe.
Swagger spec for Skycoin node only defines inline responses. This leads to generation errors , e.g. in qt ( simelo/libskycoin-cpp#1 ) and tizen ( simelo/libskycoin-cpp#2 ) client libraries.

Describe the solution you'd like
All models in models definitions section. Add type field for operation items . Use $ref for array types links for type definition.

Describe alternatives you've considered
The inline response body does not work quite well for generators relying on some language / framework combinations .

Additional context
The structure is inspired on Pet app Swagger spec's models section . This layout works fine with many generators.

@isaacvr isaacvr added this to the 0.25.1 milestone Oct 31, 2019
@isaacvr isaacvr closed this as completed Oct 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant