@eventcatalog/create-eventcatalog 2.0.22 → 2.1.0

package/templates/default/domains/Orders/services/OrdersService/changelog.md

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

package/templates/default/{events/Order → domains/Orders/services/OrdersService/events}/OrderAmended/index.md

@@ -15,12 +15,20 @@ badges:
       backgroundColor: yellow
       textColor: yellow
 schemaPath: schema.avro
+channels:
+  - id: orders.{env}.events
+    parameters:
+      env: staging
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The OrderAmended event is triggered whenever an existing order is modified. This event ensures that all relevant services are notified of changes to an order, such as updates to order items, quantities, shipping information, or status. The event allows the system to maintain consistency and ensure that all dependent services can react appropriately to the amendments.
 
+<NodeGraph />
+
 ## Example payload
 
 ```json title="Example Payload"
@@ -51,3 +59,4 @@ The OrderAmended event is triggered whenever an existing order is modified. This
 
 <Schema file="schema.json" />
 
+<Footer />

package/templates/default/{events/Order → domains/Orders/services/OrdersService/events}/OrderCancelled/index.md

@@ -15,8 +15,12 @@ badges:
       backgroundColor: yellow
       textColor: yellow
 schemaPath: 'schema.json'
+channels:
+  - id: orders.{env}.events
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The OrderCancelled event is triggered whenever an existing order is cancelled. This event ensures that all relevant services are notified of the cancellation, allowing them to take appropriate actions such as updating inventory levels, refunding payments, and notifying the user. The event helps maintain consistency across the system by ensuring all dependent services are aware of the order cancellation.
@@ -48,4 +52,6 @@ The OrderCancelled event is triggered whenever an existing order is cancelled. T
 
 JSON schema for the event.
 
-<Schema title="JSON Schema" file="schema.json"/>
+<Schema title="JSON Schema" file="schema.json"/>
+
+<Footer />

package/templates/default/{events/Order → domains/Orders/services/OrdersService/events}/OrderConfirmed/index.md

@@ -15,8 +15,12 @@ badges:
       backgroundColor: yellow
       textColor: yellow
 schemaPath: schema.json
+channels:
+  - id: orders.{env}.events
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 The OrderConfirmed event is triggered when an order has been successfully confirmed. This event notifies relevant services that the order is ready for further processing, such as inventory adjustment, payment finalization, and preparation for shipping.
@@ -48,4 +52,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/{services → domains/Orders/services}/OrdersService/index.md

@@ -1,6 +1,6 @@
 ---
 id: OrdersService
-version: 0.0.2
+version: 0.0.3
 name: Orders Service
 summary: |
   Service that handles orders
@@ -9,28 +9,37 @@ owners:
 receives:
   - id: InventoryAdjusted
     version: 0.0.3
+  - id: GetOrder
 sends:
+  - id: OrderAmended
+  - id: OrderCancelled
+  - id: OrderConfirmed
   - id: AddInventory  
     version: 0.0.3
 repository:
   language: JavaScript
-  url: https://github.com/boyney123/pretend-shipping-service
+  url: https://github.com/event-catalog/pretend-shipping-service
 schemaPath: "openapi.yml"
 specifications:
+  asyncapiPath: order-service-asyncapi.yaml
   openapiPath: openapi.yml
 ---
 
+import Footer from '@catalog/components/footer.astro';
+
 ## Overview
 
 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/users/dboyne" title="Contact the owner" description="Any questions? Feel free to contact the owners" />
+    <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 
 
-<NodeGraph />
+<NodeGraph />
+
+<Footer />

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

@@ -0,0 +1,185 @@
+openapi: 3.1.0
+info:
+  title: Simple Task - API
+  version: 1.0.2
+  description: Simple Api
+  contact: {}
+  license:
+    name: apache 2.0
+    identifier: apache-2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+servers:
+  - url: https://example.com/
+    
+paths:
+  /v1/task/{id}:
+    put:
+      summary: Do Simple Task
+      operationId: DoSimpleTask
+      responses:
+        '200':
+          description: do a task by id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Task'
+        '204':
+          description: No content
+        '400':
+          description: Problem with data
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Not Authorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Unauthorized'
+        '404':
+          description: not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      description: Allows to do a simple task
+      security:
+        - authorization: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+    delete: 
+      summary: Delete Task
+      operationId: DeleteTask
+      responses:
+        '204':
+          description: Task deleted
+        '400':
+          description: Problem with data
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Not Authorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Unauthorized'
+        '404':
+          description: not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      description: Delete a task
+      security:
+        - authorization: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+  /v1/tasks:
+    get:
+      summary: Get List of Tasks
+      operationId: GetTaskList
+      responses:
+        '200':
+          description: Successfully retrieved list of tasks
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Task'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Not Authorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Unauthorized'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      description: Retrieves a list of all tasks
+      security:
+        - authorization: []
+      parameters:
+        - in: query
+          name: limit
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 20
+          description: The maximum number of tasks to return
+        - in: query
+          name: offset
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+          description: The number of tasks to skip before starting to return results
+
+components:
+  schemas:
+    Task:
+      properties:
+        comments:
+          type: string
+        creationDate:
+          type: string
+        taskId:
+          type: string
+        description:
+          type: string
+        lastUpdate:
+          type: string
+      type: object
+      additionalProperties: false
+    Error:
+      properties:
+        error:
+          type: string
+      required:
+        - error
+      type: object
+    Unauthorized:
+      properties:
+        message:
+          type: string
+      required:
+        - message
+      type: object
+  securitySchemes:
+    authorization:
+      type: http
+      scheme: bearer

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

@@ -0,0 +1,148 @@
+asyncapi: 3.0.0
+
+info:
+  title: Order service
+  description: | 
+    This service is in charge of processing order events.
+  version: '1.0.0'
+
+servers: 
+  topic:
+    host: https://mytopic.com
+    description: Custom Topic.
+    protocol: HTTPS
+
+defaultContentType: application/json
+
+channels:
+  orderEventsChannel:
+    address: 'orders.{orderId}'
+    description: All Order related events are distributed and broadcasted for the interested consumers.
+    title: Order events channel
+    messages:
+      OrderConfirmed:
+        summary: Order confirmed event
+        $ref: '#/components/messages/OrderConfirmed'
+      OrderPlaced:
+        summary: Order placed event
+        $ref: '#/components/messages/OrderPlaced'
+
+operations: 
+  onOrderConfirmation:
+    summary: Action to confirm an order.
+    description: The product availability of an order will lead to the confirmation of the order.
+    title: Order Confirmed
+    channel:
+      $ref: '#/channels/orderEventsChannel'
+    action: send
+  onOrderPlacement:
+    summary: Action to place an order.
+    description: The reception and validation of an order will lead to the placement of the order.
+    title: Order Placed
+    channel:
+      $ref: '#/channels/orderEventsChannel'
+    action: send
+
+components:
+  messages:
+    OrderConfirmed:
+      payload:
+        $ref: '#/components/schemas/OrderConfirmed'
+
+    OrderPlaced:
+      payload:
+        $ref: '#/components/schemas/OrderPlaced'
+
+  schemas:
+    orderId:
+      description: The unique identifier of an order
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    userId:
+      description: The unique identifier of a user
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    productId:
+      description: The product unique identifier
+      type: string
+      pattern: ^([A-Za-z0-9_-]{21})$
+
+    Order:
+      required:
+        - orderId
+        - userId
+        - productId
+        - price
+        - quantity
+        - orderDate
+      type: object
+      description: order model
+      properties:
+        orderId:
+          "$ref": "#/components/schemas/orderId"
+        orderDate:
+          description: Date of order submition.
+          type: string
+          format: date-time
+        userId:
+          "$ref": "#/components/schemas/userId"
+        productId:
+          "$ref": "#/components/schemas/productId"
+        price:
+          type: number
+        quantity:
+          type: integer
+      title: Order
+
+    EventEnvelope:
+      type: object
+      allOf:
+      - $ref: 'https://raw.githubusercontent.com/cloudevents/spec/v1.0.1/spec.json'
+      properties:
+        id:
+          type: string
+          format: uuid
+        idempotencykey:
+          type: string
+          format: uuid
+        correlationid:
+          type: string
+          format: uuid
+        causationid:
+          type: string
+          format: uuid
+
+    EventType:
+      type: string
+      enum: 
+        - "order.placed" 
+        - "order.confirmed"
+
+    OrderConfirmed:
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: '#/components/schemas/EventEnvelope'  
+      properties:
+        data:
+          $ref: '#/components/schemas/Order'
+        type:
+          $ref: '#/components/schemas/EventType'
+
+      required:
+        - data
+
+    OrderPlaced:
+      type: object
+      additionalProperties: false
+      allOf:
+        - $ref: '#/components/schemas/EventEnvelope'
+      properties:
+        data:
+          $ref: '#/components/schemas/Order'
+        type:
+          $ref: '#/components/schemas/EventType'
+      required:
+        - data

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

@@ -0,0 +1,26 @@
+---
+id: GetOrder
+name: Get order details
+version: 0.0.1
+summary: |
+  GET request that will return detailed information about a specific order, identified by its orderId.
+owners:
+    - dboyne
+badges:
+    - content: Recently updated!
+      backgroundColor: green
+      textColor: green
+schemaPath: schema.json
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+The `GetOrder` message is a query used to retrieve detailed information about a specific order, identified by its `orderId`. It provides information such as the order status (e.g., pending, completed, shipped), the items within the order, billing and shipping details, payment information, and the order's total amount. This query is commonly used by systems managing order processing, customer service, or order tracking functionalities.
+
+This query can be applied in e-commerce systems, marketplaces, or any platform where users and systems need real-time order data for tracking, auditing, or managing customer purchases.
+
+<NodeGraph />
+
+<SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />

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

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

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

@@ -0,0 +1,34 @@
+---
+id: OrdersService
+version: 0.0.2
+name: Orders Service
+summary: |
+  Service that handles orders
+owners:
+    - dboyne
+receives:
+  - id: InventoryAdjusted
+    version: 0.0.3
+sends:
+  - id: AddInventory  
+    version: 0.0.3
+repository:
+  language: JavaScript
+  url: https://github.com/event-catalog/pretend-shipping-service
+schemaPath: "openapi.yml"
+specifications:
+  asyncapiPath: order-service-asyncapi.yaml
+  openapiPath: openapi.yml
+---
+
+import Footer from '@catalog/components/footer.astro';
+
+## Overview
+
+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 
+
+<NodeGraph />
+
+<Footer />

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

@@ -0,0 +1,96 @@
+openapi: 3.1.0
+info:
+  title: Simple Task - API
+  version: 1.0.0
+  description: Simple Api
+  contact: {}
+  license:
+    name: apache 2.0
+    identifier: apache-2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+servers:
+  - url: https://example.com/
+    
+paths:
+  /v1/task/{id}:
+    put:
+      summary: Do Simple Task
+      operationId: DoSimpleTask
+      responses:
+        '200':
+          description: do a task by id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Task'
+        '204':
+          description: No content
+        '400':
+          description: Problem with data
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: Not Authorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Unauthorized'
+        '404':
+          description: not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+      description: Allows to do a simple task
+      security:
+        - authorization: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+
+components:
+  schemas:
+    Task:
+      properties:
+        comments:
+          type: string
+        creationDate:
+          type: string
+        taskId:
+          type: string
+        description:
+          type: string
+        lastUpdate:
+          type: string
+      type: object
+      additionalProperties: false
+    Error:
+      properties:
+        error:
+          type: string
+      required:
+        - error
+      type: object
+    Unauthorized:
+      properties:
+        message:
+          type: string
+      required:
+        - message
+      type: object
+  securitySchemes:
+    authorization:
+      type: http
+      scheme: bearer