Skip to content

param-type of query does not include docs #572

@jaypozo

Description

@jaypozo

When building for Postman, docs for query parameters are not included, though docs for path variables are.

I have this in my input:

"args" : [ {
        "argName" : "walletAddress",
        "type" : {
          "type" : "primitive",
          "primitive" : "STRING"
        },
        "paramType" : {
          "type" : "path",
          "path" : { }
        },
        "docs" : "The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically.",
        "markers" : [ ],
        "tags" : [ ]
      }, {
        "argName" : "testnets",
        "type" : {
          "type" : "primitive",
          "primitive" : "BOOLEAN"
        },
        "paramType" : {
          "type" : "query",
          "query" : {
            "paramId" : "testnets"
          }
        },
        "docs" : "Set to true to include testnets with activity in the response. By default, it's set to `false` and only returns mainnet activity.",
        "markers" : [ ],
        "tags" : [ ]
      } ]

Note the "docs" field is populated for both parameter types above. However, the description field for query is not created, like it is for variable:

"variable":[{
    "key": "walletAddress",
    "description": "The requested wallet address. Passing in an `ENS`, `RNS`, `Lens Handle`, or an `Unstoppable Domain` resolves automatically."
  }],
"query":[{
  "key": "testnets",
  "value": "",
  "disabled": false
}]

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