Service catalog

yaml

# catalog-info.yaml
#
# Lives at the root of THIS service's own repo.
# Owned and kept current by this service's team, reviewed in normal PRs.
# Aggregated (on a schedule or on push) into the central service catalog
# that planning agents read for cross-repo feature work.

service: <orders-service>
description: <One sentence: what this service owns>
owner: <team-checkout>
repo: <https://github.com/org/orders-service>
language: <typescript>
tier: <tier-1>   # tier-1: customer-facing / critical path
                 # tier-2: internal
                 # tier-3: batch or tooling

# What this service exposes to other services
exposes:
  - type: <rest>          # rest | grpc | event | graphql
    name: <orders-api>
    contract: <contracts/openapi/orders-api.yaml>
  - type: <event>
    name: <order.created>
    contract: <contracts/events/order-created.schema.json>

# What this service depends on
depends_on:
  - service: <payments-service>
    via: <rest>            # rest | grpc | event | graphql
    contract: <contracts/openapi/payments-api.yaml>
  - service: <inventory-service>
    via: <event>
    contract: <contracts/events/inventory-reserved.schema.json>

deploy:
  pipeline: <.github/workflows/deploy.yml>
  environments: [<staging>, <production>]

links:
  runbook: <https://wiki.internal/orders-service/runbook>
  dashboard: <https://grafana.internal/d/orders-service>