Skip to content

Commit 5fc6c23

Browse files
OAS Update
1 parent 313c9b0 commit 5fc6c23

1 file changed

Lines changed: 141 additions & 2 deletions

File tree

‎services/git/v1beta/git.json‎

Lines changed: 141 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,11 @@
284284
"CreateRunnerPayload": {
285285
"description": "Request a runner to be created supporting the requested list of runtime labels.",
286286
"properties": {
287+
"familyName": {
288+
"description": "The runner's job family name.",
289+
"example": "classic",
290+
"type": "string"
291+
},
287292
"labels": {
288293
"items": {
289294
"example": "stackit-docker",
@@ -709,6 +714,11 @@
709714
"maxLength": 48,
710715
"type": "string"
711716
},
717+
"familyName": {
718+
"description": "The runner's job family name.",
719+
"example": "classic",
720+
"type": "string"
721+
},
712722
"id": {
713723
"format": "uuid",
714724
"maxLength": 36,
@@ -734,16 +744,80 @@
734744
"status"
735745
]
736746
},
747+
"RunnerFamily": {
748+
"description": "Describes a STACKIT Git Runner Family.",
749+
"properties": {
750+
"arch": {
751+
"description": "Indicates the runner image architecture.",
752+
"example": "linux-amd",
753+
"type": "string"
754+
},
755+
"availability": {
756+
"description": "Indicates the availability of the runner label",
757+
"example": "available",
758+
"type": "string"
759+
},
760+
"cpu": {
761+
"description": "CPU virtual cores resource limit of jobs.",
762+
"type": "string"
763+
},
764+
"disk": {
765+
"description": "Disk size limit of jobs.",
766+
"type": "string"
767+
},
768+
"display_name": {
769+
"description": "Human-friendly name of the runtime.",
770+
"type": "string"
771+
},
772+
"name": {
773+
"description": "Family name identifier.",
774+
"example": "classic",
775+
"type": "string"
776+
},
777+
"ram": {
778+
"description": "RAM resource limit of jobs.",
779+
"type": "string"
780+
}
781+
},
782+
"required": [
783+
"name",
784+
"display_name",
785+
"cpu",
786+
"ram",
787+
"disk",
788+
"arch",
789+
"availability"
790+
]
791+
},
792+
"RunnerFamilyList": {
793+
"description": "A list of STACKIT Git RunnerFamily.",
794+
"properties": {
795+
"items": {
796+
"items": {
797+
"$ref": "#/components/schemas/RunnerFamily"
798+
},
799+
"type": "array"
800+
}
801+
},
802+
"required": [
803+
"items"
804+
]
805+
},
737806
"RunnerRuntime": {
738807
"description": "Describes a STACKIT Git Runner runtime.",
739808
"properties": {
809+
"arch": {
810+
"description": "Indicates the runner image architecture.",
811+
"example": "linux-amd",
812+
"type": "string"
813+
},
740814
"availability": {
741815
"description": "Indicates the availability of the runner label",
742816
"example": "available",
743817
"type": "string"
744818
},
745819
"description": {
746-
"description": "Human-friendly description of the runtime and its capabilities.",
820+
"description": "Human-friendly description of the runtime and it's capabilities.",
747821
"example": "A runner capable of building Docker images and runner Docker containers.",
748822
"type": "string"
749823
},
@@ -768,7 +842,8 @@
768842
"display_name",
769843
"description",
770844
"availability",
771-
"status"
845+
"status",
846+
"arch"
772847
]
773848
},
774849
"RunnerRuntimeList": {
@@ -2166,6 +2241,70 @@
21662241
}
21672242
}
21682243
},
2244+
"/v1beta/projects/{projectId}/runner-families": {
2245+
"get": {
2246+
"description": "A list of runner job families that are available for the project.",
2247+
"operationId": "ListRunnerFamilies",
2248+
"responses": {
2249+
"200": {
2250+
"content": {
2251+
"application/json": {
2252+
"schema": {
2253+
"$ref": "#/components/schemas/RunnerFamilyList"
2254+
}
2255+
}
2256+
},
2257+
"description": "OK"
2258+
},
2259+
"400": {
2260+
"content": {
2261+
"application/json": {
2262+
"schema": {
2263+
"$ref": "#/components/schemas/GenericErrorResponse"
2264+
}
2265+
}
2266+
},
2267+
"description": "Bad Request."
2268+
},
2269+
"401": {
2270+
"description": "Unauthorized."
2271+
},
2272+
"404": {
2273+
"content": {
2274+
"application/json": {
2275+
"schema": {
2276+
"$ref": "#/components/schemas/GenericErrorResponse"
2277+
}
2278+
}
2279+
},
2280+
"description": "Not found."
2281+
},
2282+
"500": {
2283+
"content": {
2284+
"application/json": {
2285+
"schema": {
2286+
"$ref": "#/components/schemas/GenericErrorResponse"
2287+
}
2288+
}
2289+
},
2290+
"description": "Internal server error."
2291+
}
2292+
},
2293+
"x-stackit-authorization": {
2294+
"actions": [
2295+
"git.runner.get"
2296+
],
2297+
"resource-id": "projectId",
2298+
"resource-id-type": "dynamic",
2299+
"resource-type": "project"
2300+
}
2301+
},
2302+
"parameters": [
2303+
{
2304+
"$ref": "#/components/parameters/ProjectId"
2305+
}
2306+
]
2307+
},
21692308
"/v1beta/projects/{projectId}/runner-runtimes": {
21702309
"get": {
21712310
"description": "A list of runner runtimes that are available to be enabled for the project.",

0 commit comments

Comments
 (0)