Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI: Changes for freshness-aware table loading #11946

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OpenAPI: Changes for freshness-aware table loading #11946

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -930,6 +930,15 @@ paths:
key. For example, "urn:ietf:params:oauth:token-type:jwt=<JWT-token>".
parameters:
- $ref: '#/components/parameters/data-access'
- name: If-None-Match
in: header
description:
An optional header that allows the server to return 304 (Not Modified) if the metadata
is current. The content is the value of the ETag received in a CreateTableResponse or
LoadTableResponse.
required: false
schema:
type: string
- in: query
name: snapshots
description:
Expand All @@ -945,6 +954,10 @@ paths:
responses:
200:
$ref: '#/components/responses/LoadTableResponse'
304:
description:
Not Modified - Based on the content of the 'If-None-Match' header the table metadata has
not changed since.
400:
$ref: '#/components/responses/BadRequestErrorResponse'
401:
Expand Down Expand Up @@ -1873,6 +1886,14 @@ components:
type: integer
minimum: 1

etag:
name: ETag
in: header
description: Identifies a unique version of the table metadata.
required: false
schema:
type: string

##############################
# Application Schema Objects #
##############################
Expand Down Expand Up @@ -4588,6 +4609,9 @@ components:
application/json:
schema:
$ref: '#/components/schemas/LoadTableResult'
headers:
etag:
$ref: '#/components/parameters/etag'

PlanTableScanResponse:
description: Result of submitting a table scan to plan
Expand Down Expand Up @@ -4616,6 +4640,9 @@ components:
application/json:
schema:
$ref: '#/components/schemas/LoadTableResult'
headers:
etag:
$ref: '#/components/parameters/etag'

LoadViewResponse:
description: View metadata result when loading a view
Expand Down