Manifest Format

A service's Manifest is one JSON document (format 1): its bounded contexts, their aggregates with the commands and events they speak, their subscriptions, the framework's error codes, and the JSON Schema 2020-12 of every payload under $defs. A module's fragment (META-INF/wow/manifest/<module>.json) has the same shape without service. This outline of every object and its keys is generated from the code that writes it, ManifestTree.

What the writer leaves out:

Absent optional values (a null description, unknown produces, derives, schedules or transformsTo, a fragment's service, a subscription's retry or job) are left out, not written as null, and so are a subscription source's nullableState and a command's mounted, system and internal when false, an aggregate's ownership when it is OWNER, the default, its idSource when it is ASSIGNED, the default, its retired events and its access attributes when it has none, an access attribute's multiple when false, and the Manifest's requires when it has none.

Manifest

• format
• requires: left out when absent or at its default
• service: object; left out when absent or at its default
  • name
  • version
• contexts: array of Context
• errors: array of Error
• $defs

Context

• name
• description
• aggregates: array of Aggregate
• subscriptions: array of Subscription
• published: array of objects
  • aggregate
  • topic
  • includeState
• errors: array of Error
• commands: array of Command; left out when absent or at its default
• routes: array of ServiceRoute; left out when absent or at its default

ServiceRoute

• name
• route
• parameters: array of objects; left out when absent or at its default
  • name
  • in
  • schema
  • required
• request
• response
• responseOptional: left out when absent or at its default
• errors: left out when absent or at its default
• description
• deprecated: left out when absent or at its default

Command

• name
• aliases
• schema
• creation
• produces
• routes: array of Route
• mounted: left out when absent or at its default
• system: left out when absent or at its default
• internal: left out when absent or at its default
• transformsTo
• idProperty
• description

Error

• code
• status
• description
• retry: left out when absent or at its default
• retryAfter

Aggregate

• name
• description
• state: object
  • schema
  • fingerprint
  • view
• snapshot: object
  • enabled
  • stateRevision: left out when absent or at its default
• commands: array of Command
• events: array of objects
  • name
  • aliases
  • revision
  • schema
  • description
• queries: array of objects
  • model
  • routes: array of Route
• schedules
• ownership: left out when absent or at its default
• retired: left out when absent or at its default
• idSource: left out when absent or at its default
• access: array of objects; left out when absent or at its default
  • name
  • type
  • multiple: left out when absent or at its default

Route

• method
• path

Subscription

• name
• kind
• source: object
  • context
  • aggregates
  • events
  • eventSchemas: left out when absent or at its default
  • nullableState: left out when absent or at its default
• function: object
  • kind
  • context
  • processor
  • name
• derives
• rejected
• committed
• calls
• start: left out when absent or at its default
• schedules
• retry: object; left out when absent or at its default
  • maxAttempts
  • initialBackoff
  • maxBackoff
  • timeout
  • recoverable
  • unrecoverable
  • systemic
  • multiplier
• job: object; left out when absent or at its default
  • name
  • cron
  • zone
  • scope
  • misfire