Skip to main content

Workflow API Documentation

Audience​

Developers, frontend engineers, QA, support, security engineers, solution architects and implementation partners.

Overview​

This section documents the verified HTTP surface owned by Workflow Service. Generated OpenAPI output, deployment addresses and database schema details are outside this epic.

Summary​

The Workflow API is Foundation/Transitional. The authoritative inventory contains 17 explicitly mapped application operations: 15 native Workflow operations and two shared operational operations. No Workflow compatibility or gateway operation was found.

Bearer authentication is configured, but no endpoint requires authentication or authorization. Tenant handling varies: mutation commands require tenant context, read operations primarily rely on query filters, and the outbox diagnostic read is not tenant-filtered.

Documentation map​

Use the endpoint catalog as the sole authoritative inventory. Supporting pages cover architecture, definitions, versions, publication, instances, tasks, approval, rejection, delegation, audit, timeline, health, gateway and compatibility, authentication, authorization, tenant context, DTOs, validation, request lifecycle, responses, errors, versioning, testing, limitations and source map.

Maturity​

Definition and task operations are implemented. Backend access enforcement, Gateway routing, versioned HTTP contracts and broad automated API coverage are Not implemented or Requires confirmation.

Requires Confirmation​

Production ingress, mandatory authentication, authorization policies, diagnostic exposure, Gateway ownership, OpenAPI publication and versioning policy require confirmation.

Source References​

  • microservices/src/workflow-service/Api/WorkflowEndpoints.cs
  • microservices/src/workflow-service/Application/Dtos.cs
  • microservices/src/workflow-service/Program.cs
  • microservices/src/workflow-service/Api/EndpointResults.cs

See Also​

Keywords​

Workflow API, approval endpoint, Workflow Service.

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-20
  • Next review: 2026-10-20