Skip to content

Response schema not specified in YAML files #68

Description

@cnjsstong

In the Swagger YAML files, response schema specs are not given. For example, for /account_name:

"/account_name":
get:
description: Get account name by ID
operationId: api.explorer.get_account_name
parameters:
- in: query
name: account_id
default: 1.2.0
type: string
required: true
description: Account ID (1.2.X)
responses:
'200':
description: 1 account name
'500':
description: Error processing parameters
tags:
- api
- account

In responses, it gives only description for each status code. The schema spec (https://swagger.io/docs/specification/2-0/describing-responses/) is missing.

This may not be a big issue in some use cases. However, we will not be able to use the API with some Swagger clients who rely on the schema to unmarshal JSON (like Bravado). This makes it harder for non-technical data analysis people to retrieve and make use of the API.

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