Skip to content

cna.qualityModel.entities.RequestTrace

The RequestTrace Node models a Request Trace entity. It allows the inclusion of the various Component, Service, Backing Service and Storage Backing Service entities as well as Link entities that are part of the Request Trace.

File references:      TOSCA-File

Shorthand Name RequestTrace
Type Qualified Name qualityModel:RequestTrace
Type URI cna.qualityModel.entities.RequestTrace

1. Properties

Name Required Type Constraints
Description
endpoint true string N/A The specific External Endpoint for which the Request Trace entity is defined.
nodes false list N/A The existing Component, Service, Backing Service or Storage Backing Service entities which are part of this Request Trace entity.
links true list N/A The existing Link entities which are part of this Request Trace entity.

2. Attributes

Name Required Type Constraints
Description
N/A N/A N/A N/A N/A

3. Definition

cna.qualityModel.entities.RequestTrace:
  derived_from: tosca.nodes.Root
  description: Node Type to model Request Trace entities
  properties:
    endpoint:
      type: string
      required: true
    nodes:
      type: list
      required: false
      entry_schema:
        description: An existing Component, Service, Backing Service or Storage Backing Service entity which is part of this Request Trace entity
        type: string
    links:
      type: list
      required: true
      entry_schema:
        description: An existing Link entity which is part of this Request Trace entity
        type: string
  requirements:
    # Reference to External Endpoint for which the Request Trace is defined
    - external_endpoint:
        capability: tosca.capabilities.Endpoint.Public
        relationship: tosca.relationships.ConnectsTo
        occurrences: [1, 1]

4. Example

get_order_byId:
  type: cna.qualityModel.entities.RequestTrace
  properties:
    endpoint: GET /orders/{orderId}
    nodes:
      - api_gateway
      - order_service
      - kitchen_service
      - delivery_service
      - accounting_service
      - mysql_service
    links:
      - apiGateway_routes-to_orderService-GetOrderById
      - orderService_connects-to_MySQL-ftgoOrderService
      - apiGateway_routes-to_kitchenService-GetTicketsByOrderId
      - kitchenService_connects-to_MySQL-ftgoKitchenService
      - apiGateway_routes-to_deliveryService-GetDeliveriesByOrderId
      - deliveryService_connects-to_MySQL-ftgoDeliveryService
      - apiGateway_routes-to_accountingService-GetChargesByOrderId
      - accountingService_connects-to_MySQL-ftgoAccountingService
  requirements:
    - external_endpoint: api_gateway
Last update: 2022-08-31
Back to top