Skip to content

Route parameters are duplicated when explicitly documented #393

@mroach

Description

@mroach

This may only affect OpenAPI/Swagger. When you document a route parameter, the parameter output is duplicated.

RSpec.resource "rspec_api_documentation duplicate parameter bug" do
  get "/test/:id/:cmd" do
    parameter :id, "ID of the user", in: :path
    parameter :cmd, "Command", in: :path

    example_request "works like a charm" do
      expect(status).to eq 200
    end
  end
end

Output (truncated to relevant parts):

"/test/{id}/{cmd}": {
  "get": {
    "tags": [
      "rspec_api_documentation duplicate parameter bug"
    ],
    "parameters": [
      {
        "name": "id",
        "in": "path",
        "description": "ID of the user",
        "required": true,
        "type": "string"
      },
      {
        "name": "cmd",
        "in": "path",
        "description": "Command",
        "required": true,
        "type": "string"
      },
      {
        "name": "id",
        "in": "path",
        "description": "",
        "required": true,
        "type": "string"
      },
      {
        "name": "cmd",
        "in": "path",
        "description": "",
        "required": true,
        "type": "string"
      }
    ],
    "responses": {  }
  }
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions