Skip to content

Commit 9153e95

Browse files
committed
add apiary docs
1 parent c731f0f commit 9153e95

1 file changed

Lines changed: 115 additions & 58 deletions

File tree

apiary.apib

Lines changed: 115 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -3047,64 +3047,6 @@ Further information can be found in the [Developers Documentation](https://devel
30473047
}
30483048
}
30493049
3050-
3051-
## Workspace credentials [/v2/storage/workspaces/{workspaceId}/credentials]
3052-
3053-
Manage dedicated workspace credentials to be used in Query Service
3054-
### Create credentials [POST]
3055-
3056-
+ Request (application/json)
3057-
+ Headers
3058-
3059-
X-StorageApi-Token: your_token
3060-
3061-
+ Body
3062-
3063-
{
3064-
}
3065-
3066-
+ Response 202 (application/json)
3067-
3068-
{
3069-
"TODO": 22070846
3070-
}
3071-
3072-
3073-
3074-
Create new or fetch existing credentials for dedicated workspace.
3075-
3076-
### Credentials detail [GET]
3077-
3078-
+ Request (application/json)
3079-
+ Headers
3080-
3081-
X-StorageApi-Token: your_token
3082-
3083-
+ Response 202 (application/json)
3084-
3085-
{
3086-
"TODO": 22070846
3087-
}
3088-
3089-
Get details of specified workspace credentials
3090-
3091-
### Delete credetnails [DELETE]
3092-
3093-
Delete specified workspace credentials. User will be invalidated
3094-
3095-
3096-
+ Request (application/json)
3097-
+ Headers
3098-
3099-
X-StorageApi-Token: your_token
3100-
3101-
+ Response 202 (application/json)
3102-
3103-
{
3104-
"TODO": 22070846
3105-
}
3106-
3107-
31083050
## Data Preview [/v2/storage/tables/{table_id}/data-preview/]
31093051
### Data preview [GET]
31103052
@@ -5718,6 +5660,121 @@ query, non-SELECT query and failed query.
57185660
"message": "An exception occurred while executing a query: SQL compilation error: error line 1 at position 7 invalid identifier 'BIRTHDATE'"
57195661
}
57205662
5663+
5664+
## Workspace credentials [/v2/storage/workspaces/{workspaceId}/credentials]
5665+
5666+
Manage dedicated workspace credentials to be used in Query Service
5667+
### Create credentials [POST]
5668+
5669+
+ Request (application/json)
5670+
+ Headers
5671+
5672+
X-StorageApi-Token: your_token
5673+
5674+
+ Body
5675+
5676+
{
5677+
}
5678+
5679+
+ Response 200 (application/json)
5680+
5681+
{
5682+
"id": 254,
5683+
"type": "table",
5684+
"name": "WORKSPACE_123",
5685+
"component": null,
5686+
"configurationId": null,
5687+
"created": "2025-08-13T15:03:18+0200",
5688+
"connection": {
5689+
"backend": "snowflake",
5690+
"region": "eu-central-1",
5691+
"host": "kebooladev.snowflakecomputing.com",
5692+
"database": "DB_123",
5693+
"schema": "WORKSPACE_123",
5694+
"warehouse": "DEV",
5695+
"user": "JSWORKSPACE_123_QS",
5696+
"loginType": "snowflake-service-keypair",
5697+
"ssoLoginAvailable": false,
5698+
"account": "kebooladev",
5699+
"role": "JSWORKSPACE_123",
5700+
"privateKey": "-----BEGIN PRIVATE KEY--....",
5701+
"credentials": {
5702+
"id": 356
5703+
}
5704+
},
5705+
"backendSize": "small",
5706+
"statementTimeoutSeconds": 0,
5707+
"creatorToken": {
5708+
"id": 1,
5709+
"description": "token"
5710+
},
5711+
"readOnlyStorageAccess": true,
5712+
"platformUsageType": "user"
5713+
}
5714+
5715+
5716+
5717+
Create new or fetch existing credentials for dedicated workspace.
5718+
5719+
### Credentials detail [GET /v2/storage/workspaces/{workspaceId}/credentials/{id}]
5720+
5721+
+ Request (application/json)
5722+
+ Headers
5723+
5724+
X-StorageApi-Token: your_token
5725+
5726+
+ Response 204 (application/json)
5727+
5728+
{
5729+
"id": 254,
5730+
"type": "table",
5731+
"name": "WORKSPACE_123",
5732+
"component": null,
5733+
"configurationId": null,
5734+
"created": "2025-08-13T15:03:18+0200",
5735+
"connection": {
5736+
"backend": "snowflake",
5737+
"region": "eu-central-1",
5738+
"host": "kebooladev.snowflakecomputing.com",
5739+
"database": "DB_123",
5740+
"schema": "WORKSPACE_123",
5741+
"warehouse": "DEV",
5742+
"user": "JSWORKSPACE_123_QS",
5743+
"loginType": "snowflake-service-keypair",
5744+
"ssoLoginAvailable": false,
5745+
"account": "kebooladev",
5746+
"role": "JSWORKSPACE_123",
5747+
"privateKey": "-----BEGIN PRIVATE KEY--....",
5748+
"credentials": {
5749+
"id": 356
5750+
}
5751+
},
5752+
"backendSize": "small",
5753+
"statementTimeoutSeconds": 0,
5754+
"creatorToken": {
5755+
"id": 1,
5756+
"description": "token"
5757+
},
5758+
"readOnlyStorageAccess": true,
5759+
"platformUsageType": "user"
5760+
}
5761+
5762+
Get details of specified workspace credentials
5763+
5764+
### Delete credetnails [DELETE /v2/storage/workspaces/{workspaceId}/credentials/{id}]
5765+
5766+
Delete specified workspace credentials. User will be invalidated
5767+
5768+
5769+
+ Request (application/json)
5770+
+ Headers
5771+
5772+
X-StorageApi-Token: your_token
5773+
5774+
+ Response 204 (application/json)
5775+
5776+
5777+
57215778
## Data Structures
57225779
57235780
### Workspace

0 commit comments

Comments
 (0)