docs: 📝 tweak documentation

ahinkle · ahinkle · commit 0c8292007b56 · 2021-09-24T08:21:30.000-05:00
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/README.md b/README.md
@@ -356,14 +356,10 @@ Magento::api('orders')->show($orderId);
 ```
 
 `/V1/orders`
-
-Updates an order specified by the entity id within the $body:
+https://magento.redoc.ly/2.4.3-admin/tag/orders#operation/salesOrderRepositoryV1SavePost
+Performs persist operations for a specified order.
 ```php
-$body = [
-    'entity_id' => '', // required
-    // ... attributes to update
-];
-Magento::api('orders')->edit($body);
+Magento::api('orders')->edit($entity = []);
 ```
 
 
diff --git a/src/Api/Orders.php b/src/Api/Orders.php
@@ -34,7 +34,8 @@ public function show($orderId)
     }
 
     /**
-     * Edits and saves an order using the specified entity id within the body.
+     * Performs persist operations for a specified order.
+     * @see https://magento.redoc.ly/2.4.3-admin/tag/orders/#operation/salesOrderRepositoryV1SavePost
      *
      * @param array $entity
      * @return array

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ public function show($orderId)`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Edits and saves an order using the specified entity id within the body.`
	`37`	`+ * Performs persist operations for a specified order.`
	`38`	`+ * @see https://magento.redoc.ly/2.4.3-admin/tag/orders/#operation/salesOrderRepositoryV1SavePost`
`38`	`39`	`*`
`39`	`40`	`* @param array $entity`
`40`	`41`	`* @return array`