openapi icon indicating copy to clipboard operation
openapi copied to clipboard

Full description of payload schema etc.

Open rschwarz opened this issue 8 years ago • 2 comments

I just played with your sphinx extension (thanks!) and saw that the generated documentation covers only part of the OpenAPI specification. This can already be seen with the BatComputer example in the docs. The paths, parameters and responses are present in the docs, but the schema for the payload is missing, as are the bounds on the integer parameters etc., even though the definitions are all there.

Is this on purpose (the documentation will be high level) or is there just some more work needed to show everything (as with ReDoc)?

I wish to get the best of both worlds, that is the inline documentation, but with full detail.

rschwarz avatar May 23 '17 17:05 rschwarz

Hey @leethargo! Thanks for reaching out to me.

or is there just some more work needed to show everything (as with ReDoc)?

You are absolutely right here - more work needs to be done, and unfortunately I don't have time for that right now. :( I'll try to do something in near future, but can't say when it will be done. If you have some time I'll appreciate any contribution!

ikalnytskyi avatar May 23 '17 18:05 ikalnytskyi

OK, I'll see what I need for my use case. If we go with with a sphinx-based solution, I'll make a pull request.

rschwarz avatar May 23 '17 18:05 rschwarz