Skip to content

Releases: openshift-hyperfleet/hyperfleet-api-spec

v1.0.2

13 Jan 11:58
@rh-amarin rh-amarin
v1.0.2
28777bd
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v1.0.2 Latest
Latest

Changes to make openapi.yaml compatible with ogen-codegen go code generator

What's Changed

  • ci: add GitHub Actions workflow for automated releases by @yasun1 in #14
  • Openapi source-of-truth by @rh-amarin in #15
  • feat: standardize TypeSpec schema definitions with enums and validation enhancements by @yasun1 in #17
  • update OWNERS file to not block approval by bot by @yasun1 in #18
  • Define Standard Schema Component Naming Convention for Provider Schemas by @yasun1 in #19
  • Enhance API Schema and Build Process by @rh-amarin in #16
  • Refactor NodePool models to include generation field by @rh-amarin in #20
  • HYPERFLEET-437 - refactor: changes to adopt oapi-codegen by @rh-amarin in #21
  • Fix release GitHub Action to install tsp compiler by @rh-amarin in #22

Full Changelog: v1.0.0...v1.0.2

Contributors

yasun1 and rh-amarin
Assets 4
Loading

v1.0.0 - Initial Stable Release

25 Nov 04:05
@yasun1 yasun1
v1.0.0
5a3af45
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v1.0.0 - Initial Stable Release

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

Loading