express-jsdoc-swagger icon indicating copy to clipboard operation
express-jsdoc-swagger copied to clipboard

[BUG] Request example is not rendered for GET requests

Open tkeidar opened this issue 4 years ago • 1 comments

Describe the bug When I try to set an example for GET requests swagger does not generate it.

To Reproduce

/**
   * GET /example
   * @summary Example
   * @description Get example for some input.
   * @param {string} param1.query.required - First param
   * @param {number} param2.query.required - Second param
   * @return {object} 200 - Success response
   * @return {object} 400 - Bad request response
   * @example request
   *  {
   *    "param1": "hi",
   *    "param2": 500
   *  }
   * @example response - 200 - Success response example
   *  {
   *    "hello": "world"
   *  }
   * @example response - 400 - Invalid input
   *  {
   *    "error": "Invalid input"
   *  }
   */

Expected behavior I expect the generated json to include examples for the request, but actually here is the path I get:

"paths": {
    "/example": {
      "get": {
        "deprecated": false,
        "summary": "Example",
        "description": "Get example for some input.",
        "security": [],
        "responses": {
          "200": {
            "description": "Success response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "examples": {
                  "example1": {
                    "summary": "Success response example",
                    "value": {
                      "hello": "world"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "examples": {
                  "example2": {
                    "summary": "Invalid input",
                    "value": {
                      "error": "Invalid input"
                    }
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "param1",
            "in": "query",
            "description": "First param",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "param2",
            "in": "query",
            "description": "Second param",
            "required": true,
            "deprecated": false,
            "schema": {
              "type": "number"
            }
          }
        ],
        "tags": []
      }
    }
  }

Screenshots image

tkeidar avatar Nov 02 '21 15:11 tkeidar

Hi @tkeidar right now we only support examples for request body and responses. We will mark this as an enhancement.

kevinccbsg avatar Jul 27 '22 18:07 kevinccbsg