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

Cluster membership and sharding

This API exposes 2 operations across 2 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.

2 operations 2 paths 4 schemas 2 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 Cluster 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 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Cluster 2

Cluster membership and sharding

GET
/cluster/members
Actor Model List Cluster Members
listClusterMembers 1 param → 200401
GET
/cluster/shards
Actor Model List Cluster Shards
listShards → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ClusterMember (6 properties), Shard (5 properties), ShardList (3 properties), ClusterMemberList (3 properties). Each schema is shown below with its type and property counts.

ClusterMemberList
object
List of cluster members
3 properties
ClusterMember
object
A node in the actor system cluster
6 properties
ShardList
object
List of cluster shards
3 properties
Shard
object
A shard partition in the cluster
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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