Skip to content

Commit 1b9f813

Browse files
Merge branch 'rest-api' of github.com:leapfrogtechnology/coding-standards-convention into develop
2 parents cccb989 + d336942 commit 1b9f813

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/rest-api/get.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Use **GET requests** to retrieve resource representation/information only – an
7777

7878
### Response Header
7979

80-
Specify `Content-type` header, and its should be `application/json` while returing json response, `application/xml` while returning xml response and so on.
80+
Specify `Content-type` header, and it should be `application/json` while returing json response, `application/xml` while returning xml response and so on.
8181

8282
### Response code and Results
8383

docs/rest-api/patch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_label: Patch
66

77
PATCH is used for **modify** capabilities. The PATCH request only needs to contain the changes to the resource, not the complete resource.
88

9-
This resembles PUT, but the body contains a set of instructions describing how a resource currently residing on the server should be modified to produce a new version.PATCH is neither safe nor idempotent. However, a PATCH request can be issued in such a way as to be idempotent, which also helps prevent bad outcomes from collisions between two PATCH requests on the same resource in a similar time frame. Collisions from multiple PATCH requests may be more dangerous than PUT collisions because some patch formats need to operate from a known base-point or else they will corrupt the resource. Clients using this kind of patch application should use a conditional request such that the request will fail if the resource has been updated since the client last accessed the resource.
9+
This resembles PUT, but the body contains a set of instructions describing how a resource currently residing on the server should be modified to produce a new version.PATCH is neither safe nor idempotent. However, a PATCH request can be issued in such a way as to be idempotent, which also helps prevent bad outcomes from collisions between two PATCH requests on the same resource in a similar time frame. Collisions from multiple PATCH requests may be more dangerous than PUT collisions because some patch formats need to operate from a known base-point or else they will corrupt the resource. Clients using this kind of patch application should use a conditional request such that the request will fail if the resource has been updated since the client last accessed the resource.
1010

11-
*PATCH request can usuallly be used to update the status of resource like from `pending` to `accepted`, `active` to `expired`*
11+
*PATCH request can usually be used to update the status of resource like from `pending` to `accepted`, `active` to `expired`*
1212

1313
> * **/employees/{employee-id}**
1414
> * **/departments/{department-id}**

0 commit comments

Comments
 (0)