Comments (3)
I'm very interested in this feature as well. ATM the only workaround I have is to do:
public_api :GET, "/users/:name/regions", "Get a user's regions"
param :name, String, desc: "Name of the user"
returns code: 200, desc: "Returns the user's regions" do
property :data, array_of: Hash do
param_group: Region
end
end
def regions
# some logic here
end
However what doesn't work is that on the open API documentation, it doesn't pass the param_group as a reference but spreads/duplicates the whole definition. It would be amazing to factorize it so that the param groups are defined only once and reused in all APIs they are used. This is especially useful when using Swagger clients with typescript definitions of an API.
from apipie-rails.
Accidentally closed this issue - this is still a feature we'd like.
from apipie-rails.
If you can try to implement it with tests, I will review and can incorporate. Unfortunately, I don't have time to work on feature requests.
Thank you for your understanding
from apipie-rails.
Related Issues (20)
- add support to say param1 or param2 required
- Report all missing required parameters instead of just the first HOT 2
- Mark params as deprecated HOT 1
- Enable Style/HashSyntax Ruby 1.9 HOT 2
- Getting So many Warnings while using apipie with Ruby 2.7.7 HOT 15
- Missing translation `apipie.returns`
- How to specify binary-type params HOT 3
- [v1.0] NoMethodError: undefined method `resource_id' for Apipie:Module HOT 2
- Generate multiple swagger-files HOT 7
- Swagger warnings for optional parameters even when using `property` HOT 2
- Swagger generation mixes up controllers with same name: HOT 4
- Apiepie::ParamErrors Inconsistent interface HOT 6
- Swagger JSON cannot parse Array of Hash in params HOT 3
- How do I specify a custom Description, I get "Another API description" HOT 2
- Discrepancy: `params` Defined as Array of Integer in Apipie appears as Array of Strings in Swagger File HOT 4
- Incorrect Representation of Array of Hashes in Swagger Output HOT 3
- How can I define a param group without duplicating what is defined in ActiveRecord model? HOT 1
- How to display an example for a request in Swagger? HOT 2
- Are multiple base url's possible
- "allow_blank" setting is not displayed in api doc HOT 3
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 apipie-rails.