Zipline Ai schema API

The schema API from Zipline Ai — 5 operation(s) for schema.

OpenAPI Specification

zipline-ai-schema-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Zipline AI Fetcher fetch schema API
  version: v1
  description: HTTP surface of the Chronon fetcher service that powers Zipline AI online feature serving and schema inspection. These endpoints read from the online KV store and metadata uploaded during deploy, and are intended for online GroupBys and Joins. This document was generated by the API Evangelist enrichment pipeline from the provider's published documentation (https://zipline.ai/docs/setup/Fetcher_API); the provider does not publish an OpenAPI definition. Fetcher runs self-hosted within the customer's cloud, so the server host is deployment-specific.
  x-generated-by: api-evangelist-enrichment
  x-generated-method: generated
  x-source: https://zipline.ai/docs/setup/Fetcher_API
servers:
- url: http://localhost:9000
  description: Local sandbox default (docker-compose)
- url: https://{host}
  description: Self-hosted deployment host
  variables:
    host:
      default: zipline.example.com
tags:
- name: schema
paths:
  /v1/joins:
    get:
      tags:
      - schema
      operationId: listJoins
      summary: Lists Chronon joins marked online=True
      responses:
        '200':
          description: List of online joins
  /v1/join/{name}/schema:
    get:
      tags:
      - schema
      operationId: getJoinSchema
      summary: Returns the online fetch schema for a join
      description: Returns the Avro schemas used by online join fetching and logging.
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '200':
          description: Join fetch schema
        '404':
          description: Join not found
  /v1/groupby/{name}/schema:
    get:
      tags:
      - schema
      operationId: getGroupBySchema
      summary: Returns the online fetch schema for a GroupBy
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '200':
          description: GroupBy fetch schema
        '404':
          description: GroupBy not found
  /v1/groupby/{name}/status:
    get:
      tags:
      - schema
      operationId: getGroupByStatus
      summary: Returns online GroupBy upload status
      parameters:
      - $ref: '#/components/parameters/Name'
      responses:
        '200':
          description: Upload status
  /v1/stats/{tableName}:
    get:
      tags:
      - schema
      operationId: getTableStats
      summary: Returns enhanced statistics for a table when stats are available
      parameters:
      - name: tableName
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Table statistics
components:
  parameters:
    Name:
      name: name
      in: path
      required: true
      description: Chronon metadata name. URL-encode names that contain path separators.
      schema:
        type: string