Skip to content

Docker Engine API overview #22536

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.

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

Open
1 task done
sarahsanders-docker opened this issue May 1, 2025 · 3 comments
Open
1 task done

Docker Engine API overview #22536

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

Comments

@sarahsanders-docker
Copy link
Collaborator

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

Task: Read through the v1.49 Docker Engine API overview. What’s confusing or unclear? Suggest wording improvements for newcomers.

Location

https://docs.docker.com/reference/api/engine/version/v1.49/

Suggestion

No response

@sarahsanders-docker sarahsanders-docker added the status/triage Needs triage label May 1, 2025
@sarahsanders-docker sarahsanders-docker changed the title Docker Engine API v1.49 Overview Docker Engine API overview May 1, 2025
@sarahsanders-docker sarahsanders-docker added wtd-project Relates to WTD API docs project and removed status/triage Needs triage labels May 1, 2025
@migue1s
Copy link

migue1s commented May 4, 2025

Taking this one!

@migue1s
Copy link

migue1s commented May 4, 2025

Some feedback, left here since I found it a bit hard to create a PR at WTD

false Return the size of container as fields SizeRw and SizeRootFs.

What is SizeRw and SizeRootFs? They are defined in the response but not in the initial usage

The names associated with this container. Most containers have a single name, but when using legacy "links", the container can have multiple names.

Could we have a link to the legacy links?

The hostname to use for the container, as a valid RFC 1123 hostname.

What is RFC 1123?

Whether to attach to stdin.

How much are we assuming people will know when going into this docs about stding/stdout? Can we exapnd on this description in case our users are unfamiliar

Close stdin after one attached client disconnects

What are the use cases for this?

@migue1s
Copy link

migue1s commented May 4, 2025

Someone else can feel free to take this. Going to jump to a different project

@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
Labels
area/api Relates to Docker API docs wtd-project Relates to WTD API docs project
Projects
Status: Todo
Development

No branches or pull requests

2 participants