|
8 | 8 | "description": "A user chosen name to distinguish multiple STACKIT Git instances.", |
9 | 9 | "maxLength": 32, |
10 | 10 | "minLength": 5, |
11 | | - "pattern": "^[a-zA-Z0-9-_]+$", |
| 11 | + "pattern": "^[a-z]([a-z0-9\\-]){0,30}[a-z0-9]+$", |
12 | 12 | "type": "string" |
13 | 13 | } |
14 | 14 | }, |
|
20 | 20 | "description": "Describes a STACKIT Git instance.", |
21 | 21 | "properties": { |
22 | 22 | "created": { |
23 | | - "description": "The date and time the creation of the STACKIT GIT instance was triggered.", |
| 23 | + "description": "The date and time the creation of the STACKIT Git instance was triggered.", |
24 | 24 | "format": "date-time", |
25 | 25 | "maxLength": 48, |
26 | 26 | "type": "string" |
27 | 27 | }, |
28 | 28 | "id": { |
29 | | - "description": "A auto generated unique id which identifies the STACKIT GIT instances.", |
| 29 | + "description": "A auto generated unique id which identifies the STACKIT Git instances.", |
30 | 30 | "format": "uuid", |
31 | 31 | "maxLength": 36, |
32 | 32 | "type": "string" |
33 | 33 | }, |
34 | 34 | "name": { |
35 | | - "description": "A user chosen name to distinguish multiple STACKIT GIT instances.", |
| 35 | + "description": "A user chosen name to distinguish multiple STACKIT Git instances.", |
36 | 36 | "maxLength": 32, |
37 | 37 | "type": "string" |
38 | 38 | }, |
39 | 39 | "state": { |
40 | | - "description": "The current state of the STACKIT GIT instance.", |
| 40 | + "description": "The current state of the STACKIT Git instance.", |
41 | 41 | "enum": [ |
42 | 42 | "Creating", |
43 | 43 | "WaitingForResources", |
|
50 | 50 | "type": "string" |
51 | 51 | }, |
52 | 52 | "url": { |
53 | | - "description": "The URL for reaching the STACKIT GIT instance.", |
| 53 | + "description": "The URL for reaching the STACKIT Git instance.", |
54 | 54 | "maxLength": 2048, |
55 | 55 | "type": "string" |
56 | 56 | }, |
57 | 57 | "version": { |
58 | | - "description": "The current version of STACKIT GIT deployed to the instance.", |
| 58 | + "description": "The current version of STACKIT Git deployed to the instance.", |
59 | 59 | "maxLength": 20, |
60 | 60 | "type": "string" |
61 | 61 | } |
|
120 | 120 | "paths": { |
121 | 121 | "/v1beta/projects/{projectId}/instances": { |
122 | 122 | "get": { |
123 | | - "description": "Returns a list of all STACKIT Git instances within the project.", |
| 123 | + "description": "STACKIT Git instances exist within a project, and a project may have zero or more instances.\nThis endpoint allows a user with read-access to a project to list all instances that exist\nwithin the specified project.\n", |
124 | 124 | "operationId": "ListInstances", |
125 | 125 | "responses": { |
126 | 126 | "200": { |
|
157 | 157 | "description": "Internal server error." |
158 | 158 | } |
159 | 159 | }, |
160 | | - "summary": "STACKIT Git instances exist within a project, and a project may have zero or more instances.\nThis endpoint allows a user with read-access to a project to list all instances that exist\nwithin the specified project.\n", |
| 160 | + "summary": "Returns a list of all STACKIT Git instances within the project.", |
161 | 161 | "x-stackit-authorization": { |
162 | 162 | "actions": [ |
163 | 163 | "git.instance.list" |
|
182 | 182 | } |
183 | 183 | ], |
184 | 184 | "post": { |
185 | | - "description": "Creates a new STACKIT Git instance within the project.", |
| 185 | + "description": "Users with write-access to a project may create a new STACKIT Git instance by posting\nthe instance creation request to this endpoint, which will schedule the creation of a\nnew STACKIT Git instance within that project.\n", |
186 | 186 | "operationId": "CreateInstance", |
187 | 187 | "requestBody": { |
188 | 188 | "content": { |
|
233 | 233 | "description": "Internal server error." |
234 | 234 | } |
235 | 235 | }, |
236 | | - "summary": "Users with write-access to a project may create a new STACKIT Git instance by posting\nthe instance creation request to this endpoint, which will schedule the creation of a\nnew STACKIT Git instance within that project.\n", |
| 236 | + "summary": "Creates a new STACKIT Git instance within the project.", |
237 | 237 | "x-stackit-authorization": { |
238 | 238 | "actions": [ |
239 | 239 | "git.instance.create" |
|
246 | 246 | }, |
247 | 247 | "/v1beta/projects/{projectId}/instances/{instanceId}": { |
248 | 248 | "delete": { |
249 | | - "description": "Deletes the given STACKIT Git instance.", |
| 249 | + "description": "Allows a user with write-access to a project to schedule the deletion of a STACKIT Git\ninstance, which will soon eliminate all repositories \u0026 user metadata associated with\nthat instance. This is a destructive operation.\n", |
250 | 250 | "operationId": "DeleteInstance", |
251 | 251 | "responses": { |
252 | 252 | "202": { |
|
282 | 282 | "description": "Internal server error." |
283 | 283 | } |
284 | 284 | }, |
285 | | - "summary": "Allows a user with write-access to a project to schedule the deletion of a STACKIT Git\ninstance, which will soon eliminate all repositories \u0026 user metadata associated with\nthat instance. This is a destructive operation.\n", |
| 285 | + "summary": "Deletes the given STACKIT Git instance.", |
286 | 286 | "x-stackit-authorization": { |
287 | 287 | "actions": [ |
288 | 288 | "git.instance.delete" |
|
293 | 293 | } |
294 | 294 | }, |
295 | 295 | "get": { |
296 | | - "description": "Returns the details for the given STACKIT Git instance.", |
| 296 | + "description": "Provides detailed information about the state of an instance within the specified\nproject including information about how to access the instance for further use.\n", |
297 | 297 | "operationId": "GetInstance", |
298 | 298 | "responses": { |
299 | 299 | "200": { |
|
333 | 333 | "description": "Internal server error." |
334 | 334 | } |
335 | 335 | }, |
336 | | - "summary": "Provides detailed information about the state of an instance within the specified\nproject including information about how to access the instance for further use.\n", |
| 336 | + "summary": "Returns the details for the given STACKIT Git instance.", |
337 | 337 | "x-stackit-authorization": { |
338 | 338 | "actions": [ |
339 | 339 | "git.instance.get" |
|
0 commit comments