Skip to content

Document streaming responses #21803

Open
Open
@cowwoc

Description

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

I can't find what I'm looking for

Description

When the server responds to any endpoint that streams data, it returns a combination of the "stream", "aux" and "errorDetail" properties embedded in a JSON object. I've had to handle such properties based on empirical tests. Is the full list of properties and their meaning, format documented anywhere?

Location

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

Suggestion

Pages like https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Image/operation/ImageBuild should explicitly mention the existence of a payload for an HTTP 200 response, explain the payload format, document all possible values and their meaning.

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions