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

param-type of query does not include docs #572

Open
jaypozo opened this issue Jan 4, 2024 · 0 comments
Open

param-type of query does not include docs #572

jaypozo opened this issue Jan 4, 2024 · 0 comments

Comments

@jaypozo
Copy link

jaypozo commented Jan 4, 2024

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
}]
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