Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions open-api/rest-catalog-open-api.py
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,12 @@ class StorageCredential(BaseModel):
config: Dict[str, str]


class LoadCredentialsResponse(BaseModel):
storage_credentials: List[StorageCredential] = Field(
..., alias='storage-credentials'
)


class PlanStatus(BaseModel):
__root__: Literal['completed', 'submitted', 'cancelled', 'failed'] = Field(
..., description='Status of a server-side planning operation'
Expand Down
55 changes: 55 additions & 0 deletions open-api/rest-catalog-open-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1159,6 +1159,44 @@ paths:
5XX:
$ref: '#/components/responses/ServerErrorResponse'

/v1/{prefix}/namespaces/{namespace}/tables/{table}/credentials:
parameters:
- $ref: '#/components/parameters/prefix'
- $ref: '#/components/parameters/namespace'
- $ref: '#/components/parameters/table'

get:
tags:
- Catalog API
summary: Load vended credentials for a table from the catalog
operationId: loadCredentials
description: Load vended credentials for a table from the catalog.
responses:
200:
$ref: '#/components/responses/LoadCredentialsResponse'
400:
$ref: '#/components/responses/BadRequestErrorResponse'
401:
$ref: '#/components/responses/UnauthorizedResponse'
403:
$ref: '#/components/responses/ForbiddenResponse'
404:
description:
Not Found - NoSuchTableException, table to load credentials for does not exist
content:
application/json:
schema:
$ref: '#/components/schemas/IcebergErrorResponse'
examples:
TableToLoadDoesNotExist:
$ref: '#/components/examples/NoSuchTableError'
419:
$ref: '#/components/responses/AuthenticationTimeoutResponse'
503:
$ref: '#/components/responses/ServiceUnavailableResponse'
5XX:
$ref: '#/components/responses/ServerErrorResponse'

/v1/{prefix}/tables/rename:
parameters:
- $ref: '#/components/parameters/prefix'
Expand Down Expand Up @@ -3118,6 +3156,16 @@ components:
additionalProperties:
type: string

LoadCredentialsResponse:
type: object
required:
- storage-credentials
properties:
storage-credentials:
type: array
items:
$ref: '#/components/schemas/StorageCredential'

LoadTableResult:
description: |
Result used when a table is successfully loaded.
Expand Down Expand Up @@ -4579,6 +4627,13 @@ components:
schema:
$ref: '#/components/schemas/CommitTableResponse'

LoadCredentialsResponse:
description: Table credentials result when loading credentials for a table
content:
application/json:
schema:
$ref: '#/components/schemas/LoadCredentialsResponse'

#######################################
# Common examples of different values #
#######################################
Expand Down