chore(docs): merge changes from master (#3780)

* chore(docs): Generated API Reference (#3761) Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> * docs: fix typo (#3771) --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: shahednasser <shahednasser@users.noreply.github.com> Co-authored-by: Andre Schweighofer <fidrelity@users.noreply.github.com>
2023-04-10 11:15:54 +03:00
parent 5280e1bdad
commit ae017c4657
46 changed files with 221 additions and 296 deletions
--- a/docs/api/admin/paths/admin_inventory-items.yaml
+++ b/docs/api/admin/paths/admin_inventory-items.yaml
@@ -1,7 +1,9 @@
 get:
  operationId: GetInventoryItems
-  summary: List inventory items.
-  description: Lists inventory items.
+  summary: List Inventory Items
+  description: >-
+    Lists inventory items with the ability to apply filters or search queries on
+    them.
  x-authenticated: true
  parameters:
    - in: query
@@ -134,7 +136,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostInventoryItems
-  summary: Create an Inventory Item.
+  summary: Create an Inventory Item
  description: Creates an Inventory Item.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/admin_inventory-items_{id}.yaml
+++ b/docs/api/admin/paths/admin_inventory-items_{id}.yaml
@@ -1,7 +1,7 @@
 get:
  operationId: GetInventoryItemsInventoryItem
-  summary: Retrive an Inventory Item.
-  description: Retrives an Inventory Item.
+  summary: Get an Inventory Item
+  description: Retrieves an Inventory Item.
  x-authenticated: true
  parameters:
    - in: path
@@ -58,7 +58,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostInventoryItemsInventoryItem
-  summary: Update an Inventory Item.
+  summary: Update an Inventory Item
  description: Updates an Inventory Item.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/admin_inventory-items_{id}_location-levels.yaml
+++ b/docs/api/admin/paths/admin_inventory-items_{id}_location-levels.yaml
@@ -1,7 +1,7 @@
 get:
  operationId: GetInventoryItemsInventoryItemLocationLevels
-  summary: List stock levels of a given location.
-  description: Lists stock levels of a given location.
+  summary: List Inventory Levels
+  description: Lists inventory levels of an inventory item.
  x-authenticated: true
  parameters:
    - in: path
@@ -10,18 +10,6 @@ get:
      description: The ID of the Inventory Item.
      schema:
        type: string
-    - in: query
-      name: offset
-      description: How many stock locations levels to skip in the result.
-      schema:
-        type: integer
-        default: 0
-    - in: query
-      name: limit
-      description: Limit the number of stock locations levels returned.
-      schema:
-        type: integer
-        default: 20
    - in: query
      name: expand
      description: Comma separated list of relations to include in the results.
@@ -72,8 +60,8 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostInventoryItemsInventoryItemLocationLevels
-  summary: Create an Inventory Location Level for a given Inventory Item.
-  description: Creates an Inventory Location Level for a given Inventory Item.
+  summary: Create an Inventory Level
+  description: Creates an Inventory Level for a given Inventory Item.
  x-authenticated: true
  parameters:
    - in: path
--- a/docs/api/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
+++ b/docs/api/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml
@@ -1,7 +1,7 @@
 post:
  operationId: PostInventoryItemsInventoryItemLocationLevelsLocationLevel
-  summary: Update an Inventory Location Level for a given Inventory Item.
-  description: Updates an Inventory Location Level for a given Inventory Item.
+  summary: Update an Inventory Level
+  description: Updates an Inventory Level for a given Inventory Item.
  x-authenticated: true
  parameters:
    - in: path
@@ -72,7 +72,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  operationId: DeleteInventoryItemsInventoryIteLocationLevelsLocation
-  summary: Delete a location level of an Inventory Item.
+  summary: Delete a Location Level
  description: Delete a location level of an Inventory Item.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/admin_orders_{id}_line-items_{line_item_id}_reserve.yaml
+++ b/docs/api/admin/paths/admin_orders_{id}_line-items_{line_item_id}_reserve.yaml
@@ -24,11 +24,6 @@ post:
        schema:
          $ref: ../components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
  x-codeSamples:
-    - lang: JavaScript
-      label: JS Client
-      source:
-        $ref: >-
-          ../code_samples/JavaScript/admin_orders_{id}_line-items_{line_item_id}_reserve/post.js
    - lang: Shell
      label: cURL
      source:
--- a/docs/api/admin/paths/admin_orders_{id}_reservations.yaml
+++ b/docs/api/admin/paths/admin_orders_{id}_reservations.yaml
@@ -1,7 +1,7 @@
 get:
  operationId: GetOrdersOrderReservations
-  summary: Get reservations for an Order
-  description: Retrieves reservations for an Order
+  summary: Get reservations of an Order
+  description: Retrieves reservations of an Order
  x-authenticated: true
  parameters:
    - in: path
@@ -23,10 +23,6 @@ get:
        type: integer
        default: 20
  x-codeSamples:
-    - lang: JavaScript
-      label: JS Client
-      source:
-        $ref: ../code_samples/JavaScript/admin_orders_{id}_reservations/get.js
    - lang: Shell
      label: cURL
      source:
--- a/docs/api/admin/paths/admin_product-categories_{id}.yaml
+++ b/docs/api/admin/paths/admin_product-categories_{id}.yaml
@@ -126,7 +126,7 @@ post:
 delete:
  operationId: DeleteProductCategoriesCategory
  summary: Delete a Product Category
-  description: Deletes a ProductCategory.
+  description: Deletes a Product Category.
  x-authenticated: true
  parameters:
    - in: path
--- a/docs/api/admin/paths/admin_product-categories_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/admin_product-categories_{id}_products_batch.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostProductCategoriesCategoryProductsBatch
-  summary: Add Products to a category
+  summary: Add Products to a Category
  description: Assign a batch of products to a product category.
  x-authenticated: true
  parameters:
@@ -66,7 +66,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  operationId: DeleteProductCategoriesCategoryProductsBatch
-  summary: Delete Products
+  summary: Remove Products from Category
  description: Remove a list of products from a product category.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/admin_reservations.yaml
+++ b/docs/api/admin/paths/admin_reservations.yaml
@@ -81,6 +81,10 @@ get:
    method: list
    queryParams: AdminGetReservationsParams
  x-codeSamples:
+    - lang: JavaScript
+      label: JS Client
+      source:
+        $ref: ../code_samples/JavaScript/admin_reservations/get.js
    - lang: Shell
      label: cURL
      source:
@@ -111,8 +115,8 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostReservations
-  summary: Creates a Reservation
-  description: Creates a Reservation which can be associated with any resource as required.
+  summary: Create a Reservation
+  description: Create a Reservation which can be associated with any resource as required.
  x-authenticated: true
  requestBody:
    content:
--- a/docs/api/admin/paths/admin_reservations_{id}.yaml
+++ b/docs/api/admin/paths/admin_reservations_{id}.yaml
@@ -1,7 +1,7 @@
 get:
  operationId: GetReservationsReservation
  summary: Get a Reservation
-  description: Retrieves a single reservation using its id
+  description: Retrieves a single reservation using its ID
  x-authenticated: true
  parameters:
    - in: path
@@ -45,7 +45,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostReservationsReservation
-  summary: Updates a Reservation
+  summary: Update a Reservation
  description: Updates a Reservation which can be associated with any resource as required.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/admin_sales-channels_{id}_stock-locations.yaml
+++ b/docs/api/admin/paths/admin_sales-channels_{id}_stock-locations.yaml
@@ -1,7 +1,7 @@
 post:
  operationId: PostSalesChannelsSalesChannelStockLocation
-  summary: Associate a stock location to a Sales Channel
-  description: Associates a stock location to a Sales Channel.
+  summary: Associate a Stock Location
+  description: Associates a stock location with a Sales Channel.
  x-authenticated: true
  parameters:
    - in: path
@@ -55,7 +55,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  operationId: DeleteSalesChannelsSalesChannelStockLocation
-  summary: Remove a stock location from a Sales Channel
+  summary: Remove a Stock Location Association
  description: Removes a stock location from a Sales Channel.
  x-authenticated: true
  parameters: