Skip to content

Commit 870fe1f

Browse files
stackit-pipelinestackit-pipeline
committed
OAS Update
1 parent b0375be commit 870fe1f

1 file changed

Lines changed: 47 additions & 47 deletions

File tree

‎services/dremio/v1alpha/dremio.json‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"components": {
33
"parameters": {
44
"dremioId": {
5-
"description": "The Dremio UUID.",
5+
"description": "The Dremio instance UUID.",
66
"in": "path",
77
"name": "dremioId",
88
"required": true,
@@ -12,7 +12,7 @@
1212
}
1313
},
1414
"dremioUserId": {
15-
"description": "The dremio user UUID.",
15+
"description": "The Dremio user UUID.",
1616
"in": "path",
1717
"name": "dremioUserId",
1818
"required": true,
@@ -22,7 +22,7 @@
2222
}
2323
},
2424
"pageSize": {
25-
"description": "Maximum number of items to return",
25+
"description": "Maximum number of items to return.",
2626
"in": "query",
2727
"name": "pageSize",
2828
"schema": {
@@ -104,7 +104,7 @@
104104
"type": "object"
105105
},
106106
"authentication": {
107-
"description": "Dremio authentication settings. A change here triggers a Dremio restart and will incur downtime.",
107+
"description": "Dremio instance authentication settings. A change here triggers a Dremio restart and will incur downtime.",
108108
"properties": {
109109
"azuread": {
110110
"$ref": "#/components/schemas/azuread"
@@ -154,6 +154,28 @@
154154
],
155155
"type": "object"
156156
},
157+
"create-dremio-instancePayload": {
158+
"properties": {
159+
"authentication": {
160+
"$ref": "#/components/schemas/authentication"
161+
},
162+
"description": {
163+
"description": "The description is a longer text chosen by the user to provide more context for the resource.",
164+
"maxLength": 1024,
165+
"type": "string"
166+
},
167+
"displayName": {
168+
"description": "The display name is a short name chosen by the user to identify the resource.",
169+
"maxLength": 32,
170+
"minLength": 1,
171+
"pattern": "^[a-zA-Z0-9 ]*$",
172+
"type": "string"
173+
}
174+
},
175+
"required": [
176+
"displayName"
177+
]
178+
},
157179
"create-dremio-userPayload": {
158180
"properties": {
159181
"description": {
@@ -203,28 +225,6 @@
203225
"password"
204226
]
205227
},
206-
"create-dremioPayload": {
207-
"properties": {
208-
"authentication": {
209-
"$ref": "#/components/schemas/authentication"
210-
},
211-
"description": {
212-
"description": "The description is a longer text chosen by the user to provide more context for the resource.",
213-
"maxLength": 1024,
214-
"type": "string"
215-
},
216-
"displayName": {
217-
"description": "The display name is a short name chosen by the user to identify the resource.",
218-
"maxLength": 32,
219-
"minLength": 1,
220-
"pattern": "^[a-zA-Z0-9 ]*$",
221-
"type": "string"
222-
}
223-
},
224-
"required": [
225-
"displayName"
226-
]
227-
},
228228
"dremioResponse": {
229229
"properties": {
230230
"authentication": {
@@ -439,7 +439,7 @@
439439
"x-go-type-skip-optional-pointer": true
440440
},
441441
"redirectUrl": {
442-
"description": "The URL where Dremio is hosted. The URL must match the redirect URL set in the Identity Provider.",
442+
"description": "The URL where the Dremio instance is hosted. The URL must match the redirect URL set in the Identity Provider.",
443443
"readOnly": true,
444444
"type": "string"
445445
},
@@ -457,7 +457,7 @@
457457
],
458458
"type": "object"
459459
},
460-
"update-dremioPayload": {
460+
"update-dremio-instancePayload": {
461461
"properties": {
462462
"authentication": {
463463
"$ref": "#/components/schemas/authentication"
@@ -487,8 +487,8 @@
487487
"paths": {
488488
"/v1alpha/projects/{projectId}/regions/{regionId}/dremios": {
489489
"get": {
490-
"description": "Returns a list of all dremio instances within the project.",
491-
"operationId": "list-dremios",
490+
"description": "Returns a list of all Dremio instances within the project.",
491+
"operationId": "list-dremio-instances",
492492
"parameters": [
493493
{
494494
"$ref": "#/components/parameters/pageToken"
@@ -506,7 +506,7 @@
506506
}
507507
}
508508
},
509-
"description": "Successful response with all dremio instances."
509+
"description": "Successful response with all Dremio instances."
510510
},
511511
"401": {
512512
"$ref": "#/components/responses/unauthorized"
@@ -533,13 +533,13 @@
533533
}
534534
],
535535
"post": {
536-
"description": "Creates a new Dremio within the project.",
537-
"operationId": "create-dremio",
536+
"description": "Creates a new Dremio instance within the project.",
537+
"operationId": "create-dremio-instance",
538538
"requestBody": {
539539
"content": {
540540
"application/json": {
541541
"schema": {
542-
"$ref": "#/components/schemas/create-dremioPayload"
542+
"$ref": "#/components/schemas/create-dremio-instancePayload"
543543
}
544544
}
545545
},
@@ -554,7 +554,7 @@
554554
}
555555
}
556556
},
557-
"description": "Dremio has been accepted."
557+
"description": "Dremio instance has been accepted."
558558
},
559559
"400": {
560560
"$ref": "#/components/responses/badRequest"
@@ -581,11 +581,11 @@
581581
},
582582
"/v1alpha/projects/{projectId}/regions/{regionId}/dremios/{dremioId}": {
583583
"delete": {
584-
"description": "Deletes the given Dremio.",
585-
"operationId": "delete-dremio",
584+
"description": "Deletes the given Dremio instance.",
585+
"operationId": "delete-dremio-instance",
586586
"responses": {
587587
"202": {
588-
"description": "Dremio deletion has been accepted."
588+
"description": "Dremio instance deletion has been accepted."
589589
},
590590
"401": {
591591
"$ref": "#/components/responses/unauthorized"
@@ -610,7 +610,7 @@
610610
}
611611
},
612612
"get": {
613-
"description": "Returns the details for the given Dremio.",
613+
"description": "Returns the details for the given Dremio instance.",
614614
"operationId": "get-dremio",
615615
"responses": {
616616
"200": {
@@ -621,7 +621,7 @@
621621
}
622622
}
623623
},
624-
"description": "Dremio details successfully retrieved."
624+
"description": "Dremio instance details successfully retrieved."
625625
},
626626
"401": {
627627
"$ref": "#/components/responses/unauthorized"
@@ -654,13 +654,13 @@
654654
}
655655
],
656656
"put": {
657-
"description": "Updates the given Dremio. Please note that changing certain fields will trigger a Dremio restart and will incur downtime. See the request body information for more details.",
658-
"operationId": "update-dremio",
657+
"description": "Updates the given Dremio instance. Please note that changing certain fields will trigger a Dremio restart and will incur downtime. See the request body information for more details.",
658+
"operationId": "update-dremio-instance",
659659
"requestBody": {
660660
"content": {
661661
"application/json": {
662662
"schema": {
663-
"$ref": "#/components/schemas/update-dremioPayload"
663+
"$ref": "#/components/schemas/update-dremio-instancePayload"
664664
}
665665
}
666666
},
@@ -675,7 +675,7 @@
675675
}
676676
}
677677
},
678-
"description": "Dremio update has been accepted."
678+
"description": "Dremio instance update has been accepted."
679679
},
680680
"401": {
681681
"$ref": "#/components/responses/unauthorized"
@@ -702,7 +702,7 @@
702702
},
703703
"/v1alpha/projects/{projectId}/regions/{regionId}/dremios/{dremioId}/users": {
704704
"get": {
705-
"description": "Returns a list of all dremio admin users for the given dremio instance.",
705+
"description": "Returns a list of all Dremio admin users for the given dremio instance.",
706706
"operationId": "list-dremio-users",
707707
"parameters": [
708708
{
@@ -721,7 +721,7 @@
721721
}
722722
}
723723
},
724-
"description": "Successful response with all dremio admin users"
724+
"description": "Successful response with all Dremio admin users."
725725
},
726726
"401": {
727727
"$ref": "#/components/responses/unauthorized"
@@ -751,7 +751,7 @@
751751
}
752752
],
753753
"post": {
754-
"description": "Creates a new dremio admin user for the given dremio instance",
754+
"description": "Creates a new Dremio admin user for the given Dremio instance.",
755755
"operationId": "create-dremio-user",
756756
"requestBody": {
757757
"content": {

0 commit comments

Comments
 (0)