Orbital Caches API

The Caches API from Orbital — 1 operation(s) for caches.

OpenAPI Specification

orbital-caches-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Orbital Query Caches API
  description: The Orbital Query API allows developers to submit TaxiQL queries to the Orbital data gateway for integrating, transforming, and discovering data across APIs, databases, event streams, and other data sources. Queries are written in TaxiQL, a technology-agnostic query language, and submitted to the /api/taxiql endpoint. Results can be returned as a single JSON batch or streamed via Server-Sent Events. Orbital automatically orchestrates the required data fetching across connected services based on semantic type metadata in your API specs.
  version: 1.0.0
  contact:
    name: Orbital Support
    url: https://orbitalhq.com/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://localhost:9022
  description: Local Orbital Server
tags:
- name: Caches
paths:
  /api/caches:
    get:
      operationId: listCaches
      summary: Orbital List cache configurations
      description: Returns information about configured caches. Orbital can use external caches like Redis or Hazelcast, or its built-in per-query cache.
      responses:
        '200':
          description: A list of cache configurations.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CacheEntry'
      tags:
      - Caches
components:
  schemas:
    CacheEntry:
      type: object
      description: A cache configuration entry.
      properties:
        name:
          type: string
          description: Name of the cache configuration.
        type:
          type: string
          description: Cache implementation type.
          enum:
          - IN_MEMORY
          - REDIS
          - HAZELCAST
        status:
          type: string
          description: Current status of the cache.
          enum:
          - ACTIVE
          - INACTIVE