Skip to content

Commit 4eb8d44

Browse files
committed
docs: add OpenAPI attrs to BucketsListAction and update apiary with isLinkedBucket/isAlias
Add OpenAPI attributes (Operation, Tag, Parameter, Response) to BucketsListAction referencing BucketCreateResponse schema. Add isLinkedBucket to all bucket response examples in apiary and isAlias to all sourceTable objects in apiary examples.
1 parent cc18779 commit 4eb8d44

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

apiary.apib

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1011,7 +1011,8 @@ All buckets are returned.
10111011
"email": "jan.dev@keboola.com"
10121012
},
10131013
"updated": "2024-11-28T13:03:13+0100",
1014-
"color": null
1014+
"color": null,
1015+
"isLinkedBucket": false,
10151016
"backendPath": [
10161017
"KBC_PRJ_123",
10171018
"in.c-main"
@@ -1042,7 +1043,8 @@ All buckets are returned.
10421043
},
10431044
"owner": null,
10441045
"updated": "2024-11-28T13:03:13+0100",
1045-
"color": "#FF0000"
1046+
"color": "#FF0000",
1047+
"isLinkedBucket": true
10461048
}
10471049
]
10481050

@@ -1102,6 +1104,7 @@ existing bucket from another project (see below).
11021104
"sharing": null,
11031105
"updated": "2024-11-28T13:03:13+0100",
11041106
"color": null,
1107+
"isLinkedBucket": false,
11051108
"backendPath": [
11061109
"KBC_PRJ_123",
11071110
"in.c-main"
@@ -1167,6 +1170,7 @@ Synchronous call response (async=false)
11671170
},
11681171
"owner": null,
11691172
"updated": "2024-11-28T13:03:13+0100",
1173+
"isLinkedBucket": true,
11701174
"backendPath": [
11711175
"KBC_PRJ_123",
11721176
"in.c-main"
@@ -1387,6 +1391,7 @@ Obtains information about a bucket.
13871391
"email": "jan.dev@keboola.com"
13881392
},
13891393
"updated": "2024-11-28T13:03:13+0100",
1394+
"isLinkedBucket": false,
13901395
"backendPath": [
13911396
"KBC_PRJ_123",
13921397
"in.c-main"
@@ -2283,6 +2288,7 @@ Lists tables in a given bucket.
22832288
"sourceTable": {
22842289
"id": "in.c-keboola-ex-db-snowflake-528221294.datatypes",
22852290
"uri": "https://connection.keboola.com/v2/storage/tables/in.c-keboola-ex-db-snowflake-528221294.datatypes",
2291+
"isAlias": false,
22862292
"project": {
22872293
"id": 578,
22882294
"name": "Some source project"
@@ -3551,6 +3557,7 @@ Obtains information about a table.
35513557
"sourceTable": {
35523558
"id": "in.c-application-testing.cashier-data",
35533559
"uri": "https://connection.keboola.com/v2/storage/tables/in.c-application-testing.cashier-data",
3560+
"isAlias": false,
35543561
"project": {
35553562
"id": 123,
35563563
"name": "Some source project"
@@ -3702,6 +3709,7 @@ Synchronous call response (async=false)
37023709
"sourceTable": {
37033710
"id": "in.c-application-testing.cashier-data",
37043711
"uri": "https://connection.keboola.com/v2/storage/tables/in.c-application-testing.cashier-data",
3712+
"isAlias": false,
37053713
"project": {
37063714
"id": 123,
37073715
"name": "Some source project"
@@ -3938,6 +3946,7 @@ attributes and information about the containing bucket.
39383946
"sourceTable": {
39393947
"id": "in.c-application-testing.cashier-data",
39403948
"uri": "https:\/\/connection.keboola.com\/v2\/storage\/tables\/in.c-application-testing.cashier-data",
3949+
"isAlias": false,
39413950
"project": {
39423951
"id": 578,
39433952
"name": "Some source project"
@@ -4441,6 +4450,7 @@ An alias cannot be created from tables in an external bucket or from a table in
44414450
"sourceTable": {
44424451
"id": "in.c-main.data",
44434452
"uri": "https://connection.keboola.com/v2/storage/tables/in.c-main.data",
4453+
"isAlias": false,
44444454
"project": {
44454455
"id": 578,
44464456
"name": "Odinuv Sandbox"
@@ -4549,6 +4559,7 @@ alias must be created with the `aliasFilter` parameter.
45494559
"sourceTable": {
45504560
"id": "in.c-main.data",
45514561
"uri": "https://connection.keboola.com/v2/storage/tables/in.c-main.data",
4562+
"isAlias": false,
45524563
"project": {
45534564
"id": 578,
45544565
"name": "Odinuv Sandbox"
@@ -9167,6 +9178,7 @@ attributes and information about the containing bucket. At least one of paramete
91679178
"sourceTable": {
91689179
"id": "in.c-application-testing.cashier-data",
91699180
"uri": "https:\/\/connection.keboola.com\/v2\/storage\/tables\/in.c-application-testing.cashier-data",
9181+
"isAlias": false,
91709182
"project": {
91719183
"id": 578,
91729184
"name": "Some source project"

0 commit comments

Comments
 (0)