Comments (6)
@pohutukawa I believe the answer is that it's simply not implemented for OpenAPI 3.x. :( I initially started this project for OpenAPI 2.x and over the years OpenAPI 3.x support has been contributed by others. Unfortunately, I didn't pay attention much and we ended up having two independent renders for v2 and v3.
However, last year I started some refactoring the end goal of which is to have a single renderer for both versions, as well as be more aligned with OpenAPI specification regarding some edge cases. The refactoring is not yet finished but I hope it's going to be finished in next few weeks.
from openapi.
Thanks @ikalnytskyi, that's pretty much what I would have expected (it to not being done, yet). It's good to see this in the pipeline, as I'd like to use it down the line.
Keep up the good work, and thanks for this really useful tool!
from openapi.
@ikalnytskyi I am also looking forward for that extension. Is there any way to support you with that?
from openapi.
Thanks for posting this. I was scratching my head on this as well. I'm happy to help make it happen or even simply help test out the new version when it comes out.
from openapi.
So...I have an OpenAPI 3.0.1 project. It's a REST API, so by definition all the parameters are submitted and retrieved as JSON content. What I got when I tried this plugin omits more or less all the info in my endpoint definitions; for example:
PUT /config
Put config values
Status Codes
200 OK – successful operation
Given that maintenance of this plugin has apparently stopped last year, is there a workaround or another tool I could turn to?
from openapi.
Hey!
I was wondering if there is any progress on / updated timelines on this?
It's cool that the examples work for OpenAPI 3+, but personally I would prefer the schemas.
All information appreciated! :)
from openapi.
Related Issues (20)
- Feature Request: Include / Exclude in new renderer
- ERROR: Unknown directive type "openapi"
- Help with maintenance HOT 4
- Could not import extension sphinxcontrib.openapi HOT 1
- Missing header descriptions in response raise exception HOT 1
- 0.7.0: `openapi` uses `m2r` which is no longer maintained HOT 4
- Cannot build using Sphinx v4.5.0 HOT 1
- Fork of openapi till we can get get something merged here again HOT 2
- Cannot get external references through HTTP using requests
- doc: request parameter is missing in the documentation
- TypeError: unhashable type: 'dict'
- Allow anyOf in schema HOT 6
- Exclude option fails when providing more than one path to exclude
- Support sphinx-autobuild
- Schema examples dont show HOT 2
- Using gettext_lazy in a django-filter filterset with DRF breaks schema creation
- jsonschema deprecation warning
- OpenAPI v3 cookie parameters not rendered
- Form data not accepted as POST requestBody
- Superseded documentation reference on statuscode 200 HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from openapi.