Skip to content

Commit 237a00c

Browse files
added DEFINITIONS FOR ATTRIBUTES of API methods to the documentation
1 parent 2a3d288 commit 237a00c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

contrib/api-development/api-methods.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,17 @@
4040

4141
- **CONNECT**:
4242
- 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.
43+
44+
### Definitions:
45+
46+
- **CRUD**:
47+
- 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.
48+
49+
- **Accepts Request Body**:
50+
- 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.
51+
52+
- **Idempotent**:
53+
- 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.
54+
55+
- **Safe**:
56+
- 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.

0 commit comments

Comments
 (0)