Skip to content

v1.0.0 - Initial Stable Release

Choose a tag to compare

@yasun1 yasun1 released this 25 Nov 04:05
· 67 commits to main since this release
5a3af45

HyperFleet API Specification v1.0.0

First official stable release of the HyperFleet API specification.

What's Included

  • Core API (core-openapi.yaml): Generic cluster spec using Record<unknown>
  • GCP API (gcp-openapi.yaml): GCP-specific cluster spec

Features

  • Complete CRUD operations for clusters, nodepools, and statuses
  • Status tracking and reporting
  • Comprehensive status history management
  • Kubernetes-style timestamp conventions
  • Standardized status entity with separate reporting mechanisms
  • List-based pagination for resource collections

Architecture

The HyperFleet API provides simple CRUD operations only:

  • No business logic: Pure data persistence layer
  • Separation of concerns: API layer focuses on data persistence; orchestration logic is handled by external components

Consuming the Specifications

Always get the latest stable version:

# Core API
curl -L -O https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/latest/download/core-openapi.yaml

# GCP API
curl -L -O https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/latest/download/gcp-openapi.yaml

Download this specific version (v1.0.0):

# Core API
curl -L -O https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/download/v1.0.0/core-openapi.yaml

# GCP API
curl -L -O https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/download/v1.0.0/gcp-openapi.yaml

Use in Code Generation

# Generate Go client from Core API
openapi-generator generate -i https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/latest/download/core-openapi.yaml -g go -o ./client

# Generate Python client from GCP API
openapi-generator generate -i https://github.com/openshift-hyperfleet/hyperfleet-api-spec/releases/latest/download/gcp-openapi.yaml -g python -o ./client

Documentation


🤖 Generated with HyperFleet Release Automation