Comments (3)
would you consider to move to RapiDoc https://mrin9.github.io/RapiDoc/ ?
Currently, I am focusing on RapiDoc project, so updates to this project will be little delayed. But I plan to keep both of them in sync
If you are unable to move to RapiDoc, let me know whats the concern is, and I will see if i can resolve it.
Having said that, the issue that you mentioned was an issue in RapiDoc too, which is now fixed
Regarding your other question, to have a global schema section. I do not plan to create one for now
My main reason not to have a global schema is, in my experience, people do not use that section so much and most importantly for a larger specs that is spanned across multiple files, it becomes a performance bottleneck
But if you can provide me a compelling reason I might consider adding it
from openapi-viewer.
Hello
No , sadly I'd like to use vue.
As for the required properties I developed it. Example below (also working for nested objects of course) :
With json
"components" : { "schemas" : { "MyObject" : { "required" : [ "name", "status" ], "type" : "object", "properties" : { "name" : { "type" : "string", "example" : "Come say hi !" }, "status" : { "type" : "string", "enum" : [ "active", "inactive", "draft", "archive" ] }, "start" : { "type" : "string", "format" : "date-time" }, "end" : { "type" : "string", "format" : "date-time" } } } }
Will do the same with descriptions soonish. If it's of interest I can share. Not styled yet as it'll probably get revamped in my project.
Global schema I'll do in some custom descriptions in the page after all so no problem. Not a big fan of it myself, but it's not my decision to make.
Thanks again.
from openapi-viewer.
I am happy to accept a PR for the required properties. Once you style them and run through some really large schemas
Thanks
from openapi-viewer.
Related Issues (9)
- How to generate static documentation file? HOT 2
- OpenAPI v3.1 Support
- Way to disable "try" feature? HOT 2
- Getting started documentation HOT 3
- Error parsing the spec, that passes the validation of openapi-spec-validator HOT 2
- Post with json body HOT 2
- [BUG] $ref file error HOT 3
- support uploading YAML format 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-viewer.