module WarpEngine::AdminApi

The Admin API: everything the WarpEngine admin does, for programs, under /api/admin/v1. Operations are declared once in the Definitions modules and served three ways: as JSON over HTTP, as an OpenAPI 3.1 document (OpenApi, with an optional Redoc page from DocsPage) and as MCP tools (Mcp).

It is off by default; the host turns it on in the initializer:

WarpEngine.configure do
  admin_api do
    enable
  end
end

Callers authenticate with a bearer application token carrying admin scopes (Scopes), or through the host’s own Authenticator.

Constants

HEADER: The response header that carries the Admin API version.
Result: What an operation handler returns: the HTTP status, the data of the answer and an optional meta hash (pagination). Built by Context#ok, Context#created and Context#no_content.
VERSION: The major version of the Admin API, also in the URL prefix and the OpenAPI x-api-version.

Public Class Methods

config ()

Source

# File lib/warp_engine/admin_api.rb, line 50
def self.config
  WarpEngine.config.admin_api
end

The host’s WarpEngine::AdminApi::Configuration, from WarpEngine.config.admin_api.

url_path ()

Source

# File lib/warp_engine/admin_api.rb, line 55
def self.url_path
  Operation::PREFIX
end

The URL prefix every Admin API route lives under: Operation::PREFIX.