Skip to content

Could the REST docs include real JSON examples? #56

Description

@drapre

The remote-control skill lists the REST endpoints, but not the request and response bodies. That leaves anyone integrating without the CLI guessing the actual JSON shape.

Examples for these four paths would cover most of it:

  • list devices

  • create a task from text

  • read execution status

  • handle a failed request

Swagger helps after the backend is running. Examples in the repo would also make it clear which fields are expected to stay stable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions