docs icon indicating copy to clipboard operation
docs copied to clipboard

Docker Engine API overview

Open sarahsanders-docker opened this issue 8 months ago • 3 comments

Is this a docs issue?

  • [x] 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 avatar May 01 '25 14:05 sarahsanders-docker

Taking this one!

migue1s avatar May 04 '25 16:05 migue1s

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 avatar May 04 '25 18:05 migue1s

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

migue1s avatar May 04 '25 22:05 migue1s