Merge pull request #177 from AppFlowy-IO/feat/open-api-doc

feat: add open api doc for get databases

documentation/appflowy-cloud/openapi/.openapi-generator/FILES

@@ -1,6 +1,29 @@
+Apis/DatabaseFieldsApi.md
+Apis/DatabaseRowDetailsApi.md
+Apis/DatabaseRowsApi.md
+Apis/DatabaseRowsUpdatedApi.md
+Apis/DatabasesApi.md
 Apis/WorkspacesApi.md
+Models/add_database_row.md
+Models/createDatabaseRow_200_response.md
+Models/database.md
+Models/database_field.md
+Models/database_row.md
+Models/database_row_detail.md
+Models/database_row_updated.md
+Models/folder_view_min.md
+Models/getDatabaseFields_200_response.md
+Models/getDatabaseRowDetails_200_response.md
+Models/getDatabaseRowIdsUpdated_200_response.md
+Models/getDatabaseRowIds_200_response.md
+Models/getDatabases_200_response.md
 Models/getWorkspaces_200_response.md
+Models/icon_type.md
 Models/response.md
 Models/role.md
+Models/upsertDatabaseRow_200_response.md
+Models/upsert_database_row.md
+Models/view_icon.md
+Models/view_layout.md
 Models/workspace.md
 README.md

documentation/appflowy-cloud/openapi/Apis/DatabaseFieldsApi.md

@@ -0,0 +1,33 @@
+# DatabaseFieldsApi
+
+All URIs are relative to *https://beta.appflowy.cloud*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDatabaseFields**](DatabaseFieldsApi.md#getDatabaseFields) | **GET** /api/workspace/{workspace_id}/database/{database_id}/fields | Retrieves a list of database fields in a selected database. |
+
+
+<a name="getDatabaseFields"></a>
+# **getDatabaseFields**
+> getDatabaseFields_200_response getDatabaseFields()
+
+Retrieves a list of database fields in a selected database.
+
+    Retrieves a list of database in a selected workspace. 
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**getDatabaseFields_200_response**](../Models/getDatabaseFields_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

documentation/appflowy-cloud/openapi/Apis/DatabaseRowDetailsApi.md

@@ -0,0 +1,37 @@
+# DatabaseRowDetailsApi
+
+All URIs are relative to *https://beta.appflowy.cloud*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDatabaseRowDetails**](DatabaseRowDetailsApi.md#getDatabaseRowDetails) | **GET** /api/workspace/{workspace_id}/database/{database_id}/row/detail | Retrieves a list of database row details in a selected database. |
+
+
+<a name="getDatabaseRowDetails"></a>
+# **getDatabaseRowDetails**
+> getDatabaseRowDetails_200_response getDatabaseRowDetails(ids, with\_doc)
+
+Retrieves a list of database row details in a selected database.
+
+    Retrieves a list of database row details in a selected database. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ids** | **String**| A comma-separated list of database row uuids to retrieve. (e.g., ids&#x3D;uuid1,uuid2,uuid3) | [default to null] |
+| **with\_doc** | **Boolean**| Include the document data for each row when set to true. | [optional] [default to null] |
+
+### Return type
+
+[**getDatabaseRowDetails_200_response**](../Models/getDatabaseRowDetails_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

documentation/appflowy-cloud/openapi/Apis/DatabaseRowsApi.md

@@ -0,0 +1,89 @@
+# DatabaseRowsApi
+
+All URIs are relative to *https://beta.appflowy.cloud*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createDatabaseRow**](DatabaseRowsApi.md#createDatabaseRow) | **POST** /api/workspace/{workspace_id}/database/{database_id}/row | Creates a new row in a selected database. |
+| [**getDatabaseRowIds**](DatabaseRowsApi.md#getDatabaseRowIds) | **GET** /api/workspace/{workspace_id}/database/{database_id}/row | Retrieves a list of database row ids in a selected database. |
+| [**upsertDatabaseRow**](DatabaseRowsApi.md#upsertDatabaseRow) | **PUT** /api/workspace/{workspace_id}/database/{database_id}/row | Updates or creates a row in a selected database. (Upsert) |
+
+
+<a name="createDatabaseRow"></a>
+# **createDatabaseRow**
+> createDatabaseRow_200_response createDatabaseRow(add\_database\_row)
+
+Creates a new row in a selected database.
+
+    Creates a new row in a selected database. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **add\_database\_row** | [**add_database_row**](../Models/add_database_row.md)|  | |
+
+### Return type
+
+[**createDatabaseRow_200_response**](../Models/createDatabaseRow_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+<a name="getDatabaseRowIds"></a>
+# **getDatabaseRowIds**
+> getDatabaseRowIds_200_response getDatabaseRowIds()
+
+Retrieves a list of database row ids in a selected database.
+
+    Retrieves a list of database in a selected workspace. 
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**getDatabaseRowIds_200_response**](../Models/getDatabaseRowIds_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+<a name="upsertDatabaseRow"></a>
+# **upsertDatabaseRow**
+> upsertDatabaseRow_200_response upsertDatabaseRow(upsert\_database\_row)
+
+Updates or creates a row in a selected database. (Upsert)
+
+    Given a key, updates a row in a selected database. If the row does not exist, creates a new row. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **upsert\_database\_row** | [**upsert_database_row**](../Models/upsert_database_row.md)|  | |
+
+### Return type
+
+[**upsertDatabaseRow_200_response**](../Models/upsertDatabaseRow_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

documentation/appflowy-cloud/openapi/Apis/DatabaseRowsUpdatedApi.md

@@ -0,0 +1,36 @@
+# DatabaseRowsUpdatedApi
+
+All URIs are relative to *https://beta.appflowy.cloud*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDatabaseRowIdsUpdated**](DatabaseRowsUpdatedApi.md#getDatabaseRowIdsUpdated) | **GET** /api/workspace/{workspace_id}/database/{database_id}/row/updated | Retrieves a list of database row id which are recently updated in a selected database. |
+
+
+<a name="getDatabaseRowIdsUpdated"></a>
+# **getDatabaseRowIdsUpdated**
+> getDatabaseRowIdsUpdated_200_response getDatabaseRowIdsUpdated(after)
+
+Retrieves a list of database row id which are recently updated in a selected database.
+
+    Retrieves a list of database in a selected workspace. 
+
+### Parameters
+
+|Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **after** | **Date**| Fetch the list of database row ids updated after the specified date and time. | [optional] [default to null] |
+
+### Return type
+
+[**getDatabaseRowIdsUpdated_200_response**](../Models/getDatabaseRowIdsUpdated_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

documentation/appflowy-cloud/openapi/Apis/DatabasesApi.md

@@ -0,0 +1,33 @@
+# DatabasesApi
+
+All URIs are relative to *https://beta.appflowy.cloud*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDatabases**](DatabasesApi.md#getDatabases) | **GET** /api/workspace/{workspace_id}/database | Retrieves a list of database in a workspace |
+
+
+<a name="getDatabases"></a>
+# **getDatabases**
+> getDatabases_200_response getDatabases()
+
+Retrieves a list of database in a workspace
+
+    Retrieves a list of database in a selected workspace. 
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**getDatabases_200_response**](../Models/getDatabases_200_response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+