@eventcatalog/create-eventcatalog 4.1.2 → 4.2.0-beta.0

package/templates/default/domains/Orders/services/OrdersService/events/OrderCancelled/schema.json

@@ -1,72 +1,71 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "OrderCancelledEvent",
-    "type": "object",
-    "properties": {
-      "orderId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the order that was cancelled."
-      },
-      "userId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the user who placed the order."
-      },
-      "orderItems": {
-        "type": "array",
-        "description": "A list of items included in the cancelled order, each containing product details and quantities.",
-        "items": {
-          "type": "object",
-          "properties": {
-            "productId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "The unique identifier of the product."
-            },
-            "productName": {
-              "type": "string",
-              "description": "The name of the product."
-            },
-            "quantity": {
-              "type": "integer",
-              "description": "The quantity of the product ordered."
-            },
-            "unitPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The price per unit of the product."
-            },
-            "totalPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The total price for this order item (quantity * unit price)."
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OrderCancelledEvent",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the order that was cancelled."
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the user who placed the order."
+    },
+    "orderItems": {
+      "type": "array",
+      "description": "A list of items included in the cancelled order, each containing product details and quantities.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "productId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of the product."
+          },
+          "productName": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "The quantity of the product ordered."
           },
-          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
-        }
-      },
-      "orderStatus": {
-        "type": "string",
-        "description": "The current status of the order after cancellation.",
-        "enum": ["cancelled"]
-      },
-      "totalAmount": {
-        "type": "number",
-        "format": "float",
-        "description": "The total amount of the order that was cancelled."
-      },
-      "cancellationReason": {
-        "type": "string",
-        "description": "The reason for the order cancellation, if provided."
-      },
-      "timestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the order was cancelled."
+          "unitPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The price per unit of the product."
+          },
+          "totalPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The total price for this order item (quantity * unit price)."
+          }
+        },
+        "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
       }
     },
-    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
-    "additionalProperties": false
-  }
-  
+    "orderStatus": {
+      "type": "string",
+      "description": "The current status of the order after cancellation.",
+      "enum": ["cancelled"]
+    },
+    "totalAmount": {
+      "type": "number",
+      "format": "float",
+      "description": "The total amount of the order that was cancelled."
+    },
+    "cancellationReason": {
+      "type": "string",
+      "description": "The reason for the order cancellation, if provided."
+    },
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the order was cancelled."
+    }
+  },
+  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "timestamp"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/index.mdx

@@ -50,6 +50,6 @@ The OrderConfirmed event is triggered when an order has been successfully confir
 
 ## Schema
 
-<Schema file="schema.json"/>
+<Schema file="schema.json" />
 
 <Footer />

package/templates/default/domains/Orders/services/OrdersService/events/OrderConfirmed/schema.json

@@ -1,67 +1,66 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "OrderConfirmedEvent",
-    "type": "object",
-    "properties": {
-      "orderId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the confirmed order."
-      },
-      "userId": {
-        "type": "string",
-        "format": "uuid",
-        "description": "The unique identifier of the user who placed the order."
-      },
-      "orderItems": {
-        "type": "array",
-        "description": "A list of items included in the confirmed order, each containing product details and quantities.",
-        "items": {
-          "type": "object",
-          "properties": {
-            "productId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "The unique identifier of the product."
-            },
-            "productName": {
-              "type": "string",
-              "description": "The name of the product."
-            },
-            "quantity": {
-              "type": "integer",
-              "description": "The quantity of the product ordered."
-            },
-            "unitPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The price per unit of the product."
-            },
-            "totalPrice": {
-              "type": "number",
-              "format": "float",
-              "description": "The total price for this order item (quantity * unitPrice)."
-            }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "OrderConfirmedEvent",
+  "type": "object",
+  "properties": {
+    "orderId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the confirmed order."
+    },
+    "userId": {
+      "type": "string",
+      "format": "uuid",
+      "description": "The unique identifier of the user who placed the order."
+    },
+    "orderItems": {
+      "type": "array",
+      "description": "A list of items included in the confirmed order, each containing product details and quantities.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "productId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "The unique identifier of the product."
+          },
+          "productName": {
+            "type": "string",
+            "description": "The name of the product."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "The quantity of the product ordered."
           },
-          "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
-        }
-      },
-      "orderStatus": {
-        "type": "string",
-        "description": "The current status of the order after confirmation."
-      },
-      "totalAmount": {
-        "type": "number",
-        "format": "float",
-        "description": "The total amount of the confirmed order."
-      },
-      "confirmationTimestamp": {
-        "type": "string",
-        "format": "date-time",
-        "description": "The date and time when the order was confirmed."
+          "unitPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The price per unit of the product."
+          },
+          "totalPrice": {
+            "type": "number",
+            "format": "float",
+            "description": "The total price for this order item (quantity * unitPrice)."
+          }
+        },
+        "required": ["productId", "productName", "quantity", "unitPrice", "totalPrice"]
       }
     },
