Skip to content

Commit 76039e6

Browse files
kuudorikuudori
committed
HYPERFLEET-1083 feat: add generic Resource type and Channel/Version spec schemas
1 parent aeb51fc commit 76039e6

25 files changed

Lines changed: 5667 additions & 760 deletions

‎CHANGELOG.md‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,24 @@
22

33
All notable changes to the HyperFleet API specification will be documented in this file.
44

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.16/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [Unreleased]
99

10+
## [1.0.16] - 2026-05-19
11+
12+
### Added
13+
14+
- Generic `Resource` type with `kind` discriminator and JSONB `spec` field, replacing per-entity model hierarchies for new resource types (HYPERFLEET-1083)
15+
- `ResourceCreateRequest`, `ResourcePatchRequest`, `ResourceList`, `ResourceStatus` types in core contract
16+
- Generic `/resources` CRUD routes in core contract (GET list, GET by ID, POST, PATCH, DELETE) per design doc Section 3.2
17+
- `GET /resources/{id}/statuses` route for adapter status listing
18+
- `references` field on Resource for non-ownership associations between entities (Section 9)
19+
- `ChannelSpec` validation schema in GCP contract (`is_default`, `enabled_regex`)
20+
- `VersionSpec` validation schema in GCP contract (`raw_version`, `enabled`, `is_default`, `release_image`, `end_of_life_time`)
21+
- `KindChannel` and `KindVersion` kind aliases in GCP contract
22+
1023
## [1.0.15] - 2026-05-18
1124

1225
### Added
@@ -146,7 +159,8 @@ First official stable release of the HyperFleet API specification.
146159
- Interactive API documentation
147160

148161
<!-- Links -->
149-
[Unreleased]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.15...HEAD
162+
[Unreleased]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.16...HEAD
163+
[1.0.16]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.15...v1.0.16
150164
[1.0.15]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.14...v1.0.15
151165
[1.0.14]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.13...v1.0.14
152166
[1.0.13]: https://github.com/openshift-hyperfleet/hyperfleet-api-spec/compare/v1.0.12...v1.0.13

‎aliases-gcp.tsp‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,14 @@ import "./models-gcp/nodepool/model.tsp";
66
import "./models-gcp/nodepool/example_nodepool.tsp";
77
import "./models-gcp/nodepool/example_post.tsp";
88
import "./models-gcp/nodepool/example_patch.tsp";
9+
import "./models-gcp/channel/model.tsp";
10+
import "./models-gcp/channel/example_channel.tsp";
11+
import "./models-gcp/channel/example_post.tsp";
12+
import "./models-gcp/channel/example_patch.tsp";
13+
import "./models-gcp/version/model.tsp";
14+
import "./models-gcp/version/example_version.tsp";
15+
import "./models-gcp/version/example_post.tsp";
16+
import "./models-gcp/version/example_patch.tsp";
17+
import "./services/channels.tsp";
18+
import "./services/versions.tsp";
19+
import "./services/statuses-internal-gcp.tsp";

‎aliases.tsp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
aliases-gcp.tsp
1+
aliases-core.tsp

‎main.tsp‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import "@typespec/openapi3";
55
import "./services/clusters.tsp";
66
import "./services/statuses.tsp";
77
import "./services/nodepools.tsp";
8+
import "./services/resources.tsp";
89
// Provider-specific security is imported via aliases.tsp
910
import "./aliases.tsp";
1011

@@ -21,7 +22,7 @@ using OpenAPI;
2122
*/
2223
@service(#{ title: "HyperFleet API" })
2324
@info(#{
24-
version: "1.0.15",
25+
version: "1.0.16",
2526
contact: #{
2627
name: "HyperFleet Team",
2728
url: "https://github.com/openshift-hyperfleet",

‎models-gcp/channel/example_channel.tsp‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import "./model.tsp";
2+
import "../../models/common/model.tsp";
3+
4+
const exampleChannel: Channel = #{
5+
kind: "Channel",
6+
id: "019466a2-1234-7abc-9def-0123456789ab",
7+
href: "/api/hyperfleet/v1/channels/019466a2-1234-7abc-9def-0123456789ab",
8+
name: "stable",
9+
labels: #{ tier: "production" },
10+
spec: #{
11+
is_default: true,
12+
enabled_regex: "^4\\.\\d+\\.\\d+$",
13+
},
14+
generation: 1,
15+
status: #{
16+
conditions: #[],
17+
},
18+
created_time: "2025-06-01T00:00:00Z",
19+
updated_time: "2025-06-01T10:02:00Z",
20+
created_by: "user-123@example.com",
21+
updated_by: "user-123@example.com",
22+
};

‎models-gcp/channel/example_patch.tsp‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import "./model.tsp";
2+
3+
const exampleChannelPatchRequest: ChannelPatchRequest = #{
4+
spec: #{
5+
is_default: false,
6+
enabled_regex: "^4\\.17\\.\\d+$",
7+
},
8+
labels: #{ tier: "staging" },
9+
};

‎models-gcp/channel/example_post.tsp‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import "./model.tsp";
2+
3+
const exampleChannelCreateRequest: ChannelCreateRequest = #{
4+
kind: "Channel",
5+
name: "stable",
6+
labels: #{ tier: "production" },
7+
spec: #{
8+
is_default: true,
9+
enabled_regex: "^4\\.\\d+\\.\\d+$",
10+
},
11+
};

‎models-gcp/channel/model.tsp‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import "@typespec/openapi";
2+
import "../../models/common/model.tsp";
3+
import "../../models/statuses/model.tsp";
4+
import "../../models/resource/model.tsp";
5+
6+
using OpenAPI;
7+
8+
alias KindChannel = "Channel";
9+
10+
model ChannelSpec {
11+
/** Whether this is the default channel for new clusters */
12+
is_default: boolean;
13+
14+
/** Regex pattern for matching enabled version strings */
15+
enabled_regex: string;
16+
}
17+
18+
model ChannelBase {
19+
...APIResource;
20+
21+
@minLength(1)
22+
@maxLength(63)
23+
@pattern("^[a-z0-9]([-a-z0-9]*[a-z0-9])?$")
24+
name: string;
25+
26+
spec: ChannelSpec;
27+
}
28+
29+
@example(exampleChannel)
30+
model Channel {
31+
...ChannelBase;
32+
...APIMetadata;
33+
34+
@minValue(1)
35+
generation: int32;
36+
37+
status: ResourceStatus;
38+
}
39+
40+
@example(exampleChannelCreateRequest)
41+
model ChannelCreateRequest {
42+
...ChannelBase;
43+
}
44+
45+
@extension("minProperties", 1)
46+
@extension("additionalProperties", false)
47+
@example(exampleChannelPatchRequest)
48+
model ChannelPatchRequest {
49+
spec?: ChannelSpec;
50+
labels?: Record<string>;
51+
}
52+
53+
model ChannelList {
54+
...List<Channel>;
55+
}

‎models-gcp/version/example_patch.tsp‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import "./model.tsp";
2+
3+
const exampleVersionPatchRequest: VersionPatchRequest = #{
4+
spec: #{
5+
raw_version: "4.17.12",
6+
enabled: false,
7+
is_default: false,
8+
release_image: "quay.io/openshift-release-dev/ocp-release:4.17.12-multi",
9+
},
10+
labels: #{ deprecated: "true" },
11+
};

‎models-gcp/version/example_post.tsp‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import "./model.tsp";
2+
3+
const exampleVersionCreateRequest: VersionCreateRequest = #{
4+
kind: "Version",
5+
name: "4.17.12",
6+
labels: #{},
7+
spec: #{
8+
raw_version: "4.17.12",
9+
enabled: true,
10+
is_default: true,
11+
release_image: "quay.io/openshift-release-dev/ocp-release:4.17.12-multi",
12+
},
13+
};

0 commit comments

Comments
 (0)