API_Controllers.md

graph LR
    API_Controllers["API-Controllers"]
    Auth_Middleware["Auth-Middleware"]
    Flow_Repository["Flow Repository"]
    Execution_Result_Repository["Execution-Result Repository"]
    Stardog_Service["Stardog Service"]
    SDOS_Client["SDOS Client"]
    Persist_Service["Persist Service"]
    Unclassified["Unclassified"]
    API_Controllers -- "Decorator (wraps handler)" --> Auth_Middleware
    API_Controllers -- "Read/Write (CRUD)" --> Flow_Repository
    API_Controllers -- "Persist (store execution metadata)" --> Execution_Result_Repository
    API_Controllers -- "Graph Update / Delete" --> Stardog_Service
    API_Controllers -- "Async Orchestration (POST)" --> SDOS_Client
    API_Controllers -- "Validate & Serialize (graph payload)" --> Persist_Service
    Auth_Middleware -- "Token Injection (stardog OBO)" --> Stardog_Service
    Auth_Middleware -- "Token Injection (sdos OBO)" --> SDOS_Client
    Flow_Repository -- "ORM Access" --> Prisma_DB
    Execution_Result_Repository -- "ORM Access" --> Prisma_DB
    Stardog_Service -- "HTTP SPARQL / Graph Ops" --> Stardog_Server
    SDOS_Client -- "HTTP POST" --> SDOS_Endpoint
    click API_Controllers href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/sdos-orchestration-flow-designer/API_Controllers.md" "Details"

Loading

Details

The Flow‑Orchestration subsystem provides a set of Next.js API routes that act as thin controllers for HTTP requests related to workflow management. Each request is first wrapped by an authentication middleware that validates the Next‑Auth session and injects Azure‑AD OBO tokens for downstream services. Controllers delegate CRUD operations to a Prisma‑based Flow Repository, store execution metadata via an Execution‑Result Repository, validate and serialize graph payloads through a Persist Service, and interact with external systems: the Stardog Service for RDF graph management and the SDOS Client for asynchronous orchestration calls to the Scania Data Orchestration Service. The overall flow is: client → API‑Controller → Auth‑Middleware → (Flow Repository | Execution‑Result Repository | Stardog Service | SDOS Client) → persistence layers (PostgreSQL via Prisma, Stardog RDF store).

API-Controllers [Expand]

Thin façade for HTTP requests. Parses payloads, validates methods, invokes auth middleware, and delegates work to repositories, services, and external adapters, returning JSON responses.

Related Classes/Methods:

• src/pages/api/flow/[id].ts
• src/pages/api/flows/index.ts
• src/pages/api/persist/index.ts
• src/pages/api/execute/async.ts

Auth-Middleware

Higher‑order function that extracts the Next‑Auth session, injects Azure‑AD OBO tokens for Stardog and SDOS, and aborts unauthenticated calls.

Related Classes/Methods:

• src/lib/backend/withAuth.ts

Flow Repository

Prisma‑based data‑access layer that performs CRUD operations on the Flow table (metadata, versioning, draft flag) in PostgreSQL.

Related Classes/Methods:

• prisma.flow
• prisma.flow

Execution-Result Repository

Prisma‑based repository that stores execution metadata (IRI, result‑graph URI, database, parameters) after an async orchestration request.

Related Classes/Methods:

• prisma.executionResult

Stardog Service

Wrapper around the Stardog JavaScript client; provides methods to fetch classes, update, delete, and retrieve graphs in the external RDF store.

Related Classes/Methods:

• src/services/stardogService.ts

SDOS Client

Inline Axios call that posts orchestration requests to the external Scania Data Orchestration Service (SDOS) endpoint, returning execution IDs and result‑graph information.

Related Classes/Methods:

• axios.post

Persist Service

Utility that validates incoming graph payloads and converts UI state (nodes, edges) into JSON‑LD for storage in Stardog.

Related Classes/Methods:

• src/services/graphSchema.ts

Unclassified

Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)

Related Classes/Methods: None

FAQ