From 237a00cdbfaab63481a5390fb92a2040ccc95fdd Mon Sep 17 00:00:00 2001 From: Sujan Midatani Date: Sun, 12 May 2024 00:19:57 +0530 Subject: [PATCH] added DEFINITIONS FOR ATTRIBUTES of API methods to the documentation --- contrib/api-development/api-methods.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/contrib/api-development/api-methods.md b/contrib/api-development/api-methods.md index de3228a..ea41979 100644 --- a/contrib/api-development/api-methods.md +++ b/contrib/api-development/api-methods.md @@ -40,3 +40,17 @@ - **CONNECT**: - The CONNECT method is used to establish a tunnel to the server using a proxy. It does not typically require a request body and is neither safe nor idempotent. + +### Definitions: + +- **CRUD**: + - CRUD stands for Create, Read, Update, and Delete, representing the four basic functions of persistent storage. These operations are commonly used in database and RESTful API designs. + +- **Accepts Request Body**: + - Indicates whether the HTTP method typically accepts a request body containing data to be processed or modified. If yes, the method may require the client to include data in the request body. + +- **Idempotent**: + - An idempotent operation means that making the same request multiple times will produce the same result as making it once. In the context of HTTP methods, an idempotent method does not change the server state after multiple identical requests. + +- **Safe**: + - A safe operation does not modify the state of the server or its resources. It only retrieves data without causing any side effects. Safe methods are typically used for read-only operations. \ No newline at end of file