Response descriptions tend to be unhelpful

Open
#365 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Start by locating the OpenAPI response definitions for the 2XX responses and reviewing how their descriptions are currently represented. Determine a consistent replacement for the generic "Response" text while preserving the required OpenAPI description field. Done means the affected success responses have useful descriptions and the API description remains valid.

Written by the indexing model from the issue text.

Description

feature fundamentals-and-support inaccuracy P3 shield waiting for review

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.

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.