Skip to content

HTTP API recommendations #3

Description

@KineticCookie

Hi.
REST implies that you manipulate resources using their URLs. But there are major points to consider in current API specification (dev branch):

GET with request body
HTTP GET with body breaks idempotency (requesting the same URL multiple times always gets you an equivalent result). Moreover it's rather unexpected.

I'm not sure of the semantics of GET /plottable_embeddings/transformer but consider reimplementation using POST verb. Or if you indeed query the transformer resource use query string.

Verbs in URL
In POST /set_params you manipulate params entity — choice of POST verb is good, but URL doesn't describe a resource, but uses a redundant HTTP verb. Consider renaming of url to POST /params.

Feel free to discuss these recommendations 🙂

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions