Skip to content

Confusing titles for API endpoints related to organization groups #22581

Open
@RoughlyHewn

Description

@RoughlyHewn

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

The title "Update the details for an organization group" for a PUT request is followed by "Update some details for an organization group" for a PATCH request. This is confusion because "Update the details" is broad and the difference is not clear.

Location

https://docs.docker.com/reference/api/hub/latest/#tag/groups/paths/~1v2~1orgs~1%7Borg_name%7D~1groups~1%7Bgroup_name%7D/put

Suggestion

It would be clearer if the titles were contrasting as "Update all details for an organization group" and "Update some details for an organization group" or if they were differentiated like "Replace details for an organization group" and "Update some details for an organization group."

Metadata

Metadata

Labels

area/apiRelates to Docker API docswtd-projectRelates to WTD API docs project

Type

No type

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions