Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit fae0d4a

Browse files
authored
Merge pull request #3789 from ronak2ram/update-params-url
Update Parameters in URLs Example
2 parents 5753ff6 + e6a4fe4 commit fae0d4a

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

guides/v2.1/rest/notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In a REST call, a user could potentially specify one ID in the {% glossarytoolti
99

1010
For example:
1111

12-
The REST URL to update a customer is `<route url="/V1/customers/:id" method="PUT">`. If you specify a ID value of `1` in the URL (`http://magento.loc/customer/1`), and a body of `{ "id": 2, "attr": "value" }`, the customer with ID of `1` will be modified.
12+
The REST URL to update a customer is `<route url="/V1/customers/:id" method="PUT">`. If you specify a ID value of `1` in the URL (`http://<host>/rest/V1/customers/1`), and a body of `{ "customer": { "id": 2, "attr": "value" }}`, the customer with ID of `1` will be modified.
1313

1414
This applies to all REST APIs where a parameter is passed in the URL. Anything specified in the request body with the same parameter name as the URL will be ignored.
1515

guides/v2.2/rest/notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In a REST call, a user could potentially specify one ID in the {% glossarytoolti
1414

1515
For example:
1616

17-
The REST URL to update a customer is `<route url="/V1/customers/:id" method="PUT">`. If you specify an ID value of `1` in the URL (`http://magento.loc/customer/1`), and a body of `{ "id": 2, "attr": "value" }`, the customer with ID of `1` will be modified.
17+
The REST URL to update a customer is `<route url="/V1/customers/:id" method="PUT">`. If you specify an ID value of `1` in the URL (`http://<host>/rest/V1/customers/1`), and a body of `{ "customer": { "id": 2, "attr": "value" }}`, the customer with ID of `1` will be modified.
1818

1919
This applies to all REST APIs where a parameter is passed in the URL. Anything specified in the request body with the same parameter name as the URL will be ignored.
2020

0 commit comments

Comments
 (0)