Comments (3)
@diei, would this work for you?
parameter name: :test_type, in: :query, required: false, schema: { type: :array, items: { enum: ['type1', 'type2'] } }
from rswag.
@romanblanco, thank you for the hint. It is better but not like before and not like I need it.
The code...
parameter name: :test_type, in: :query, required: false, schema: { type: :array, items: { enum: ['type1', 'type2'] } }
... generates:
"parameters": [{
"name": "test_type",
"in": "query",
"required": false,
"schema": {
"type": "array",
"items": {
"enum": [
"type1",
"type2"
]
}
}
}]
That is rendered as a multi-select-box. Then I can select several values at the same time which should not be possible, only one or nothing.
I tried it out a bit and figured out that this works:
parameter name: :test_type, in: :query, required: false, schema: { enum: ['type1', 'type2'] }
That definition generates the expected JSON which is rendered as a common select box:
"parameters": [{
"name": "test_type",
"in": "query",
"required": false,
"schema": {
"enum": [
"type1",
"type2"
]
}
}]
from rswag.
During my many tries to find a solution, I noticed that the type: :string
is also not correctly transferred to the JSON:
parameter name: :test_type, in: :query, type: :string, required: false, schema: { enum: ['type1', 'type2'] }
Generates this JSON:
"parameters": [{
"name": "test_type",
"in": "query",
"type": "string",
"required": false,
"schema": {
"enum": [
"type1",
"type2"
]
}
}]
But the type
should be within schema
:
"parameters": [{
"name": "test_type",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"type1",
"type2"
]
}
}]
If I omit the custom schema
definition of the parameter
the type
is added automatically to the schema
or I have to move the type: :string
from parameter
to the custom schema
definition:
parameter name: :test_type, in: :query, required: false, schema: { type: :string, enum: ['type1', 'type2'] }
from rswag.
Related Issues (20)
- [BUG] Cannot load rails_helper HOT 1
- [REQUEST] Support OAS 3.1 Parameters in generator
- Rswag fires exception when response is generated by Jbuilder view HOT 2
- [BUG] multiple responses with the same http code
- [BUG] `get` is not available from within an example HOT 1
- [ISSUE] RubyMine not showing Intellisense for Rswag methods
- [BUG] README documentation for VCR is incorrect
- Adding operation tags to global tags
- [BUG] [SECURITY] sensitive configurations leaked in unauthenticated html endpoint
- [BUG] Referenced schemas for query params won't serialize as expected
- [BUG] Strict schema validation not honoring `required` fields
- [REQUEST] Using oneOf, anyOf or AllOf with inline schemas HOT 1
- [BUG] Duplicate CSP headers when Rails CSP is configured HOT 7
- [REQUEST] Allow overriding swagger-ui assets path to install and use a custom version
- [BUG] Why rswag does not validate response schema types?
- [BUG] Custom :getter option for parameter results in invalid schema.
- [REQUEST] Add support for deep_linking HOT 1
- Rack::Lint::LintError loading the API definition in dev
- [BUG] Query parameters are incorrect by using multiple object parameters
- [REQUEST] How to spec missing Authorization header?
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 rswag.