Comments (2)
So fdoc actually uses on JSON schema (http://json-schema.org/latest/json-schema-core.html) for the actual schema description. To my knowledge there is no way in JSON schema to do what you're describing.
From my personal experience, using arrays for these kinds of things is straightforward and works in more places. It's pretty easy to build a dictionary/hash out of objects client-side once you have them loaded anyways.
{
"authors": [
{ "id": 1 },
{ "id": 4 }
]
}
Since JSON schema doesn't do this, I'm not sure this is something fdoc is going to handle now.
from fdoc.
Thanks for the quick response. I figured the change would have to be supported by json-schema, and in looking at their code I'm not sure how I'd even add it in. Sadly that I may have to give up on fdoc if I want this style of response (but I may just end up making it an array like you suggest).
from fdoc.
Related Issues (20)
- Running rspec with FDOC_SCAFFOLD=true raises Errno::ENOENT HOT 11
- Nested resources handling HOT 2
- Different response parameters for different response status HOT 1
- Is converting to markdown as output on the roadmap? HOT 1
- Error with date-time in response HOT 10
- Test suite passing? HOT 6
- License missing from gemspec HOT 2
- Path variables? HOT 1
- Support for PATCH verb? HOT 1
- Error in path to endpoint HOT 1
- Document how to manage versioned API HOT 1
- Environment variable interpolation HOT 5
- --url-base-path option passed to fdoc convert is ignored from convertes HOT 1
- YAML inheritance HOT 1
- fdoc error when converting to html in rails HOT 1
- Problem with 'properties' association
- Mention Ruby version in Readme HOT 3
- Gem release? HOT 2
- Mention render_views in readme
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 fdoc.