Postman Documentation for Parameter fields from Swagger

Help Hub
2

Hello there,

Any description you provide for parameters in your swagger definition will be applied upon import as a collection, or used when you generate a collection from the swagger definition using the API builder. Here is an example:

  parameters:
    - in: path
      name: userId
      schema:
        type: integer
      required: true
      description: Numeric ID of the user to get

The description for this parameter in the collection will be (Required) Numeric ID of the user to get, which will then be applied when you publish documentation from your collection.

Hope that helps you in your work!

P.S. Also recommend you looking at upgrading from Swagger 2.0 to OpenAPI 3.0, as it has more features and support.