Skip to content

Releases: openshift-hyperfleet/hyperfleet-api-spec

v1.0.12

11 May 18:57
98cfd7e

Choose a tag to compare

What's Changed

  • HYPERFLEET-1017 - refactor: rename Available to LastKnownReconciled and align example reasons by @rafabene in #43

Full Changelog: v1.0.11...v1.0.12

v1.0.11

11 May 09:19
d8a0f05

Choose a tag to compare

What's Changed

  • HYPERFLEET-452 - feat: implement RFC 9457 Problem Details error model by @rafabene in #23
  • HYPERFLEET-452 - refactor: align ValidationError model with hyperfleet-api by @rafabene in #24
  • HYPERFLEET-386 - feat: use ready/available conditions instead of phase by @rh-amarin in #25
  • HYPERFLEET-622 - feat: align name validation with Clusters Service rules by @rafabene in #26
  • HYPERFLEET-702: Update OWNERS file by @rafabene in #27
  • HYPERFLEET-761 - docs: align with documentation standards by @rh-amarin in #30
  • HYPERFLEET-732 - feat: replace existing IDs with RFC4122 UUID v7 for both Cluster and NodePool IDs by @86254860 in #29
  • HYPERFLEET-543 - feat: add soft-delete endpoints for clusters and nodepools by @mliptak0 in #31
  • HYPERFLEET-981 - chore: add kuudori and ma-hill to OWNERS by @rafabene in #33
  • HYPERFLEET-545 - feat: add PATCH operations for clusters and nodepools by @Mischulee in #32
  • HYPERFLEET-853 - feat: Add Reconciled to OpenAPI spec by @tirthct in #34
  • HYPERFLEET-978 - feat: (1/2) Add PUT command for internal status endpoints … by @ma-hill in #36
  • HYPERFLEET-971 - feat: 409 Conflict responses + version bump + CHANGELOG by @kuudori in #35
  • HYPERFLEET-1031 - test: draft PR for Jira automation testing by @rafabene in #39
  • HYPERFLEET-1031 - test: second draft PR for automation testing by @rafabene in #41
  • HYPERFLEET-1017 - feat: rename aggregated condition Available to LastKnownReconciled by @rafabene in #38
  • HYPERFLEET-1024 - feat: CI for schema checks, version bump, externalize as Go module by @mliptak0 in #42

New Contributors

Full Changelog: v1.0.2...v1.0.11

v1.0.2

13 Jan 11:58
28777bd

Choose a tag to compare

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

v1.0.0 - Initial Stable Release

25 Nov 04:05
5a3af45

Choose a tag to compare

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