-    "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
-    "additionalProperties": false
-  }
-  
+    "orderStatus": {
+      "type": "string",
+      "description": "The current status of the order after confirmation."
+    },
+    "totalAmount": {
+      "type": "number",
+      "format": "float",
+      "description": "The total amount of the confirmed order."
+    },
+    "confirmationTimestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date and time when the order was confirmed."
+    }
+  },
+  "required": ["orderId", "userId", "orderItems", "orderStatus", "totalAmount", "confirmationTimestamp"],
+  "additionalProperties": false
+}

package/templates/default/domains/Orders/services/OrdersService/index.mdx

@@ -47,14 +47,34 @@ import Footer from '@catalog/components/footer.astro';
 
 The Orders Service is responsible for managing customer orders within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
 
-<Tiles >
-    <Tile icon="DocumentIcon" href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}  title="View the changelog" description="Want to know the history of this service? View the change logs" />
-    <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
-    <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
-    <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
+<Tiles>
+  <Tile
+    icon="DocumentIcon"
+    href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}
+    title="View the changelog"
+    description="Want to know the history of this service? View the change logs"
+  />
+  <Tile
+    icon="UserGroupIcon"
+    href="/docs/teams/full-stack"
+    title="Contact the team"
+    description="Any questions? Feel free to contact the owners"
+  />
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Sends ${frontmatter.sends.length} messages`}
+    description="This service sends messages to downstream consumers"
+  />
+  <Tile
+    icon="BoltIcon"
+    href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`}
+    title={`Receives ${frontmatter.receives.length} messages`}
+    description="This service receives messages from other services"
+  />
 </Tiles>
 
-## Architecture diagram 
+## Architecture diagram
 
 <NodeGraph />
 

package/templates/default/domains/Orders/services/OrdersService/openapi.yml

@@ -11,7 +11,7 @@ info:
 
 servers:
   - url: https://example.com/
-    
+
 paths:
   /v1/task/{id}:
     put:
@@ -59,7 +59,7 @@ paths:
           required: true
           schema:
             type: string
-    delete: 
+    delete:
       summary: Delete Task
       operationId: DeleteTask
       responses:
@@ -182,4 +182,4 @@ components:
   securitySchemes:
     authorization:
       type: http
-      scheme: bearer
+      scheme: bearer

package/templates/default/domains/Orders/services/OrdersService/order-service-asyncapi.yaml

@@ -2,11 +2,11 @@ asyncapi: 3.0.0
 
 info:
   title: Order service
-  description: | 
+  description: |
     This service is in charge of processing order events.
   version: '1.0.0'
 
-servers: 
+servers:
   topic:
     host: https://mytopic.com
     description: Custom Topic.
@@ -27,7 +27,7 @@ channels:
         summary: Order placed event
         $ref: '#/components/messages/OrderPlaced'
 
-operations: 
+operations:
   onOrderConfirmation:
     summary: Action to confirm an order.
     description: The product availability of an order will lead to the confirmation of the order.
@@ -81,15 +81,15 @@ components:
       description: order model
       properties:
         orderId:
-          "$ref": "#/components/schemas/orderId"
+          '$ref': '#/components/schemas/orderId'
         orderDate:
           description: Date of order submition.
           type: string
           format: date-time
         userId:
-          "$ref": "#/components/schemas/userId"
+          '$ref': '#/components/schemas/userId'
         productId:
-          "$ref": "#/components/schemas/productId"
+          '$ref': '#/components/schemas/productId'
         price:
           type: number
         quantity:
@@ -99,7 +99,7 @@ components:
     EventEnvelope:
       type: object
       allOf:
-      - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
+        - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
       properties:
         id:
           type: string
@@ -116,15 +116,15 @@ components:
 
     EventType:
       type: string
-      enum: 
-        - "order.placed" 
-        - "order.confirmed"
+      enum:
+        - 'order.placed'
+        - 'order.confirmed'
 
     OrderConfirmed:
       type: object
       additionalProperties: false
       allOf:
-        - $ref: '#/components/schemas/EventEnvelope'  
+        - $ref: '#/components/schemas/EventEnvelope'
       properties:
         data:
           $ref: '#/components/schemas/Order'

package/templates/default/domains/Orders/services/OrdersService/queries/GetOrder/index.mdx

@@ -5,11 +5,11 @@ version: 0.0.1
 summary: |
   GET request that will return detailed information about a specific order, identified by its orderId.
 owners:
-    - dboyne
+  - dboyne
 badges:
-    - content: Recently updated!
-      backgroundColor: green
-      textColor: green
+  - content: Recently updated!
+    backgroundColor: green
+    textColor: green
 schemaPath: schema.json
 ---
 
@@ -23,4 +23,4 @@ This query can be applied in e-commerce systems, marketplaces, or any platform w
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/changelog.mdx

@@ -1,3 +1,3 @@
 ---
 createdAt: 2024-08-01
----
+---

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/index.mdx

