Skip to content

Commit 85e9038

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent 49c1fc4 commit 85e9038

File tree

1 file changed

+36
-37
lines changed

1 file changed

+36
-37
lines changed

‎services/git/v1beta/git.json

Lines changed: 36 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"parameters": {
44
"InstanceId": {
55
"description": "Instance identifier.",
6+
"example": "83b8e9c4-e3d1-4dc4-bb89-9854c8b5383e",
67
"explode": false,
78
"in": "path",
89
"name": "instanceId",
@@ -14,6 +15,7 @@
1415
},
1516
"ProjectId": {
1617
"description": "Project identifier.",
18+
"example": "83b8e9c4-e3d1-4dc4-bb89-9854c8b5383e",
1719
"explode": false,
1820
"in": "path",
1921
"name": "projectId",
@@ -26,7 +28,7 @@
2628
},
2729
"schemas": {
2830
"CreateInstancePayload": {
29-
"description": "Instance creation configuration options.",
31+
"description": "Request a STACKIT Git instance to be created with these properties.",
3032
"properties": {
3133
"acl": {
3234
"description": "Restricted ACL for instance access.",
@@ -37,14 +39,16 @@
3739
"type": "array"
3840
},
3941
"flavor": {
40-
"default": "git-100",
41-
"description": "Instance flavor. Defaults to git-100 if not specified.",
42-
"example": "git-100",
42+
"description": "Desired instance flavor. Must be one of the defined enum values",
43+
"enum": [
44+
"git-10",
45+
"git-100"
46+
],
47+
"maxLength": 255,
4348
"type": "string"
4449
},
4550
"name": {
4651
"description": "A user chosen name to distinguish multiple STACKIT Git instances.",
47-
"example": "my-instance",
4852
"maxLength": 32,
4953
"minLength": 5,
5054
"pattern": "^[a-z]([a-z0-9\\-]){0,30}[a-z0-9]+$",
@@ -80,13 +84,18 @@
8084
"description": "Flavor id.",
8185
"maxLength": 36,
8286
"type": "string"
87+
},
88+
"sku": {
89+
"description": "SAP article number.",
90+
"type": "string"
8391
}
8492
},
8593
"required": [
8694
"id",
8795
"availability",
8896
"display_name",
89-
"description"
97+
"description",
98+
"sku"
9099
]
91100
},
92101
"GenericErrorResponse": {
@@ -109,7 +118,7 @@
109118
"type": "object"
110119
},
111120
"Instance": {
112-
"description": "Information about an Instance.",
121+
"description": "Describes a STACKIT Git instance.",
113122
"properties": {
114123
"acl": {
115124
"description": "Restricted ACL for instance access.",
@@ -127,34 +136,28 @@
127136
"type": "string"
128137
},
129138
"created": {
130-
"description": "Instance creation timestamp in RFC3339 format.",
131-
"example": "2025-04-07T07:08:12Z",
139+
"description": "The date and time the creation of the STACKIT Git instance was triggered.",
132140
"format": "date-time",
133141
"maxLength": 48,
134142
"type": "string"
135143
},
136144
"flavor": {
137-
"description": "Instance flavor.",
138-
"example": "git-100",
145+
"description": "Desired instance flavor. Must be one of the defined enum values",
139146
"type": "string"
140147
},
141148
"id": {
142-
"description": "Instance identifier.",
143-
"example": "f88b5082-a81b-41ae-aae0-33df56907aa8",
149+
"description": "A auto generated unique id which identifies the STACKIT Git instances.",
144150
"format": "uuid",
145151
"maxLength": 36,
146-
"minLength": 36,
147-
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
148152
"type": "string"
149153
},
150154
"name": {
151-
"description": "Instance name.",
152-
"example": "my-instance",
155+
"description": "A user chosen name to distinguish multiple STACKIT Git instances.",
153156
"maxLength": 32,
154157
"type": "string"
155158
},
156159
"state": {
157-
"description": "Indicate the readiness state of the instance.",
160+
"description": "The current state of the STACKIT Git instance.",
158161
"enum": [
159162
"Creating",
160163
"WaitingForResources",
@@ -167,28 +170,26 @@
167170
"type": "string"
168171
},
169172
"url": {
170-
"description": "Instance url.",
171-
"example": "https://my-instance.git.onstackit.cloud",
172-
"maxLength": 512,
173+
"description": "The URL for reaching the STACKIT Git instance.",
174+
"maxLength": 2048,
173175
"type": "string"
174176
},
175177
"version": {
176-
"description": "STACKIT Git version indicator.",
177-
"example": "v1.0.0",
178+
"description": "The current version of STACKIT Git deployed to the instance.",
178179
"maxLength": 20,
179180
"type": "string"
180181
}
181182
},
182183
"required": [
183184
"id",
184185
"name",
185-
"flavor",
186186
"url",
187187
"created",
188188
"state",
189189
"version",
190190
"consumed_disk",
191191
"consumed_object_storage",
192+
"flavor",
192193
"acl"
193194
]
194195
},
@@ -217,13 +218,13 @@
217218
]
218219
},
219220
"ListInstances": {
220-
"description": "List of Instances.",
221+
"description": "A list of STACKIT Git instances.",
221222
"properties": {
222223
"instances": {
223224
"items": {
224225
"$ref": "#/components/schemas/Instance"
225226
},
226-
"maxItems": 100,
227+
"maxItems": 50,
227228
"type": "array"
228229
}
229230
},
@@ -280,6 +281,13 @@
280281
"description": "Git flavors."
281282
},
282283
"400": {
284+
"content": {
285+
"application/json": {
286+
"schema": {
287+
"$ref": "#/components/schemas/GenericErrorResponse"
288+
}
289+
}
290+
},
283291
"description": "Bad Request."
284292
},
285293
"401": {
@@ -299,7 +307,7 @@
299307
"content": {
300308
"application/json": {
301309
"schema": {
302-
"$ref": "#/components/schemas/InternalServerErrorResponse"
310+
"$ref": "#/components/schemas/GenericErrorResponse"
303311
}
304312
}
305313
},
@@ -318,16 +326,7 @@
318326
},
319327
"parameters": [
320328
{
321-
"description": "The STACKIT portal project UUID the STACKIT Git instance is part of.",
322-
"example": "83b8e9c4-e3d1-4dc4-bb89-9854c8b5383e",
323-
"in": "path",
324-
"name": "projectId",
325-
"required": true,
326-
"schema": {
327-
"format": "uuid",
328-
"maxLength": 36,
329-
"type": "string"
330-
}
329+
"$ref": "#/components/parameters/ProjectId"
331330
}
332331
]
333332
},

0 commit comments

Comments
 (0)