Skip to content

[Documentation] PluginInterfaceType does not match data returned #42809

@Thalhammer

Description

@Thalhammer

Description
The http API for Inspect Plugin shows the returned property "Types" of subobject Interface inside Config to be of type "array of PluginInterfaceType" which in turn is a object. However the example show an array of strings, which matches the data returned by docker. So either the api and example is wrong or the described return type is wrong.

Steps to reproduce the issue:

  1. RTFM
  2. Wonder why the manual does not match the returned data
  3. Cry

Describe the results you received:

[
    {
        "Config": {
            ...
            "Interface": {
                "Socket": "sshfs.sock",
                "Types": [
                    "docker.volumedriver/1.0"
                ]
            },
           ...
        },
        ...
    }
]

Describe the results you expected:

[
    {
        "Config": {
            ...
            "Interface": {
                "Socket": "sshfs.sock",
                "Types": [{
                    "prefix":"docker",
                    "capability":"volumedriver",
                    "version":"1.0"
                }]
            },
           ...
        },
        ...
    }
]

Additional information you deem important (e.g. issue happens only occasionally):
Documentation issue. Changing the returned data would make it easier to parse but breaks backwards compatibility.

Output of docker version:
N/A

Output of docker info:
N/A

Additional environment details (AWS, VirtualBox, physical, etc.):
N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/apiAPIarea/docsarea/pluginskind/bugBugs are bugs. The cause may or may not be known at triage time so debugging may be needed.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions