Skip to content

Update profile file description about icebergEndpoint #120

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

Merged
linzhou-db merged 8 commits into from
Oct 20, 2026
Merged

Update profile file description about icebergEndpoint #120

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c5d1ca
Update profile file description about icebergEndpoint
linzhou-db Oct 16, 2026
5d32e00
resolve comment
linzhou-db Oct 16, 2026
4799ed2
resolve comment
linzhou-db Oct 20, 2026
beed401
fix format
linzhou-db Oct 20, 2026
6602b53
fix format
linzhou-db Oct 20, 2026
fa8100b
format
linzhou-db Oct 20, 2026
4ed7ada
fix wording
linzhou-db Oct 20, 2026
8de5ea3
format
linzhou-db Oct 20, 2026
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
30 changes: 21 additions & 9 deletions spec/protocols/OVERVIEW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,38 @@ This document describes the OpenSharing Protocol's general concepts, including t

A profile file is a JSON file that contains the information for a recipient to access shared data on a OpenSharing server. There are a few fields in this file as listed below.

Field Name | Descrption
-|-
shareCredentialsVersion | The file format version of the profile file. This version will be increased whenever non-forward-compatible changes are made to the profile format. When a client is running an unsupported profile file format version, it should show an error message instructing the user to upgrade to a newer version of their client.
endpoint | The url of the sharing server.
icebergEndpoint | The url of the sharing server that supports the iceberg table endpoints.
bearerToken | The [bearer token](https://tools.ietf.org/html/rfc6750) to access the server.
expirationTime | The expiration time of the bearer token in [ISO 8601 format](https://www.w3.org/TR/NOTE-datetime). This field is optional and if it is not provided, the bearer token can be seen as never expire.
| Field Name | Description | Note |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| shareCredentialsVersion | The file format version of the profile file. This version will be increased whenever non-forward-compatible changes are made to the profile format. When a client is running an unsupported profile file format version, it should show an error message instructing the user to upgrade to a newer version of their client. | [required] |
| endpoint | The url of the sharing server. | [required] |
| icebergEndpoint | The url of the sharing server's Iceberg REST catalog endpoint. If provided, it must be `{endpoint}/iceberg`. | [optional] |
| bearerToken | The [bearer token](https://tools.ietf.org/html/rfc6750) to access the server. | [required] |
| expirationTime | The expiration time of the bearer token in [ISO 8601 format](https://www.w3.org/TR/NOTE-datetime). This field is optional and if it is not provided, the bearer token can be seen as never expire. | [optional] |

Example:

```json
{
"shareCredentialsVersion": 1,
"endpoint": "https://sharing.opensharing.io/open-sharing/",
"icebergEndpoint": "https://sharing.opensharing.io/open-sharing/iceberg/",
"endpoint": "https://sharing.opensharing.io/open-sharing",
"icebergEndpoint": "https://sharing.opensharing.io/open-sharing/iceberg",
"bearerToken": "<token>",
"expirationTime": "2021-11-12T00:12:29.0Z"
}
```

or

```json
{
"shareCredentialsVersion": 1,
"endpoint": "https://sharing.opensharing.io/open-sharing",
"bearerToken": "<token>"
}
```

OpenSharing servers that share tables in Iceberg format may optionally provide an `icebergEndpoint` in the profile file. If provided, it must be `{endpoint}/iceberg`. Clients must not assume `icebergEndpoint` is present and should handle its absence gracefully.

## Names

Share, Schema, and shared objects are identifiable by names. To ensure compatibility and avoid issues across different sharing servers, the following limitations apply for object names:
Expand Down
Loading