Coder Social home page Coder Social logo

Comments (3)

romanblanco avatar romanblanco commented on June 8, 2024

@diei, would this work for you?

parameter name: :test_type, in: :query, required: false, schema: { type: :array, items: { enum: ['type1', 'type2'] } }

from rswag.

diei avatar diei commented on June 8, 2024

@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.

diei avatar diei commented on June 8, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.