OrderService-example.yaml

Version: '1.0'
Date: 14.11.2023

# Order Processing Service Description
Description:
  Name: OrderProcessingService
  Type: Service
  Criticality: Tier2

# Service Functionality
Functionality: Processes customer orders and manages the order database.

# Data Processing Details
DataProcessed:
  Type: Internal
  DataCategory: PCI
  EncryptionAtRest: Yes

# Components Used by the Service
Components:
  Internal:
    Exist: Yes
    Source: Private
    Note: Namespacing
  External:
    Exist: Yes
    PackageManager: Maven

# Pipeline Configuration
Pipeline:
  Type: Jenkins
  CODEOWNERS: No
  BranchProtection: Yes
  SignCommits: No
  PinActions: No

# Network Information
Network:
  Access: Public

# Order Processing Service Data Flow
dataFlow:
  - name: OrderProcessingFlow
    description: Processes customer orders and updates inventory.
    source: OrderSubmissionPortal
    EncryptionTransit: Yes
    Authentication:
      Exist: Yes
      Type: API Keys
    Authorization: admin
    Protocol: HTTPS
    Communication:
      Type: REST APIs
    interactions:
      - from: OrderSubmissionPortal
        to: OrderProcessingService
        method: RESTful API
        protocol: HTTPS
      - from: OrderProcessingService
        to: InventoryDatabase
        method: Update
        protocol: JDBC
    servicesInvolved: [OrderSubmissionPortal, OrderProcessingService, InventoryDatabase]