@@ -33,7 +33,7 @@ import Footer from '@catalog/components/footer.astro';
 
 The Orders Service is responsible for managing customer orders within the system. It handles order creation, updating, status tracking, and interactions with other services such as Inventory, Payment, and Notification services to ensure smooth order processing and fulfillment.
 
-## Architecture diagram 
+## Architecture diagram
 
 <NodeGraph />
 

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/openapi.yml

@@ -11,7 +11,7 @@ info:
 
 servers:
   - url: https://example.com/
-    
+
 paths:
   /v1/task/{id}:
     put:

package/templates/default/domains/Orders/services/OrdersService/versioned/0.0.2/order-service-asyncapi.yaml

@@ -2,11 +2,11 @@ asyncapi: 3.0.0
 
 info:
   title: Order service
-  description: | 
+  description: |
     This service is in charge of processing order events.
   version: '1.0.0'
 
-servers: 
+servers:
   topic:
     host: https://mytopic.com
     description: Custom Topic.
@@ -27,7 +27,7 @@ channels:
         summary: Order placed event
         $ref: '#/components/messages/OrderPlaced'
 
-operations: 
+operations:
   onOrderConfirmation:
     summary: Action to confirm an order.
     description: The product availability of an order will lead to the confirmation of the order.
@@ -81,15 +81,15 @@ components:
       description: order model
       properties:
         orderId:
-          "$ref": "#/components/schemas/orderId"
+          '$ref': '#/components/schemas/orderId'
         orderDate:
           description: Date of order submition.
           type: string
           format: date-time
         userId:
-          "$ref": "#/components/schemas/userId"
+          '$ref': '#/components/schemas/userId'
         productId:
-          "$ref": "#/components/schemas/productId"
+          '$ref': '#/components/schemas/productId'
         price:
           type: number
         quantity:
@@ -99,7 +99,7 @@ components:
     EventEnvelope:
       type: object
       allOf:
-      - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
+        - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
       properties:
         id:
           type: string
@@ -116,15 +116,15 @@ components:
 
     EventType:
       type: string
-      enum: 
-        - "order.placed" 
-        - "order.confirmed"
+      enum:
+        - 'order.placed'
+        - 'order.confirmed'
 
     OrderConfirmed:
       type: object
       additionalProperties: false
       allOf:
-        - $ref: '#/components/schemas/EventEnvelope'  
+        - $ref: '#/components/schemas/EventEnvelope'
       properties:
         data:
           $ref: '#/components/schemas/Order'

package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   POST request that will cancel a shipment, identified by its shipmentId.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -20,4 +20,3 @@ This command can be applied in e-commerce systems, marketplaces, or any platform
 <SchemaViewer file="schema.json" title="Schema" maxHeight="500" />
 
 <NodeGraph />
-

package/templates/default/domains/Orders/services/ShippingService/commands/CancelShipment/schema.json

@@ -1,13 +1,13 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "CancelShipment",
-    "description": "Schema for cancelling a shipment",
-    "properties": {
-        "shipmentId": {
-            "type": "string",
-            "description": "Unique identifier for the shipment"
-        }
-    },
-    "required": ["shipmentId"]
-}
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "CancelShipment",
+  "description": "Schema for cancelling a shipment",
+  "properties": {
+    "shipmentId": {
+      "type": "string",
+      "description": "Unique identifier for the shipment"
+    }
+  },
+  "required": ["shipmentId"]
+}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   POST request that will create a return label for a specific shipment, identified by its shipmentId.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This command can be applied in e-commerce systems, marketplaces, or any platform
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

package/templates/default/domains/Orders/services/ShippingService/commands/CreateReturnLabel/schema.json

@@ -1,19 +1,19 @@
 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "CreateReturnLabel",
-    "description": "Schema for creating a return shipping label",
-    "properties": {
-        "CreateReturnLabel": {
-            "type": "object",
-            "properties": {
-                "shipmentId": {
-                    "type": "string",
-                    "description": "Unique identifier for the shipment"
-                }
-            },
-            "required": ["shipmentId"]
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "CreateReturnLabel",
+  "description": "Schema for creating a return shipping label",
+  "properties": {
+    "CreateReturnLabel": {
+      "type": "object",
+      "properties": {
+        "shipmentId": {
+          "type": "string",
+          "description": "Unique identifier for the shipment"
         }
-    },
-    "required": ["CreateReturnLabel"]
-}
+      },
+      "required": ["shipmentId"]
+    }
+  },
+  "required": ["CreateReturnLabel"]
+}

package/templates/default/domains/Orders/services/ShippingService/commands/CreateShipment/index.mdx

@@ -5,7 +5,7 @@ version: 0.0.1
 summary: |
   POST request that will create a shipment for a specific order, identified by its orderId.
 owners:
-    - dboyne
+  - dboyne
 schemaPath: schema.json
 ---
 
@@ -19,4 +19,4 @@ This command can be applied in e-commerce systems, marketplaces, or any platform
 
 <NodeGraph />
 
-<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />