Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Actor Model Supervisors API

Supervision hierarchy

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.example.com/actor-system/v1.

3 operations 3 paths 4 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.example.com/actor-system/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Actor Model Supervisors API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Bearer token for actor system management API access

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Supervisors 3

Supervision hierarchy

GET
/supervisors
Actor Model List Supervisors
listSupervisors 2 params → 200401
GET
/supervisors/{supervisorId}
Actor Model Get Supervisor
getSupervisor 1 param → 200401404
GET
/supervisors/{supervisorId}/children
Actor Model List Supervisor Children
listChildren 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Actor (10 properties), Supervisor (7 properties), ActorList (3 properties), SupervisorList (3 properties). Each schema is shown below with its type and property counts.

SupervisorList
object
Paginated list of supervisors
3 properties
Supervisor
object
A supervisor actor managing a set of child actors
7 properties
Actor
object
An actor in the system with its current state and mailbox info
10 properties
ActorList
object
Paginated list of actors
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

actor-model-supervisors-api-openapi.yml Raw ↑