📝 Ecommerce Vertical docs Updates

panoratech · Aug 7, 2024 · 9784c89 · 9784c89
1 parent 47f0e75
commit 9784c89
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 29 deletions.
diff --git a/docs/ecommerce/customers/list-customers.mdx → docs/ecommerce/customers/list.mdx b/docs/ecommerce/customers/list-customers.mdx → docs/ecommerce/customers/list.mdx
diff --git a/...ommerce/customers/retrieve-a-customer.mdx → docs/ecommerce/customers/retrieve.mdx b/...ommerce/customers/retrieve-a-customer.mdx → docs/ecommerce/customers/retrieve.mdx
diff --git a/docs/ecommerce/fulfillments/list-fulfillments.mdx b/docs/ecommerce/fulfillments/list-fulfillments.mdx
diff --git a/docs/ecommerce/fulfillments/list.mdx b/docs/ecommerce/fulfillments/list.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /ecommerce/fulfillments
+---
diff --git a/...e/fulfillments/retrieve-a-fulfillment.mdx → docs/ecommerce/fulfillments/retrieve.mdx b/...e/fulfillments/retrieve-a-fulfillment.mdx → docs/ecommerce/fulfillments/retrieve.mdx
diff --git a/docs/ecommerce/orders/create-a-order.mdx → docs/ecommerce/orders/create.mdx b/docs/ecommerce/orders/create-a-order.mdx → docs/ecommerce/orders/create.mdx
diff --git a/docs/ecommerce/orders/list-orders.mdx → docs/ecommerce/orders/list.mdx b/docs/ecommerce/orders/list-orders.mdx → docs/ecommerce/orders/list.mdx
diff --git a/docs/ecommerce/orders/retrieve-a-order.mdx → docs/ecommerce/orders/retrieve.mdx b/docs/ecommerce/orders/retrieve-a-order.mdx → docs/ecommerce/orders/retrieve.mdx
diff --git a/docs/ecommerce/products/create-a-product.mdx → docs/ecommerce/products/create.mdx b/docs/ecommerce/products/create-a-product.mdx → docs/ecommerce/products/create.mdx
diff --git a/docs/ecommerce/products/list-product.mdx → docs/ecommerce/products/list.mdx b/docs/ecommerce/products/list-product.mdx → docs/ecommerce/products/list.mdx
diff --git a/...ecommerce/products/retrieve-a-product.mdx → docs/ecommerce/products/retrieve.mdx b/...ecommerce/products/retrieve-a-product.mdx → docs/ecommerce/products/retrieve.mdx
diff --git a/docs/mint.json b/docs/mint.json
@@ -482,33 +482,33 @@
       "group": "Ecommerce Objects",
       "pages": [
         {
-          "group": "Product",
+          "group": "Products",
           "pages": [
-            "ecommerce/products/list-product",
-            "ecommerce/products/retrieve-a-product",
-            "ecommerce/products/create-a-product"
+            "ecommerce/products/list",
+            "ecommerce/products/retrieve",
+            "ecommerce/products/create"
           ]
         },
         {
-          "group": "Order",
+          "group": "Orders",
           "pages": [
-            "ecommerce/orders/list-orders",
-            "ecommerce/orders/create-a-order",
-            "ecommerce/orders/retrieve-a-order"
+            "ecommerce/orders/list",
+            "ecommerce/orders/create",
+            "ecommerce/orders/retrieve"
           ]
         },
         {
-          "group": "Fulfillment",
+          "group": "Fulfillments",
           "pages": [
-            "ecommerce/fulfillments/list-fulfillments",
-            "ecommerce/fulfillments/retrieve-a-fulfillment"
+            "ecommerce/fulfillments/list",
+            "ecommerce/fulfillments/retrieve"
           ]
         },
         {
-          "group": "Customer",
+          "group": "Customers",
           "pages": [
-            "ecommerce/customers/list-customers",
-            "ecommerce/customers/retrieve-a-customer"
+            "ecommerce/customers/list",
+            "ecommerce/customers/retrieve"
           ]
         }
       ]

diff --git a/packages/api/src/ecommerce/customer/customer.controller.ts b/packages/api/src/ecommerce/customer/customer.controller.ts
@@ -37,7 +37,7 @@ export class CustomerController {
 
   @ApiOperation({
     operationId: 'listEcommerceCustomers',
-    summary: 'List a batch of Customers',
+    summary: 'List Customers',
   })
   @ApiHeader({
     name: 'x-connection-token',
@@ -74,8 +74,8 @@ export class CustomerController {
 
   @ApiOperation({
     operationId: 'retrieveEcommerceCustomer',
-    summary: 'Retrieve a Customer',
-    description: 'Retrieve a customer from any connected Ats software',
+    summary: 'Retrieve Customers',
+    description: 'Retrieve customers from any connected Ats software',
   })
   @ApiParam({
     name: 'id',

diff --git a/packages/api/src/ecommerce/fulfillment/fulfillment.controller.ts b/packages/api/src/ecommerce/fulfillment/fulfillment.controller.ts
@@ -37,7 +37,7 @@ export class FulfillmentController {
 
   @ApiOperation({
     operationId: 'listEcommerceFulfillments',
-    summary: 'List a batch of Fulfillments',
+    summary: 'List Fulfillments',
   })
   @ApiHeader({
     name: 'x-connection-token',
@@ -74,8 +74,8 @@ export class FulfillmentController {
 
   @ApiOperation({
     operationId: 'retrieveEcommerceFulfillment',
-    summary: 'Retrieve a Fulfillment',
-    description: 'Retrieve a fulfillment from any connected Ats software',
+    summary: 'Retrieve Fulfillments',
+    description: 'Retrieve fulfillments from any connected Ats software',
   })
   @ApiParam({
     name: 'id',

diff --git a/packages/api/src/ecommerce/order/order.controller.ts b/packages/api/src/ecommerce/order/order.controller.ts
@@ -44,7 +44,7 @@ export class OrderController {
 
   @ApiOperation({
     operationId: 'listEcommerceOrders',
-    summary: 'List a batch of Orders',
+    summary: 'List Orders',
   })
   @ApiHeader({
     name: 'x-connection-token',
@@ -81,8 +81,8 @@ export class OrderController {
 
   @ApiOperation({
     operationId: 'retrieveEcommerceOrder',
-    summary: 'Retrieve a Order',
-    description: 'Retrieve a order from any connected Ats software',
+    summary: 'Retrieve Orders',
+    description: 'Retrieve orders from any connected Ats software',
   })
   @ApiParam({
     name: 'id',

diff --git a/packages/api/src/ecommerce/product/product.controller.ts b/packages/api/src/ecommerce/product/product.controller.ts
@@ -44,7 +44,7 @@ export class ProductController {
 
   @ApiOperation({
     operationId: 'listEcommerceProducts',
-    summary: 'List a batch of Products',
+    summary: 'List Products',
   })
   @ApiHeader({
     name: 'x-connection-token',
@@ -81,8 +81,8 @@ export class ProductController {
 
   @ApiOperation({
     operationId: 'retrieveEcommerceProduct',
-    summary: 'Retrieve a Product',
-    description: 'Retrieve a product from any connected Ats software',
+    summary: 'Retrieve Products',
+    description: 'Retrieve products from any connected Ats software',
   })
   @ApiParam({
     name: 'id',