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 Mailboxes API

Message queue inspection

This API exposes 2 operations across 1 path, and defines 2 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.

2 operations 1 paths 2 schemas 1 GET1 POST

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 Mailboxes 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 2

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

Mailboxes 2

Message queue inspection

POST
/actors/{actorId}/messages
Actor Model Send Message
sendMessage 1 param body → 202401404429
GET
/actors/{actorId}/messages
Actor Model Inspect Mailbox
inspectMailbox 2 params → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ActorMessage (5 properties), MailboxInspection (4 properties). Each schema is shown below with its type and property counts.

ActorMessage
object
A message to be placed in an actor's mailbox
5 properties 2 required
MailboxInspection
object
Inspection of pending messages in an actor's mailbox
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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