Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Parameter description is undefined for ref schema parameters #559

Closed
bretik opened this issue Jun 17, 2022 · 2 comments
Closed

Parameter description is undefined for ref schema parameters #559

bretik opened this issue Jun 17, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@bretik
Copy link

bretik commented Jun 17, 2022

Hi, I have problem with conversion of ref schema with parameter description
Let's have this definition:

openapi: 3.0.1
info:
  title: My REST API
  version: 1.0.0
paths:
  /description-test:
    post:
      description: Endpoint description
      operationId: description-test
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RequestSchema'
      responses:
        "201":
          description: Response description
          content:
            application/json;charset=UTF-8:
              schema:
                type: object
                properties:
                  responseParam:
                    type: string
                    description: Response param description
components:
  schemas:
    RequestSchema:
      type: object
      properties:
        requestParam:
          type: string
          description: Request param description

In openapi-to-postmanv2@3.0.0, I got:

"formdata": [
  {
    "key": "requestParam",
    "value": "<string>",
    "type": "text",
    "description": "Request param description"
  }
]

Now in openapi-to-postmanv2@3.1.0+, from the same input definition, I get:

"formdata": [
  {
    "description": {
      "content": "undefined",
      "type": "text/plain"
    },
    "key": "requestParam",
    "value": "<string>",
    "type": "text"
  }
]

So all request parameters in postman have description string "undefined". When the schema is defined inline, I get correct description generated:

"formdata": [
  {
    "description": {
      "content": "Request param description",
      "type": "text/plain"
    },
    "key": "requestParam",
    "value": "<string>",
    "type": "text"
  }
]
@VShingala
Copy link
Member

@bretik Thanks for reporting the issue! We've identified the issue and the fix will be available soon in the Postman app. I'll update the thread once it's fixed.

@VShingala VShingala added the bug Something isn't working label Jul 14, 2022
@VShingala
Copy link
Member

@bretik Issue has been fixed now. Feel free to re-open issue if you face any further problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants