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

Body params descriptions are not used #39

Open
schneivo77 opened this issue Sep 14, 2019 · 0 comments
Open

Body params descriptions are not used #39

schneivo77 opened this issue Sep 14, 2019 · 0 comments

Comments

@schneivo77
Copy link

schneivo77 commented Sep 14, 2019

Hi,

is it intentional that the descriptions of body parameters are not used in the Postman collection after the conversion?

From your README.md:

Body param conversion example

If in = body

swagger postman
name: role-id
description: role identifier number
in: body
schema: <schemaObject>
"body": {
 "mode": "raw",
 "raw": json-schema-faker(<schemaObject>)
}

If in = formData and consumes = application/x-www-form-urlencoded

swagger postman
name: role-id
description: role identifier number
in: formData
default: defaultValue
"body": {
 "mode": "urlencoded",
 "urlencoded": [{
  "key": "role-id",
  "value": defaultValue,
  "type": "text",
 }]
}

All parmas with above condition are added to urlencoded array.

If in = formData and consumes = multipart/form-data

swagger postman
name: role-id
description: role identifier number
in: formData
default: defaultValue
"body": {
 "mode": "formdata",
 "formdata": [{
  "key": "role-id",
  "value": defaultValue,
  "type": "text",
 }]
}

All parmas with above condition are added to formdata array.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant