Skip to content

Document REST standards for resources CRUD operations  #39

@billygout

Description

@billygout

Please document the endpoint layouts, methods, status codes, and response content patterns for resource CRUD operations.

For example, these methods are used for the operations:

  • POST new resource (a.k.a., "create")
  • PUT to replace existing resource wholesale (a.k.a., "wholesale update")
  • PATCH to update a subset of attributes of existing resource (a.k.a. "partial update")
  • DELETE to remove an existing resource (a.k.a. "delete")
  • GET ......

Document which status code should be used minimally for the successful cases (for example, 201 for PUT and 204 for DELETE).

Document when endpoint should return a body or not.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    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