Skip to content

Commit a7c8843

Browse files
added API methods to the documentation
1 parent 2e2515b commit a7c8843

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## API Methods
2+
3+
- **GET**:
4+
- The GET method is used to retrieve data from a specified resource.
5+
- It is a safe and idempotent method, meaning that it should not have any side effects and can be called multiple times without changing the result.
6+
- Use the GET method when you want to retrieve information from the server.
7+
8+
- **POST**:
9+
- The POST method is used to submit data to be processed to a specified resource.
10+
- It is not idempotent, meaning that calling the same POST request multiple times may result in different outcomes.
11+
- Use the POST method when you want to create a new resource on the server.
12+
13+
- **PUT**:
14+
- The PUT method is used to update a specified resource with new data.
15+
- It is idempotent, meaning that calling the same PUT request multiple times should have the same effect as calling it once.
16+
- Use the PUT method when you want to update an existing resource on the server.
17+
18+
- **PATCH**:
19+
- The PATCH method is used to apply partial modifications to a resource.
20+
- It is not idempotent, meaning that calling the same PATCH request multiple times may result in different outcomes.
21+
- Use the PATCH method when you want to update a resource with partial data.
22+
23+
- **DELETE**:
24+
- The DELETE method is used to delete a specified resource.
25+
- It is idempotent, meaning that calling the same DELETE request multiple times should have the same effect as calling it once.
26+
- Use the DELETE method when you want to remove a resource from the server.
27+

contrib/api-development/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# List of sections
22

3-
- [Section title](filename.md)
3+
- [API Methods](api-methods.md)

0 commit comments

Comments
 (0)