hyperfleet-api-spec-template/main.tsp at main · openshift-hyperfleet/hyperfleet-api-spec-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import "@typespec/http";
import "@typespec/openapi";
import "@typespec/openapi3";

import "./models/cluster/model.tsp";
import "./models/cluster/example_cluster.tsp";
import "./models/cluster/example_post.tsp";
import "./models/cluster/example_patch.tsp";
import "./models/nodepool/model.tsp";
import "./models/nodepool/example_nodepool.tsp";
import "./models/nodepool/example_post.tsp";
import "./models/nodepool/example_patch.tsp";
import "./models/channel/model.tsp";
import "./models/version/model.tsp";
import "./models/wifconfig/model.tsp";

import "hyperfleet/shared/services/clusters.tsp";
import "hyperfleet/shared/services/nodepools.tsp";
import "./services/channels.tsp";
import "./services/versions.tsp";
import "./services/wifconfigs.tsp";

using Http;
using OpenAPI;

/**
 * HyperFleet API provides simple CRUD operations for managing cluster resources and their status history.
 *
 * **Architecture**: Simple CRUD only, no business logic, no event creation.
 * Sentinel operator handles all orchestration logic.
 * Adapters handle the specifics of managing spec
 *
 */
@service(#{ title: "HyperFleet API" })
@info(#{
  version: "1.0.26",
  contact: #{
    name: "HyperFleet Team",
    url: "https://github.com/openshift-hyperfleet",
  },
  license: #{
    name: "Apache 2.0",
    url: "https://www.apache.org/licenses/LICENSE-2.0",
  },
})
@server("https://hyperfleet.redhat.com", "Production")
@route("/api/hyperfleet/v1")
namespace HyperFleet;

// Override BearerAuth to use lowercase "bearer" as required by kin-openapi
model BearerAuth {
  type: AuthType.http;
  scheme: "bearer";
}