chore(docs): Generated API Reference (#2120)

Co-authored-by: shahednasser <[email protected]>
medusajs · Aug 29, 2022 · b98a09d · b98a09d
1 parent 076b41b
commit b98a09d
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 46 deletions.
diff --git a/docs/api/admin-spec3.json b/docs/api/admin-spec3.json
@@ -2372,7 +2372,8 @@
     "/discounts/{discount_id}/conditions": {
       "post": {
         "operationId": "PostDiscountsDiscountConditions",
-        "summary": "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
+        "summary": "Create a DiscountCondition",
+        "description": "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
         "x-authenticated": true,
         "parameters": [
           {
@@ -2401,7 +2402,6 @@
             }
           }
         ],
-        "description": "Creates a DiscountCondition",
         "requestBody": {
           "content": {
             "application/json": {
@@ -2997,7 +2997,8 @@
       },
       "post": {
         "operationId": "PostDiscountsDiscountConditionsCondition",
-        "summary": "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
+        "summary": "Update a DiscountCondition",
+        "description": "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
         "x-authenticated": true,
         "parameters": [
           {
@@ -3035,7 +3036,6 @@
             }
           }
         ],
-        "description": "Updates a DiscountCondition",
         "requestBody": {
           "content": {
             "application/json": {
@@ -4337,8 +4337,8 @@
       },
       "post": {
         "operationId": "PostGiftCardsGiftCard",
-        "summary": "Create a Gift Card",
-        "description": "Creates a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.",
+        "summary": "Update a Gift Card",
+        "description": "Update a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.",
         "x-authenticated": true,
         "parameters": [
           {
@@ -19189,10 +19189,10 @@
           }
         }
       },
-      "sales_channel_tax_line": {
-        "title": "Sales Channel",
-        "description": "A Sales Channel",
-        "x-resourceId": "sales_channel_tax_line",
+      "shipping_method_tax_line": {
+        "title": "Shipping Method Tax Line",
+        "description": "Shipping Method Tax Line",
+        "x-resourceId": "shipping_method_tax_line",
         "required": [
           "shipping_method_id",
           "rate",
@@ -19319,7 +19319,7 @@
             "type": "array",
             "description": "Available if the relation `tax_lines` is expanded.",
             "items": {
-              "$ref": "#/components/schemas/tax_line"
+              "$ref": "#/components/schemas/shipping_method_tax_line"
             }
           },
           "price": {

diff --git a/docs/api/admin-spec3.yaml b/docs/api/admin-spec3.yaml
@@ -1618,7 +1618,8 @@ paths:
   '/discounts/{discount_id}/conditions':
     post:
       operationId: PostDiscountsDiscountConditions
-      summary: >-
+      summary: Create a DiscountCondition
+      description: >-
         Creates a DiscountCondition. Only one of `products`, `product_types`,
         `product_collections`, `product_tags`, and `customer_groups` should be
         provided.
@@ -1644,7 +1645,6 @@ paths:
             the result.
           schema:
             type: string
-      description: Creates a DiscountCondition
       requestBody:
         content:
           application/json:
@@ -2098,7 +2098,8 @@ paths:
                     $ref: '#/components/schemas/discount_condition'
     post:
       operationId: PostDiscountsDiscountConditionsCondition
-      summary: >-
+      summary: Update a DiscountCondition
+      description: >-
         Updates a DiscountCondition. Only one of `products`, `product_types`,
         `product_collections`, `product_tags`, and `customer_groups` should be
         provided.
@@ -2130,7 +2131,6 @@ paths:
             the result.
           schema:
             type: string
-      description: Updates a DiscountCondition
       requestBody:
         content:
           application/json:
@@ -3061,9 +3061,9 @@ paths:
                     $ref: '#/components/schemas/gift_card'
     post:
       operationId: PostGiftCardsGiftCard
-      summary: Create a Gift Card
+      summary: Update a Gift Card
       description: >-
-        Creates a Gift Card that can redeemed by its unique code. The Gift Card
+        Update a Gift Card that can redeemed by its unique code. The Gift Card
         is only valid within 1 region.
       x-authenticated: true
       parameters:
@@ -14205,10 +14205,10 @@ components:
           type: string
           description: The date with timezone at which the resource was deleted.
           format: date-time
-    sales_channel_tax_line:
-      title: Sales Channel
-      description: A Sales Channel
-      x-resourceId: sales_channel_tax_line
+    shipping_method_tax_line:
+      title: Shipping Method Tax Line
+      description: Shipping Method Tax Line
+      x-resourceId: shipping_method_tax_line
       required:
         - shipping_method_id
         - rate
@@ -14318,7 +14318,7 @@ components:
           type: array
           description: Available if the relation `tax_lines` is expanded.
           items:
-            $ref: '#/components/schemas/tax_line'
+            $ref: '#/components/schemas/shipping_method_tax_line'
         price:
           description: >-
             The amount to charge for the Shipping Method. The currency of the

diff --git a/docs/api/admin/components/schemas/shipping_method.yaml b/docs/api/admin/components/schemas/shipping_method.yaml
@@ -59,7 +59,7 @@ properties:
     type: array
     description: Available if the relation `tax_lines` is expanded.
     items:
-      $ref: ./tax_line.yaml
+      $ref: ./shipping_method_tax_line.yaml
   price:
     description: >-
       The amount to charge for the Shipping Method. The currency of the price is

diff --git a/...nents/schemas/sales_channel_tax_line.yaml → ...nts/schemas/shipping_method_tax_line.yaml b/...nents/schemas/sales_channel_tax_line.yaml → ...nts/schemas/shipping_method_tax_line.yaml
@@ -1,6 +1,6 @@
-title: Sales Channel
-description: A Sales Channel
-x-resourceId: sales_channel_tax_line
+title: Shipping Method Tax Line
+description: Shipping Method Tax Line
+x-resourceId: shipping_method_tax_line
 required:
   - shipping_method_id
   - rate

diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
@@ -1,6 +1,7 @@
 post:
   operationId: PostDiscountsDiscountConditions
-  summary: >-
+  summary: Create a DiscountCondition
+  description: >-
     Creates a DiscountCondition. Only one of `products`, `product_types`,
     `product_collections`, `product_tags`, and `customer_groups` should be
     provided.
@@ -26,7 +27,6 @@ post:
         result.
       schema:
         type: string
-  description: Creates a DiscountCondition
   requestBody:
     content:
       application/json:

diff --git a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
@@ -92,7 +92,8 @@ get:
                 $ref: ../components/schemas/discount_condition.yaml
 post:
   operationId: PostDiscountsDiscountConditionsCondition
-  summary: >-
+  summary: Update a DiscountCondition
+  description: >-
     Updates a DiscountCondition. Only one of `products`, `product_types`,
     `product_collections`, `product_tags`, and `customer_groups` should be
     provided.
@@ -124,7 +125,6 @@ post:
         result.
       schema:
         type: string
-  description: Updates a DiscountCondition
   requestBody:
     content:
       application/json:

diff --git a/docs/api/admin/paths/gift-cards_{id}.yaml b/docs/api/admin/paths/gift-cards_{id}.yaml
@@ -55,9 +55,9 @@ get:
                 $ref: ../components/schemas/gift_card.yaml
 post:
   operationId: PostGiftCardsGiftCard
-  summary: Create a Gift Card
+  summary: Update a Gift Card
   description: >-
-    Creates a Gift Card that can redeemed by its unique code. The Gift Card is
+    Update a Gift Card that can redeemed by its unique code. The Gift Card is
     only valid within 1 region.
   x-authenticated: true
   parameters:

diff --git a/docs/api/store-spec3.json b/docs/api/store-spec3.json
@@ -7898,10 +7898,10 @@
           }
         }
       },
-      "sales_channel_tax_line": {
-        "title": "Sales Channel",
-        "description": "A Sales Channel",
-        "x-resourceId": "sales_channel_tax_line",
+      "shipping_method_tax_line": {
+        "title": "Shipping Method Tax Line",
+        "description": "Shipping Method Tax Line",
+        "x-resourceId": "shipping_method_tax_line",
         "required": [
           "shipping_method_id",
           "rate",
@@ -8028,7 +8028,7 @@
             "type": "array",
             "description": "Available if the relation `tax_lines` is expanded.",
             "items": {
-              "$ref": "#/components/schemas/tax_line"
+              "$ref": "#/components/schemas/shipping_method_tax_line"
             }
           },
           "price": {

diff --git a/docs/api/store-spec3.yaml b/docs/api/store-spec3.yaml
@@ -6232,10 +6232,10 @@ components:
           type: string
           description: The date with timezone at which the resource was deleted.
           format: date-time
-    sales_channel_tax_line:
-      title: Sales Channel
-      description: A Sales Channel
-      x-resourceId: sales_channel_tax_line
+    shipping_method_tax_line:
+      title: Shipping Method Tax Line
+      description: Shipping Method Tax Line
+      x-resourceId: shipping_method_tax_line
       required:
         - shipping_method_id
         - rate
@@ -6345,7 +6345,7 @@ components:
           type: array
           description: Available if the relation `tax_lines` is expanded.
           items:
-            $ref: '#/components/schemas/tax_line'
+            $ref: '#/components/schemas/shipping_method_tax_line'
         price:
           description: >-
             The amount to charge for the Shipping Method. The currency of the

diff --git a/docs/api/store/components/schemas/shipping_method.yaml b/docs/api/store/components/schemas/shipping_method.yaml
@@ -59,7 +59,7 @@ properties:
     type: array
     description: Available if the relation `tax_lines` is expanded.
     items:
-      $ref: ./tax_line.yaml
+      $ref: ./shipping_method_tax_line.yaml
   price:
     description: >-
       The amount to charge for the Shipping Method. The currency of the price is

diff --git a/...nents/schemas/sales_channel_tax_line.yaml → ...nts/schemas/shipping_method_tax_line.yaml b/...nents/schemas/sales_channel_tax_line.yaml → ...nts/schemas/shipping_method_tax_line.yaml
@@ -1,6 +1,6 @@
-title: Sales Channel
-description: A Sales Channel
-x-resourceId: sales_channel_tax_line
+title: Shipping Method Tax Line
+description: Shipping Method Tax Line
+x-resourceId: shipping_method_tax_line
 required:
   - shipping_method_id
   - rate