Document REST standards for resources CRUD operations #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

billygout opened this issue Nov 13, 2023 · 0 comments

billygout commented Nov 13, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment