Skip to content

Parameters storage is not fulfilled by parameters provided in ApiOperation #2364

Open
@spamshaker

Description

@spamshaker

OperationMetadataStorage.defineMetadata(target, options, propertyKey);

thus the parameters are not generated when specified

 @ApiOperation({
    summary: 'Gets user by id',
    methods: ['get'],
    path: '/users/{id}',
    parameters: [
      {
        name: 'id',
        in: 'path',
        required: true,
        example: 1,
        schema: {
          type: 'integer',
          minimum: 1
        }
      }
    ]
  })
  show(id: string): User {
    return {
      id,
      name: '',
      email: ''
    };
  }

Actual Result:

{
 "paths": {
    "/users/{id}": {
      "get": {
        "summary": "Gets user by id",
        "parameters": [],
        "responses": {},
        "security": []
      }
    }
  }
}

Expected Result:

{
{
 "paths": {
    "/users/{id}": {
      "get": {
        "summary": "Gets user by id",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "example": 1,
            "schema": {
              "type": "integer",
              "minimum": 1
            }
          }
        ],
        "responses": {},
        "security": []
      }
    }
  }
}

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