Skip to content

Consistent API Response documentation #22576

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.

Sign up for GitHub

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

Jump to bottom
Open
1 task done
jazanne opened this issue May 4, 2025 · 0 comments
Open
1 task done

Consistent API Response documentation #22576

jazanne opened this issue May 4, 2025 · 0 comments
Assignees
@sarahsanders-docker
Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project

Comments

@jazanne
Copy link

jazanne commented May 4, 2025 •
edited
Loading

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

Examples:

Image
Image
Image

Location

https://docs.docker.com/reference/api/engine/version/v1.49/#tag/Image/operation/ImageCreate

Suggestion

Style guide suggestions:

  • Sentence case
  • 200s - Success" as opposed to "No error", OR description of response object if applicable
    Image

Example with more description:

Image
@jazanne jazanne added the status/triage Needs triage label May 4, 2025
@sarahsanders-docker sarahsanders-docker added wtd-project Relates to WTD API docs project and removed status/triage Needs triage labels May 4, 2025
@sarahsanders-docker sarahsanders-docker self-assigned this May 4, 2025
@sarahsanders-docker sarahsanders-docker added the area/api Relates to Docker API docs label May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sarahsanders-docker sarahsanders-docker

Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project
Projects
wtd-project
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jazanne @sarahsanders-docker