Skip to content

Response descriptions tend to be unhelpful #365

@masklinn

Description

@masklinn

Almost all 2XX responses have the description "Response" which feels like the least possible useful description.

Now I understand that OpenAPI requires a description, which I feel is over the top when both the Path and Operation can already have one (and would usually cover at least the semantics of the "success" response). Still, I feel like this should be better as either an empty string or a note that this is a success (response)? Every response is one after all, including failures.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions