Comments (6)
@bennettl : It's on the README. Have a look:
https://github.com/richhollis/swagger-docs#drying-up-common-documentation
from swagger-docs.
Hi Bennett
If you want to add a header and I've read the spec correctly then in theory you should be able to use the regular param with :header type (not tested):
swagger_api :index do
param :header, :some_header, :integer, :optional, "Some header"
end
Let me know if this works.
from swagger-docs.
I want to populate the header with a default value, but this doesn't seem to work:
param :header, :some_header, :integer, :optional, "Some header", "Default Value"
from swagger-docs.
What about this (untested):
param :header, :some_header, :integer, :optional, "Some header", {"defaultValue" => "some default"}
from swagger-docs.
@bennettl Did that work?
from swagger-docs.
Yes that did the trick. Thank you so much!
from swagger-docs.
Related Issues (20)
- How Can i User Swagger docs for devise sessions controller HOT 4
- "status":404,"error":"Not Found"
- Need a good example for a json body with multiple parameters HOT 2
- undefined swagger_controller HOT 1
- 1.0: 0 processed / 1 skipped HOT 8
- rake:swagger
- param :path, not showing up. HOT 1
- rails-api 1.0: 1 processed / 4 skipped issue HOT 1
- Do not depend on "rails" gem, depend on parts of Rails that swagger-docs uses HOT 1
- Swagger/OpenAPI 3.0 HOT 2
- Dependency to the full rails gem
- Use of swagger-docs for versioning in header
- uninitialized constant Swagger HOT 2
- Custom Tags in Rails
- Raise error when wrong controller action is provide in <model name>_doc file
- Param as type "array" in swagger_api HOT 3
- NameError (undefined local variable or method `current_user')
- Do file uploads work? HOT 1
- Unable to render this definition
- Configurations with rails 6 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 swagger-docs.