# Rust API client for the Iceberg REST Catalog API

Defines the specification for the first version of the REST Catalog API.
Implementations should ideally support both Iceberg table specs v1 and v2, with
priority given to v2.

## Overview

This API client was generated by the
[OpenAPI Generator](https://openapi-generator.tech) project. By using the
[openapi-spec](https://openapis.org) from a remote server, you can easily
generate an API client.

- API version: 0.0.1
- Package version: 0.0.1
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `openapi` and add
the following to `Cargo.toml` under `[dependencies]`:

```
openapi = { path = "./openapi" }
```

## Documentation for API Endpoints

All URIs are relative to _https://localhost_

| Class                 | Method                                                                       | HTTP request                                                        | Description                                                                 |
| --------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| _CatalogApiApi_       | [**create_namespace**](docs/CatalogApiApi.md#create_namespace)               | **POST** /v1/{prefix}/namespaces                                    | Create a namespace                                                          |
| _CatalogApiApi_       | [**create_table**](docs/CatalogApiApi.md#create_table)                       | **POST** /v1/{prefix}/namespaces/{namespace}/tables                 | Create a table in the given namespace                                       |
| _CatalogApiApi_       | [**drop_namespace**](docs/CatalogApiApi.md#drop_namespace)                   | **DELETE** /v1/{prefix}/namespaces/{namespace}                      | Drop a namespace from the catalog. Namespace must be empty.                 |
| _CatalogApiApi_       | [**drop_table**](docs/CatalogApiApi.md#drop_table)                           | **DELETE** /v1/{prefix}/namespaces/{namespace}/tables/{table}       | Drop a table from the catalog                                               |
| _CatalogApiApi_       | [**list_namespaces**](docs/CatalogApiApi.md#list_namespaces)                 | **GET** /v1/{prefix}/namespaces                                     | List namespaces, optionally providing a parent namespace to list underneath |
| _CatalogApiApi_       | [**list_tables**](docs/CatalogApiApi.md#list_tables)                         | **GET** /v1/{prefix}/namespaces/{namespace}/tables                  | List all table identifiers underneath a given namespace                     |
| _CatalogApiApi_       | [**load_namespace_metadata**](docs/CatalogApiApi.md#load_namespace_metadata) | **GET** /v1/{prefix}/namespaces/{namespace}                         | Load the metadata properties for a namespace                                |
| _CatalogApiApi_       | [**load_table**](docs/CatalogApiApi.md#load_table)                           | **GET** /v1/{prefix}/namespaces/{namespace}/tables/{table}          | Load a table from the catalog                                               |
| _CatalogApiApi_       | [**rename_table**](docs/CatalogApiApi.md#rename_table)                       | **POST** /v1/{prefix}/tables/rename                                 | Rename a table from its current name to a new name                          |
| _CatalogApiApi_       | [**report_metrics**](docs/CatalogApiApi.md#report_metrics)                   | **POST** /v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics | Send a metrics report to this endpoint to be processed by the backend       |
| _CatalogApiApi_       | [**table_exists**](docs/CatalogApiApi.md#table_exists)                       | **HEAD** /v1/{prefix}/namespaces/{namespace}/tables/{table}         | Check if a table exists                                                     |
| _CatalogApiApi_       | [**update_properties**](docs/CatalogApiApi.md#update_properties)             | **POST** /v1/{prefix}/namespaces/{namespace}/properties             | Set or remove properties on a namespace                                     |
| _CatalogApiApi_       | [**update_table**](docs/CatalogApiApi.md#update_table)                       | **POST** /v1/{prefix}/namespaces/{namespace}/tables/{table}         | Commit updates to a table                                                   |
| _ConfigurationApiApi_ | [**get_config**](docs/ConfigurationApiApi.md#get_config)                     | **GET** /v1/config                                                  | List all catalog configuration settings                                     |
| _OAuth2ApiApi_        | [**get_token**](docs/OAuth2ApiApi.md#get_token)                              | **POST** /v1/oauth/tokens                                           | Get a token using an OAuth2 flow                                            |

## Documentation For Models

- [AddPartitionSpecUpdate](docs/AddPartitionSpecUpdate.md)
- [AddPartitionSpecUpdateAllOf](docs/AddPartitionSpecUpdateAllOf.md)
- [AddSchemaUpdate](docs/AddSchemaUpdate.md)
- [AddSchemaUpdateAllOf](docs/AddSchemaUpdateAllOf.md)
- [AddSnapshotUpdate](docs/AddSnapshotUpdate.md)
- [AddSnapshotUpdateAllOf](docs/AddSnapshotUpdateAllOf.md)
- [AddSortOrderUpdate](docs/AddSortOrderUpdate.md)
- [AddSortOrderUpdateAllOf](docs/AddSortOrderUpdateAllOf.md)
- [AndOrExpression](docs/AndOrExpression.md)
- [BaseUpdate](docs/BaseUpdate.md)
- [CatalogConfig](docs/CatalogConfig.md)
- [CommitTableRequest](docs/CommitTableRequest.md)
- [CounterResult](docs/CounterResult.md)
- [CreateNamespace200Response](docs/CreateNamespace200Response.md)
- [CreateNamespaceRequest](docs/CreateNamespaceRequest.md)
- [CreateTableRequest](docs/CreateTableRequest.md)
- [ErrorModel](docs/ErrorModel.md)
- [Expression](docs/Expression.md)
- [GetToken200Response](docs/GetToken200Response.md)
- [GetToken400Response](docs/GetToken400Response.md)
- [ListNamespaces200Response](docs/ListNamespaces200Response.md)
- [ListTables200Response](docs/ListTables200Response.md)
- [ListType](docs/ListType.md)
- [LiteralExpression](docs/LiteralExpression.md)
- [LoadNamespaceMetadata200Response](docs/LoadNamespaceMetadata200Response.md)
- [LoadTableResult](docs/LoadTableResult.md)
- [MapType](docs/MapType.md)
- [MetadataLogInner](docs/MetadataLogInner.md)
- [MetricResult](docs/MetricResult.md)
- [NotExpression](docs/NotExpression.md)
- [NullOrder](docs/NullOrder.md)
- [PartitionField](docs/PartitionField.md)
- [PartitionSpec](docs/PartitionSpec.md)
- [RemovePropertiesUpdate](docs/RemovePropertiesUpdate.md)
- [RemovePropertiesUpdateAllOf](docs/RemovePropertiesUpdateAllOf.md)
- [RemoveSnapshotRefUpdate](docs/RemoveSnapshotRefUpdate.md)
- [RemoveSnapshotsUpdate](docs/RemoveSnapshotsUpdate.md)
- [RemoveSnapshotsUpdateAllOf](docs/RemoveSnapshotsUpdateAllOf.md)
- [RenameTableRequest](docs/RenameTableRequest.md)
- [ReportMetricsRequest](docs/ReportMetricsRequest.md)
- [ScanReport](docs/ScanReport.md)
- [Schema](docs/Schema.md)
- [SchemaAllOf](docs/SchemaAllOf.md)
- [SetCurrentSchemaUpdate](docs/SetCurrentSchemaUpdate.md)
- [SetCurrentSchemaUpdateAllOf](docs/SetCurrentSchemaUpdateAllOf.md)
- [SetDefaultSortOrderUpdate](docs/SetDefaultSortOrderUpdate.md)
- [SetDefaultSortOrderUpdateAllOf](docs/SetDefaultSortOrderUpdateAllOf.md)
- [SetDefaultSpecUpdate](docs/SetDefaultSpecUpdate.md)
- [SetDefaultSpecUpdateAllOf](docs/SetDefaultSpecUpdateAllOf.md)
- [SetExpression](docs/SetExpression.md)
- [SetLocationUpdate](docs/SetLocationUpdate.md)
- [SetLocationUpdateAllOf](docs/SetLocationUpdateAllOf.md)
- [SetPropertiesUpdate](docs/SetPropertiesUpdate.md)
- [SetPropertiesUpdateAllOf](docs/SetPropertiesUpdateAllOf.md)
- [SetSnapshotRefUpdate](docs/SetSnapshotRefUpdate.md)
- [SetSnapshotRefUpdateAllOf](docs/SetSnapshotRefUpdateAllOf.md)
- [Snapshot](docs/Snapshot.md)
- [SnapshotLogInner](docs/SnapshotLogInner.md)
- [SnapshotReference](docs/SnapshotReference.md)
- [SnapshotSummary](docs/SnapshotSummary.md)
- [SortDirection](docs/SortDirection.md)
- [SortField](docs/SortField.md)
- [SortOrder](docs/SortOrder.md)
- [StructField](docs/StructField.md)
- [StructType](docs/StructType.md)
- [TableIdentifier](docs/TableIdentifier.md)
- [TableMetadata](docs/TableMetadata.md)
- [TableRequirement](docs/TableRequirement.md)
- [TableUpdate](docs/TableUpdate.md)
- [Term](docs/Term.md)
- [TimerResult](docs/TimerResult.md)
- [TokenType](docs/TokenType.md)
- [TransformTerm](docs/TransformTerm.md)
- [Type](docs/Type.md)
- [UnaryExpression](docs/UnaryExpression.md)
- [UpdateNamespacePropertiesRequest](docs/UpdateNamespacePropertiesRequest.md)
- [UpdateProperties200Response](docs/UpdateProperties200Response.md)
- [UpdateTable200Response](docs/UpdateTable200Response.md)
- [UpgradeFormatVersionUpdate](docs/UpgradeFormatVersionUpdate.md)
- [UpgradeFormatVersionUpdateAllOf](docs/UpgradeFormatVersionUpdateAllOf.md)

To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author