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

Update swagger.json to describe output of operation #128

Open
enterprisebug opened this issue Jan 22, 2022 · 0 comments
Open

Update swagger.json to describe output of operation #128

enterprisebug opened this issue Jan 22, 2022 · 0 comments

Comments

@enterprisebug
Copy link

enterprisebug commented Jan 22, 2022

I would like to autogenerate a 3commas client.

current swagger.json does not describe response types e.g. /ver1/deals

"/ver1/deals": {
  "get": {
    "description": "User deals (Permission: BOTS_READ, Security: SIGNED)",
    "produces": [
      "application/json"
    ],
    "parameters": [
      -- redacted
    ],
    "responses": {
      "200": {
        "description": "User deals (Permission: BOTS_READ, Security: SIGNED)"
      }
    },
    "tags": [
      "deals"
    ],
    "operationId": "getVer1Deals"
  }
},

when generating a client I would manually have to wrap the response.

It would be super pleasuring if you could update the swagger documentation that it describes the correct response types.

You already did this here:

"/ver1/ping": {
  "get": {
    "description": "Test connectivity to the Rest API (Permission: NONE, Security: NONE)",
    "produces": [
      "application/json"
    ],
    "responses": {
      "200": {
        "description": "Test connectivity to the Rest API (Permission: NONE, Security: NONE)",
        "schema": {
          "$ref": "#/definitions/PongEntity"
        }
      }
    },
    "tags": [
      "ping"
    ],
    "operationId": "getVer1Ping"
  }
},

this would also easy the client generation of the 3rd party libs e.g. https://github.com/TheKimono/3Commas.Net

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