Skip to content

Commit 74d1b4e

Browse files
authored
fix(docs): fix entity doc API links. (#2316)
1 parent 78d5723 commit 74d1b4e

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

site/content/in-dev/unreleased/entities.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ This page documents various entities that can be managed in Apache Polaris (Incu
2828

2929
A catalog is a top-level entity in Polaris that may contain other entities like [namespaces](#namespace) and [tables](#table). These map directly to [Apache Iceberg catalogs](https://iceberg.apache.org/concepts/catalog/).
3030

31-
For information on managing catalogs with the REST API or for more information on what data can be associated with a catalog, see [the API docs]({{% github-polaris "client/python/docs/CreateCatalogRequest.md" %}}).
31+
For information on managing catalogs with the REST API or for more information on what data can be associated with a catalog, see [the CreateCatalogRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
3232

3333
### Storage Type
3434

3535
All catalogs in Polaris are associated with a _storage type_. Valid Storage Types are `S3`, `Azure`, and `GCS`. The `FILE` type is also additionally available for testing. Each of these types relates to a different storage provider where data within the catalog may reside. Depending on the storage type, various other configurations may be set for a catalog including credentials to be used when accessing data inside the catalog.
3636

37-
For details on how to use Storage Types in the REST API, see [the API docs]({{% github-polaris "client/python/docs/StorageConfigInfo.md" %}}).
37+
For details on how to use Storage Types in the REST API, see [the StorageConfigInfo OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
3838

3939
For usage examples of storage types, see [docs]({{% ref "command-line-interface" %}}).
4040

@@ -44,31 +44,31 @@ A namespace is a logical entity that resides within a [catalog](#catalog) and ca
4444

4545
In Polaris, namespaces can be nested. For example, `a.b.c.d.e.f.g` is a valid namespace. `b` is said to reside within `a`, and so on.
4646

47-
For information on managing namespaces with the REST API or for more information on what data can be associated with a namespace, see [the API docs]({{% github-polaris "client/python/docs/CreateNamespaceRequest.md" %}}).
47+
For information on managing namespaces with the REST API or for more information on what data can be associated with a namespace, see [the CreateNamespaceRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
4848

4949
## Table
5050

5151
Polaris tables are entities that map to [Apache Iceberg tables](https://iceberg.apache.org/docs/nightly/configuration/), [Delta tables](https://docs.databricks.com/aws/en/delta/table-properties), or [Hudi tables](https://hudi.apache.org/docs/next/configurations#TABLE_CONFIG).
5252

53-
For information on managing tables with the REST API or for more information on what data can be associated with a table, see [the API docs]({{% github-polaris "client/python/docs/CreateTableRequest.md" %}}).
53+
For information on managing tables with the REST API or for more information on what data can be associated with a table, see [the CreateTableRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
5454

5555
## View
5656

5757
Polaris views are entities that map to [Apache Iceberg views](https://iceberg.apache.org/view-spec/).
5858

59-
For information on managing views with the REST API or for more information on what data can be associated with a view, see [the API docs]({{% github-polaris "client/python/docs/CreateViewRequest.md" %}}).
59+
For information on managing views with the REST API or for more information on what data can be associated with a view, see [the CreateViewRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
6060

6161
## Principal
6262

6363
Polaris principals are unique identities that can be used to represent users or services. Each principal may have one or more [principal roles](#principal-role) assigned to it for the purpose of accessing catalogs and the entities within them.
6464

65-
For information on managing principals with the REST API or for more information on what data can be associated with a principal, see [the API docs]({{% github-polaris "client/python/docs/CreatePrincipalRequest.md" %}}).
65+
For information on managing principals with the REST API or for more information on what data can be associated with a principal, see [the CreatePrincipalRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml).
6666

6767
## Principal Role
6868

6969
Polaris principal roles are labels that may be granted to [principals](#principal). Each principal may have one or more principal roles, and the same principal role may be granted to multiple principals. Principal roles may be assigned based on the persona or responsibilities of a given principal, or on how that principal will need to access different entities within Polaris.
7070

71-
For information on managing principal roles with the REST API or for more information on what data can be associated with a principal role, see [the API docs]({{% github-polaris "client/python/docs/CreatePrincipalRoleRequest.md" %}}).
71+
For information on managing principal roles with the REST API or for more information on what data can be associated with a principal role, see [the CreatePrincipalRoleRequest OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml)
7272

7373
## Catalog Role
7474

@@ -88,8 +88,4 @@ Polaris privileges are granted to [catalog roles](#catalog-role) in order to gra
8888

8989
A privilege can be scoped to any entity inside a catalog, including the catalog itself.
9090

91-
For a list of supported privileges for each privilege class, see the API docs:
92-
* [Table Privileges]({{% github-polaris "client/python/docs/TablePrivilege.md" %}})
93-
* [View Privileges]({{% github-polaris "client/python/docs/ViewPrivilege.md" %}})
94-
* [Namespace Privileges]({{% github-polaris "client/python/docs/NamespacePrivilege.md" %}})
95-
* [Catalog Privileges]({{% github-polaris "client/python/docs/CatalogPrivilege.md" %}})
91+
For a list of supported privileges for each privilege class, see [the OpenAPI](https://github.com/apache/polaris/blob/main/spec/polaris-management-service.yml) (TablePrivilege, ViewPrivilege, NamespacePrivilege, CatalogPrivilege).

0 commit comments

Comments
 (0)