Skip to content

Implement a consistent format for responses #38

Description

@davidbmaier

Example responses and error cases aren't consistent across endpoints, and it would be good to have some sort of standardized layout for them.

Instead of relying on manual reviews to enforce some kind of structure we could build a custom component (similar to api-param) for responses that renders consistent layouts.

Possible approach:

  • New responses array in the meta section
  • Each response has a type - example (for URL + body + response body) or error (for status code + body + explanation)

Open questions:

  • If the content is defined in yaml, how can we handle special formatting inside the content, e.g. code or links in explanations?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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