openapi: 3.0.0
servers:
- url: https://{subdomain}.aircampi.com/database/{version}
description: Aircampi Database API
variables:
subdomain:
description: >-
Base URL. The Aircampi Database API is served over HTTPS. All URLs
referenced in the documentation have the following **base URL**. It
can be your custom domain or {project_id}.aircampi.com (full URL)
default: open
version:
description: Default server version
default: latest
enum:
- latest
- 0.1.0
info:
description: >
# Introduction
The Aircampi Database is a data store stack that manage your application's
business data. Here is technical API reference docs for Aircampi Database.
- **Database**
Aircampi Database allows you to create multiple databases. Each database can contain many tables and can be backed by a different database adaptor in future versions.
You can create your database by adding it to your Aircampi Console's dashboard. Access the Databases Service settings from your project's left-hand navigation panel.
To create a new database, click **Add Database** button. Name your new database and optionally provide database options.
- **Table**
Aircampi Database uses tables as containers of data.
To add a table to a database, first navigate to the desired project's database in Aircampi Console.
In the project's database, click the **Add Table** button and choose your table's name.
- **Column**
Columns are used to define the structure of your data and help the Aircampi API validate your users' input.
Add your first column by clicking the **Add column** button.
You can choose between the following types:
- string
- number
- date
- datetime
- boolean
- array
- object
- **Row**
Storing data through the Database API is built around a JSON encoding of the object’s data.
This data's structure depends on column.
- **Index**
Indexes are used by Databases to quickly locate data without having to search through every data for results.
To ensure the best performance, Aircampi Database requires an index for every query.
You can create an index by navigating to the Indexes tab of your table or by using your favorite Server SDK.
If you plan to query multiple columns in a single query, you will need an index with all queried attributes.
**Quick Links:**
- [How to get started](/api/getting-started/)
- [Guides & Docs](/docs/database/)
- [Database API references](/api/database/)
- [Database SDK Libraries](/sdk/database/)
# Endpoints
This section contains the information about api references for Aircampi Database.
Group of endpoints:
- [Databases](#tag/Databases)
- [Tables](#tag/Tables)
- [Columns](#tag/Columns)
- [Rows](#tag/Rows)
- [Indexes](#tag/Indexes)
- [Health Check](#tag/Health-Check)
- [Settings](#tag/Settings)
version: 0.1.0
title: Aircampi Database
termsOfService: https://developer.aircampi.com/legal/
contact:
name: Support
email: team@aircampi.com
url: https://github.com/aircampi
x-logo:
url: https://github.com/aircampi.png
altText: Aircampi logo
x-tagGroups:
- name: Endpoints
tags:
- Databases
- Tables
- Columns
- Rows
- Indexes
- Settings
- Health Check
- name: Models
description: ahaha
tags:
- Models
- Database Models
- Table Models
- Column Models
- Row Models
- Index Models
- Settings Models
- Health Check Models
tags:
- name: Databases
description: >
Aircampi Database allows you to create multiple databases. Each database
can contain many tables and can be backed by a different database adaptor
in future versions.
You can create your database by adding it to your Aircampi Console's
dashboard. Access the Databases Service settings from your project's
left-hand navigation panel.
To create a new database, click **Add Database** button. Name your new
database and optionally provide database options.
- name: Tables
description: >
Aircampi Database uses tables as containers of data.
To add a table to a database, first navigate to the desired project's
database in Aircampi Console.
In the project's database, click the **Add Table** button and choose your
table's name.
- name: Columns
description: >
Columns are used to define the structure of your data and help the
Aircampi API validate your users' input.
Add your first column by clicking the **Add column** button.
You can choose between the following types:
- string
- number
- boolean
- date
- datetime
- reference
- geopoint
- array
- json
- file
- name: Rows
description: >
Storing data through the Database API is built around a JSON encoding of
the object’s data.
This data's structure depends on column.
- name: Indexes
description: >
Indexes are used by Databases to quickly locate data without having to
search through every data for results.
To ensure the best performance, Aircampi Database requires an index for
every query.
You can create an index by navigating to the Indexes tab of your table or
by using your favorite Server SDK.
If you plan to query multiple columns in a single query, you will need an
index with all queried attributes.
- name: Settings
description: >
Aircampi Database's settings allow you to edit your server setup
configuration and customize it.
You can easily change the it by changing them when running Aircampi
Database.
- name: Health Check
description: >
The Health service is designed to allow you to both validate and monitor
that your Aircampi Database's instance and all of its internal components
are up and responsive.
- name: Models
description: >
This section contains the information about resources for Aircampi
Database and their fields, and child resources.
Group of models:
- [Database Models](#tag/Database-Models)
- [Table Models](#tag/Table-Models)
- [Column Models](#tag/Column-Models)
- [Row Models](#tag/Row-Models)
- [Index Models](#tag/Index-Models)
- [Health Check Models](#tag/Health-Check-Models)
- [Settings Models](#tag/Settings-Models)
- name: Database Models
x-displayName: Database Models
description: |
Database Models
- [Database](#section/Database)
- [Databases](#section/Databases)
- [Database Aggregation](#section/Database-Aggregation)
## Database
**Resource Type:** Single Resource
**Fields:**
- name
- description
- metadata
- created_at
- updated_at
**Child Resources:**
- aggregations
- tables
## Databases
**Resource Type:** Collection Resource
## Database Aggregation
**Resource Type:** Single Resource
**Fields:**
- database
- tables
- columns
- rows
- indexes
- created_at
- updated_at
**Child Resources:**
`No child resources.`
- name: Table Models
x-displayName: Table Models
description: |
Table Models
- [Table](#section/Table)
- [Tables](#section/Tables)
- [Table Aggregation](#section/Table-Aggregation)
## Table
**Resource Type:** Single Resource
**Fields:**
- database
- name
- description
- metadata
- created_at
- updated_at
**Child Resources:**
- aggregations
- columns
- rows
- indexes
## Tables
**Resource Type:** Collection Resource
## Table Aggregation
**Resource Type:** Single Resource
**Fields:**
- table
- columns
- rows
- indexes
- created_at
- updated_at
**Child Resources:**
`No child resources.`
- name: Column Models
x-displayName: Column Models
description: |
Column Models
- [Column](#section/Column)
- [Columns](#section/Columns)
## Column
**Resource Type:** Single Resource
**Fields:**
- table
- name
- type
- description
- metadata
- builtin
- created_at
- updated_at
**Child Resources:**
`No child resources.`
## Columns
**Resource Type:** Collection Resource
- name: Row Models
x-displayName: Row Models
description: |
Row Models
- [Row](#section/Row)
- [Rows](#section/Rows)
## Row
**Resource Type:** Single Resource
**Fields:**
- id `builtin`
- created_at `builtin`
- updated_at `builtin`
- **Custom fields** depends on table columns
**Child Resources:**
`No child resources.`
## Rows
**Resource Type:** Collection Resource
- name: Index Models
x-displayName: Index Models
description: |
Index Models
- [Index](#section/Index)
- [Indexes](#section/Indexes)
## Index
**Resource Type:** Single Resource
**Fields:**
- table
- name
- type
- description
- columns
- metadata
- builtin
- created_at
- updated_at
**Child Resources:**
`No child resources.`
## Indexes
**Resource Type:** Collection Resource
- name: Health Check Models
x-displayName: Health Check Models
description: |
Health Check Models
- [Health Check](#section/Health-Check)
## Health Check
**Resource Type:** Single Resource
**Fields:**
- server_name
- server_version
- server_status
- server_description
**Child Resources:**
`No child resources.`
- name: Settings Models
x-displayName: Settings Models
description: |
Settings Models
- [Server Settings](#section/Server-Settings)
## Server Settings
**Resource Type:** Single Resource
**Fields:**
- id
- created_at
- updated_at
**Child Resources:**
`No child resources.`
paths:
/databases:
get:
tags:
- Databases
summary: Get databases
description: 'Retrieve filtered list of databases. '
operationId: get_databases
security:
- Scopes:
- read:databases
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
- $ref: '#/components/parameters/query_q'
- $ref: '#/components/parameters/query_sort'
- $ref: '#/components/parameters/query_offset'
- $ref: '#/components/parameters/query_limit'
- $ref: '#/components/parameters/query_total_count'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/databases'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
post:
tags:
- Databases
summary: Create database
description: Create database
operationId: create_database
security:
- Scopes:
- create:databases
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/database_create'
responses:
'201':
description: Created.
content:
application/json:
schema:
$ref: '#/components/schemas/database_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
examples:
invalid_request_uri:
code: haha
description: hoho
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/databases/{database}:
get:
tags:
- Databases
summary: Get Database
description: Retrieve databse details.
operationId: get_database
security:
- Scopes:
- read:databases
parameters:
- $ref: '#/components/parameters/path_database'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/database_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Databases
summary: Update Database
description: Update Database
operationId: update_database
security:
- Scopes:
- update:databases
parameters:
- $ref: '#/components/parameters/path_database'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/database_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/database_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
delete:
tags:
- Databases
summary: Delete Database
description: Delete Database. Default Database cannot be deleted.
operationId: delete_database
security:
- Scopes:
- delete:databases
parameters:
- $ref: '#/components/parameters/path_database'
- $ref: '#/components/parameters/header_authorization_bearer'
responses:
'204':
description: No Content.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/databases/{database}/rename:
post:
tags:
- Databases
summary: Rename Database
description: Rename Database
operationId: rename_database
security:
- Scopes:
- update:databases
parameters:
- $ref: '#/components/parameters/path_database'
- $ref: '#/components/parameters/header_authorization_bearer'
requestBody:
$ref: '#/components/requestBodies/database_rename'
responses:
'200':
description: OK.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables:
get:
tags:
- Tables
summary: Get Tables
description: 'Retrieve filtered list of tables. '
operationId: get_tables
security:
- Scopes:
- read:tables
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
- $ref: '#/components/parameters/query_q'
- $ref: '#/components/parameters/query_sort'
- $ref: '#/components/parameters/query_offset'
- $ref: '#/components/parameters/query_limit'
- $ref: '#/components/parameters/query_total_count'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/tables'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
post:
tags:
- Tables
summary: Create Table
description: Create Table
operationId: create_table
security:
- Scopes:
- create:tables
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/table_create'
responses:
'201':
description: Created.
content:
application/json:
schema:
$ref: '#/components/schemas/table_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}:
get:
tags:
- Tables
summary: Get Table
description: Retrieve table details.
operationId: get_table
security:
- Scopes:
- read:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/table_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Tables
summary: Update Table
description: Update Table
operationId: update_table
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/table_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/table_expanded'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
delete:
tags:
- Tables
summary: Delete Table
description: Delete Table
operationId: delete_table
security:
- Scopes:
- delete:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
responses:
'204':
description: No Content.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/truncate:
post:
tags:
- Tables
summary: Truncate Table
description: Truncate Table
operationId: truncate_table
security:
- Scopes:
- truncate:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
responses:
'200':
description: OK.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/rename:
post:
tags:
- Tables
summary: Rename Table
description: Rename Table
operationId: rename_table
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
requestBody:
$ref: '#/components/requestBodies/table_rename'
responses:
'200':
description: OK.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/columns:
get:
tags:
- Columns
summary: Get Columns
description: 'Retrieve filtered list of columns. '
operationId: get_columns
security:
- Scopes:
- read:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
- $ref: '#/components/parameters/query_q'
- $ref: '#/components/parameters/query_sort'
- $ref: '#/components/parameters/query_offset'
- $ref: '#/components/parameters/query_limit'
- $ref: '#/components/parameters/query_total_count'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/columns'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
post:
tags:
- Columns
summary: Create Column
description: Create Column
operationId: create_column
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/column_create'
responses:
'201':
description: Created.
content:
application/json:
schema:
$ref: '#/components/schemas/column'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/columns/{column}:
get:
tags:
- Columns
summary: Get Column
description: Retrieve column details.
operationId: get_column
security:
- Scopes:
- read:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_column'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/column'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Columns
summary: Update Column
description: Update Column
operationId: update_column
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_column'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/column_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/column'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
delete:
tags:
- Columns
summary: Delete Column
description: Delete Column
operationId: delete_column
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_column'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
responses:
'204':
description: No Content.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/columns/{column}/rename:
post:
tags:
- Columns
summary: Rename Column
description: Rename Column
operationId: rename_column
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_column'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
requestBody:
$ref: '#/components/requestBodies/column_rename'
responses:
'200':
description: OK.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/rows:
get:
tags:
- Rows
summary: Get Rows
description: 'Retrieve filtered list of rows. '
operationId: get_rows
security:
- Scopes:
- read:rows
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
- $ref: '#/components/parameters/query_q'
- $ref: '#/components/parameters/query_sort'
- $ref: '#/components/parameters/query_offset'
- $ref: '#/components/parameters/query_limit'
- $ref: '#/components/parameters/query_total_count'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/rows'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
post:
tags:
- Rows
summary: Create Row
description: Create Row
operationId: create_row
security:
- Scopes:
- create:rows
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/row_create'
responses:
'201':
description: Created.
content:
application/json:
schema:
$ref: '#/components/schemas/row'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/rows/{row_id}:
get:
tags:
- Rows
summary: Get Row
description: Retrieve row details.
operationId: get_row
security:
- Scopes:
- read:rows
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_row_id'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/row'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Rows
summary: Update Row
description: Update Row
operationId: update_row
security:
- Scopes:
- update:rows
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_row_id'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/row_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/row'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
delete:
tags:
- Rows
summary: Delete Row
description: Delete Row
operationId: delete_row
security:
- Scopes:
- update:rows
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_row_id'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
responses:
'204':
description: No Content.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/indexes:
get:
tags:
- Indexes
summary: Get Indexes
description: 'Retrieve filtered list of indexes. '
operationId: get_indexes
security:
- Scopes:
- read:indexes
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
- $ref: '#/components/parameters/query_q'
- $ref: '#/components/parameters/query_sort'
- $ref: '#/components/parameters/query_offset'
- $ref: '#/components/parameters/query_limit'
- $ref: '#/components/parameters/query_total_count'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/indexes'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
post:
tags:
- Indexes
summary: Create Index
description: Create Index
operationId: create_index
security:
- Scopes:
- create:indexes
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/index_create'
responses:
'201':
description: Created.
content:
application/json:
schema:
$ref: '#/components/schemas/index'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/indexes/{index}:
get:
tags:
- Indexes
summary: Get Index
description: Retrieve index details.
operationId: get_index
security:
- Scopes:
- read:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_index'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/index'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Indexes
summary: Update Index
description: Update Index
operationId: update_index
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_index'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/index_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/index'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
delete:
tags:
- Indexes
summary: Delete Index
description: Delete Index
operationId: delete_index
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_index'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
responses:
'204':
description: No Content.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'404':
$ref: '#/components/responses/404_not_found'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/tables/{table}/indexes/{index}/rename:
post:
tags:
- Indexes
summary: Rename Index
description: Rename Index
operationId: rename_index
security:
- Scopes:
- update:tables
parameters:
- $ref: '#/components/parameters/path_table'
- $ref: '#/components/parameters/path_index'
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/header_database'
requestBody:
$ref: '#/components/requestBodies/column_rename'
responses:
'200':
description: OK.
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/health:
get:
tags:
- Health Check
summary: Check Health
description: |
Check Health
operationId: check_health
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/health'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
/settings:
get:
tags:
- Settings
summary: Get Settings
description: Get Settings
operationId: get_settings
security:
- Scopes:
- read:settings
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/settings'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
put:
tags:
- Settings
summary: Update Settings
description: Update Settings
operationId: update_settings
security:
- Scopes:
- update:settings
parameters:
- $ref: '#/components/parameters/header_authorization_bearer'
- $ref: '#/components/parameters/query_fields'
- $ref: '#/components/parameters/query_expand'
requestBody:
$ref: '#/components/requestBodies/server_settings_update'
responses:
'200':
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/settings'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
'400':
$ref: '#/components/responses/400_bad_request'
'401':
$ref: '#/components/responses/401_unauthorized'
'403':
$ref: '#/components/responses/403_forbidden'
'405':
$ref: '#/components/responses/405_method_not_allowed'
'409':
$ref: '#/components/responses/409_conflict'
'429':
$ref: '#/components/responses/429_too_many_requests'
'500':
$ref: '#/components/responses/500_internal_server_error'
'501':
$ref: '#/components/responses/501_not_implemented'
'503':
$ref: '#/components/responses/503_service_unavailable'
components:
responses:
400_bad_request:
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/response_bad_request'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
401_unauthorized:
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/response_unauthorized'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
403_forbidden:
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/response_forbidden'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
404_not_found:
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/response_not_found'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
405_method_not_allowed:
description: Method not allowed.
content:
application/json:
schema:
$ref: '#/components/schemas/response_method_not_allowed'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
409_conflict:
description: Conflict.
content:
application/json:
schema:
$ref: '#/components/schemas/response_conflict'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
429_too_many_requests:
description: Too many requests.
content:
application/json:
schema:
$ref: '#/components/schemas/response_too_many_request'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
500_internal_server_error:
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/response_internal_server_error'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
501_not_implemented:
description: Not implemented.
content:
application/json:
schema:
$ref: '#/components/schemas/response_not_implemented'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
503_service_unavailable:
description: Service unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/response_service_unavailable'
headers:
X-RateLimit-Limit:
description: Request limit.
schema:
type: integer
example: 100
X-RateLimit-Remaining:
description: The number of requests left for the time window.
schema:
type: integer
example: 99
X-RateLimit-Reset:
description: The UTC date/time at which the current rate limit window resets.
schema:
type: string
format: date-time
example: '2022-10-12T11:00:00Z'
parameters:
header_authorization_bearer:
name: Authorization
in: header
description: Access Token
required: true
schema:
$ref: '#/components/schemas/bearer_authorization'
header_authorization_basic:
name: Authorization
in: header
description: >-
Client Identifier and Secret encoded by base64. It is `required` when
client is **confidential**.
schema:
type: string
$ref: '#/components/schemas/basic_authorization'
header_authorization_basic_or_bearer:
name: Authorization
in: header
description: '`Basic {{base64_encoded}}` or `Bearer {{access_token}}`'
required: true
schema:
oneOf:
- $ref: '#/components/schemas/bearer_authorization'
- $ref: '#/components/schemas/basic_authorization'
header_content_type:
name: Content-Type
in: header
description: application/x-www-form-urlencoded
required: true
schema:
type: string
example: application/x-www-form-urlencoded
header_database:
name: database
in: header
description: Database
required: true
schema:
$ref: '#/components/schemas/database_name'
query_fields:
name: fields
in: query
description: >-
This parameter filters the resource attributes. Only the specified
attributes are returned. Format: ?fields=id,name
required: false
schema:
type: string
query_expand:
name: expand
in: query
description: >-
When this parameter is provided, the specified children are included in
the resource payload (instead of just a link). The value of this query
parameter is "all" or "". Example: ?expand=all
required: false
schema:
type: string
default: ''
query_q:
name: q
in: query
description: >-
This query parameter defines the where clause. Example:
?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
required: false
schema:
type: string
query_sort:
name: sort
in: query
description: >-
This parameter sort a resource collection based on the specified
attributes. The parameter value is a comma-separated string of attribute
names, each optionally followed by a colon and "asc" or "desc". Specify
"asc" for ascending and "desc" for descending. For example,
?sort=created_at asc,updated_at desc
required: false
schema:
type: string
query_offset:
name: offset
in: query
description: >-
Used to define the starting position of the item collection. If offset
exceeds the item count then no items are returned.
required: false
schema:
type: integer
minimum: 0
default: 0
query_limit:
name: limit
in: query
description: >-
This parameter restricts the number of items returned inside the
collection. If the limit exceeds the item count then the server will
only return the available items.
required: false
schema:
type: integer
minimum: 1
default: 10
query_total_count:
name: total_count
in: query
description: >-
The item collection representation will include the "estimated row
count" when "?total_count=true", otherwise the total_count is not
included.
required: false
schema:
type: boolean
default: false
path_database:
name: database
in: path
description: Database Name
required: true
schema:
$ref: '#/components/schemas/database_name'
path_table:
name: table
in: path
description: Table Name
required: true
schema:
$ref: '#/components/schemas/table_name'
path_column:
name: column
in: path
description: Column Name
required: true
schema:
$ref: '#/components/schemas/column_name'
path_index:
name: index
in: path
description: Index Name
required: true
schema:
$ref: '#/components/schemas/index_name'
path_row_id:
name: row_id
in: path
description: Row Id
required: true
schema:
$ref: '#/components/schemas/row_id'
schemas:
response_bad_request:
type: object
description: Bad request. The message will vary depending on the cause.
properties:
code:
type: string
description: invalid_request
message:
type: string
description: Invalid request. The message will vary depending on the cause.
example:
code: invalid_request
message: >-
Invalid `fields` parameter. See
https://developer.aircampi.com/api/query-fields
response_unauthorized:
type: object
description: Unauthorized. The message will vary depending on the cause.
discriminator:
propertyName: code
mapping:
invalid_token: '#/components/schemas/response_invalid_token'
invalid_client: '#/components/schemas/response_invalid_client'
properties:
code:
type: string
description: Unauthorized. The code will vary depending on the cause.
message:
type: string
description: Unauthorized. The message will vary depending on the cause.
response_invalid_token:
type: object
description: Invalid token. The message will vary depending on the cause.
properties:
code:
type: string
message:
type: string
description: Invalid token. The message will vary depending on the cause.
example:
code: invalid_token
message: Invalid token. See https://developer.aircampi.com/api/
response_invalid_client:
type: object
description: Invalid client. The message will vary depending on the cause.
properties:
code:
type: string
message:
type: string
description: Invalid client. The message will vary depending on the cause.
example:
- code: invalid_client
message: Client not global. See https://developer.aircampi.com/api/
- code: invalid_client
message: >-
Client cannot perform the requested operation. See
https://developer.aircampi.com/api/
response_forbidden:
type: object
description: Forbidden. The code and message will vary depending on the cause.
discriminator:
propertyName: code
mapping:
unsufficient_scope: '#/components/schemas/response_unsufficient_scope'
account_not_allowed: '#/components/schemas/response_account_not_allowed'
object_limit_reached: '#/components/schemas/response_object_limit_reached'
properties:
code:
type: string
description: forbidden. The code will vary depending on the cause.
message:
type: string
description: Forbidden. The message will vary depending on the cause.
example:
- code: forbidden
message: You reached the limit of entities of this type for this tenant.
response_unsufficient_scope:
type: object
description: Insufficient scope.
properties:
code:
type: string
message:
type: string
description: Insufficient scope. See https://developer.aircampi.com/api/
example:
code: unsufficient_scope
message: Insufficient scope. See https://developer.aircampi.com/api/
response_account_not_allowed:
type: object
description: Account not allowed.
properties:
code:
type: string
message:
type: string
description: The account is not allowed to perform this operation.
example:
code: account_not_allowed
message: The account is not allowed to perform this operation.
response_object_limit_reached:
type: object
description: Object limit reached.
properties:
code:
type: string
message:
type: string
description: You reached the limit of entities of this type for this tenant.
example:
code: object_limit_reached
message: You reached the limit of entities of this type for this tenant.
response_not_found:
type: object
description: Not found. The message will vary depending on the cause.
properties:
code:
type: string
description: not_found
message:
type: string
description: Not found. The message will vary depending on the cause.
example:
code: not_found
message: Resource not found. See https://developer.aircampi.com/api/
response_method_not_allowed:
type: object
description: Method not allowed. The message will vary depending on the cause.
properties:
code:
type: string
description: method_not_allowed
message:
type: string
description: Method not allowed. The message will vary depending on the cause.
example:
code: method_not_allowed
message: Method not allowed. See https://developer.aircampi.com/api/
response_conflict:
type: object
description: Conflict. The message will vary depending on the cause.
properties:
code:
type: string
description: conflict
message:
type: string
description: Conflict. The message will vary depending on the cause.
example:
code: conflict
message: User already exists. See https://developer.aircampi.com/api/
response_too_many_request:
type: object
description: Too many requests. The message will vary depending on the cause.
properties:
code:
type: string
description: too_many_requests
message:
type: string
description: >-
Too many requests. Check the X-RateLimit-Limit,
X-RateLimit-Remaining and X-RateLimit-Reset headers. See
https://developer.aircampi.com/api/rate-limiting
example:
code: too_many_requests
message: >-
Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining
and X-RateLimit-Reset headers. See
https://developer.aircampi.com/api/rate-limiting
response_internal_server_error:
type: object
description: Internal server error. The message will vary depending on the cause.
properties:
code:
type: string
description: internal_server_error
message:
type: string
description: Internal server error. The message will vary depending on the cause.
example:
code: internal_server_error
message: >-
Server cannot be connected to identity provider facebook. See
https://developer.aircampi.com/api/
response_not_implemented:
type: object
description: Not implemented. The code and message will vary depending on the cause.
properties:
code:
type: string
description: not_implemented
message:
type: string
description: Not implemented. The message will vary depending on the cause.
example:
code: not_implemented
message: Unsupported response type. See https://developer.aircampi.com/api/
response_service_unavailable:
type: object
description: >-
Service unavailable. The code and message will vary depending on the
cause.
properties:
code:
type: string
description: service_unavailable
message:
type: string
description: Service unavailable. The message will vary depending on the cause.
example:
code: service_unavailable
message: >-
Service temporarily unavailable. See
https://developer.aircampi.com/api/
response_unexpected_error:
type: object
description: Unexpected Error. The message will vary depending on the cause.
properties:
code:
type: string
description: unexpected_error
message:
type: string
description: Unexpected Error. The message will vary depending on the cause.
example:
code: unexpected_error
message: Unexpected Error. See https://developer.aircampi.com/api/
id:
type: string
description: Unique Identifier (ID)
format: uuid
created_at:
type: string
description: Create at date and time
format: date-time
updated_at:
type: string
description: Updated at date and time
format: date-time
key_value_pair:
type: object
description: key value pair structure
properties:
key:
description: Key
type: string
minLength: 1
example: language
value:
type: object
description: Value
example: Mongolian
app_metadata:
type: array
description: application metadata structure for customize your needs.
items:
$ref: '#/components/schemas/key_value_pair'
locale:
type: string
description: Supported Locales
default: en_US
enum:
- en_US
- en_UK
- mn_MN
timezone:
type: string
description: Time zone. For example, Europe/Paris or America/Los_Angeles.
enum:
- America/Los_Angeles
- Europe/Paris
bearer_authorization:
type: string
description: Access Token
default: Bearer {{access_token}}
basic_authorization:
type: string
description: Client Identifier and Secret encoded by base64.
default: Basic {{base64_encoded}}
health:
type: object
description: Server Status
properties:
server_name:
type: string
description: Name of server
example: Aircampi Database
server_version:
type: string
description: Version of server
example: 0.1.0
server_status:
type: string
description: Status of server
enum:
- Active
- Warning
- Error
default: Active
server_description:
type: string
description: Description of server
example: Data Store
settings:
type: object
description: Settings
properties:
environment:
type: string
description: Environment
default: development
enum:
- development
- staging
- production
user_id:
type: string
description: User Id
format: uuid
database_id:
type: string
format: uuid
description: Database Unique Identifier (ID)
database_name:
type: string
description: Database Name
example: public
database_metadata:
type: object
description: Database Metadata
database:
type: object
description: Database
properties:
id:
$ref: '#/components/schemas/database_id'
name:
$ref: '#/components/schemas/database_name'
description:
type: string
description: Database Description
example: Public is a default database
metadata:
$ref: '#/components/schemas/database_metadata'
created_by:
$ref: '#/components/schemas/user_id'
created_at:
$ref: '#/components/schemas/created_at'
updated_by:
$ref: '#/components/schemas/user_id'
updated_at:
$ref: '#/components/schemas/updated_at'
database_expanded:
type: object
description: Database's data and child items
properties:
id:
$ref: '#/components/schemas/database_id'
name:
$ref: '#/components/schemas/database_name'
description:
type: string
description: Database Description
example: Public is a default database
metadata:
$ref: '#/components/schemas/database_metadata'
created_by:
$ref: '#/components/schemas/user_id'
created_at:
$ref: '#/components/schemas/created_at'
updated_by:
$ref: '#/components/schemas/user_id'
updated_at:
$ref: '#/components/schemas/updated_at'
aggregations:
$ref: '#/components/schemas/database_aggregation'
tables:
type: array
items:
$ref: '#/components/schemas/table'
database_aggregation:
type: object
description: Database Aggregation
properties:
id:
$ref: '#/components/schemas/id'
database_id:
$ref: '#/components/schemas/database_id'
tables:
type: integer
description: Number of Tables
default: 0
columns:
type: integer
description: Number of Columns
default: 0
rows:
type: integer
description: Number of Rows
default: 0
indexes:
type: integer
description: Number of Indexes
default: 0
created_by:
$ref: '#/components/schemas/user_id'
created_at:
$ref: '#/components/schemas/created_at'
updated_by:
$ref: '#/components/schemas/user_id'
updated_at:
$ref: '#/components/schemas/updated_at'
databases:
type: object
description: Databases
properties:
total_count:
type: integer
description: >-
The total number of search records that match the query If you send
request with query parameter ?total_count=true only. Otherwise the
total_count is not included.
title: Total Count
count:
type: integer
description: The number of items returned in the current range.
title: Count
has_more:
type: boolean
description: >-
Indicates whether more resources are available on the server than
the subset returned in the response. If the value is true, then
there are more resources to retrieve from the server. The default
value is false.
title: HasMore
limit:
type: integer
description: The actual paging size used by the server.
title: Limit
offset:
type: integer
description: The offset value used in the current page.
title: Offset
default: 10
items:
type: array
description: The clients in the collection.
items:
$ref: '#/components/schemas/database_expanded'
database_create:
type: object
description: Create Database
required:
- name
properties:
name:
$ref: '#/components/schemas/database_name'
description:
type: string
description: Database Description
example: Public is a default database
metadata:
$ref: '#/components/schemas/database_metadata'
database_update:
type: object
description: Update Database
properties:
name:
$ref: '#/components/schemas/database_name'
description:
type: string
description: Database Description
example: Public is a default database
metadata:
$ref: '#/components/schemas/database_metadata'
database_rename:
type: object
description: Rename Database
properties:
new_name:
$ref: '#/components/schemas/database_name'
example:
new_name: renamed_database
table_id:
type: string
format: uuid
description: Table Unique Identifier (ID)
table_name:
type: string
description: Table Name
example: users
table_metadata:
type: object
description: Table Metadata
properties:
enabled:
type: boolean
description: is table enabled?
default: true
table:
type: object
description: Table
properties:
id:
$ref: '#/components/schemas/table_id'
database_id:
$ref: '#/components/schemas/database_id'
name:
$ref: '#/components/schemas/table_name'
description:
type: string
description: Description of Resource
metadata:
$ref: '#/components/schemas/table_metadata'
created_date:
$ref: '#/components/schemas/created_at'
updated_date:
$ref: '#/components/schemas/updated_at'
table_expanded:
type: object
description: Table's data and child items
properties:
id:
$ref: '#/components/schemas/table_id'
database_id:
$ref: '#/components/schemas/database_id'
name:
$ref: '#/components/schemas/table_name'
description:
type: string
description: Table Description
metadata:
$ref: '#/components/schemas/table_metadata'
created_date:
$ref: '#/components/schemas/created_at'
updated_date:
$ref: '#/components/schemas/updated_at'
aggregations:
$ref: '#/components/schemas/table_aggregation'
columns:
type: array
items:
$ref: '#/components/schemas/column'
rows:
type: array
items:
$ref: '#/components/schemas/row'
indexes:
type: array
items:
$ref: '#/components/schemas/index'
table_aggregation:
type: object
description: Table Aggregation
properties:
id:
$ref: '#/components/schemas/table_id'
table_id:
$ref: '#/components/schemas/table_id'
columns:
type: integer
description: Number of Columns
default: 0
rows:
type: integer
description: Number of Rows
default: 0
indexes:
type: integer
description: Number of Indexes
default: 0
created_by:
$ref: '#/components/schemas/user_id'
created_at:
$ref: '#/components/schemas/created_at'
updated_by:
$ref: '#/components/schemas/user_id'
updated_at:
$ref: '#/components/schemas/updated_at'
tables:
type: object
description: Tables
properties:
total_count:
type: integer
description: >-
The total number of search records that match the query If you send
request with query parameter ?total_count=true only. Otherwise the
total_count is not included.
title: Total Count
count:
type: integer
description: The number of items returned in the current range.
title: Count
has_more:
type: boolean
description: >-
Indicates whether more resources are available on the server than
the subset returned in the response. If the value is true, then
there are more resources to retrieve from the server. The default
value is false.
title: HasMore
limit:
type: integer
description: The actual paging size used by the server.
title: Limit
offset:
type: integer
description: The offset value used in the current page.
title: Offset
default: 10
items:
type: array
description: The resources in the collection.
items:
$ref: '#/components/schemas/table_expanded'
table_create:
type: object
description: Create Table
required:
- name
properties:
name:
$ref: '#/components/schemas/table_name'
description:
type: string
description: Table Description
example: All users
metadata:
$ref: '#/components/schemas/table_metadata'
table_update:
type: object
description: Update Table
properties:
description:
type: string
description: Table Description
example: All users
metadata:
$ref: '#/components/schemas/table_metadata'
table_rename:
type: object
description: Rename Table
properties:
new_name:
$ref: '#/components/schemas/table_name'
example:
new_name: renamed_table
column_id:
type: string
format: uuid
description: Column Unique Identifier (ID)
column_name:
type: string
description: Column Name
example: id
column_type:
type: string
description: Column Type
example: string
enum:
- string
- number
- boolean
- date
- datetime
- reference
- geopoint
- array
- object
- file
column_description:
type: string
description: Column Description
example: Unique Identifier (ID)
column_metadata:
type: object
description: Column Metadata
properties:
required:
type: boolean
description: is required column?
default: false
enabled:
type: boolean
description: is column enabled?
default: true
column:
type: object
description: Table Column
properties:
id:
$ref: '#/components/schemas/column_id'
name:
$ref: '#/components/schemas/column_name'
type:
$ref: '#/components/schemas/column_type'
description:
$ref: '#/components/schemas/column_description'
metadata:
$ref: '#/components/schemas/column_metadata'
builtin:
type: boolean
description: Built-In Column
default: false
example: true
created_by:
$ref: '#/components/schemas/user_id'
created_at:
$ref: '#/components/schemas/created_at'
updated_by:
$ref: '#/components/schemas/user_id'
updated_at:
$ref: '#/components/schemas/updated_at'
columns:
type: object
description: Columns
properties:
total_count:
type: integer
description: >-
The total number of search records that match the query If you send
request with query parameter ?total_count=true only. Otherwise the
total_count is not included.
title: Total Count
count:
type: integer
description: The number of items returned in the current range.
title: Count
has_more:
type: boolean
description: >-
Indicates whether more resources are available on the server than
the subset returned in the response. If the value is true, then
there are more resources to retrieve from the server. The default
value is false.
title: HasMore
limit:
type: integer
description: The actual paging size used by the server.
title: Limit
offset:
type: integer
description: The offset value used in the current page.
title: Offset
default: 10
items:
type: array
description: The table's columns in the collection.
items:
$ref: '#/components/schemas/column'
column_create:
type: object
description: Create Column
required:
- name
- type
properties:
name:
$ref: '#/components/schemas/column_name'
type:
$ref: '#/components/schemas/column_type'
description:
$ref: '#/components/schemas/column_description'
metadata:
$ref: '#/components/schemas/column_metadata'
column_update:
type: object
description: Update Column
properties:
description:
$ref: '#/components/schemas/column_description'
metadata:
$ref: '#/components/schemas/column_metadata'
column_rename:
type: object
description: Rename Column
properties:
new_name:
$ref: '#/components/schemas/column_name'
example:
new_name: renamed_column
row_id:
type: string
description: >-
Row Unique Identifier (ID). It is builtin. System will automatically
generate new uuid when new row inserted. It's never updated.
format: uuid
row_created_at:
type: string
description: >-
Create at date and time. It is builtin. System will automatically set
current date and time when new row inserted. It's never updated.
format: date-time
row_updated_at:
type: string
description: >-
Updated at date and time. It is builtin. System will automatically set
current date and time when new row inserted. It will be updated
automatically when row is updated.
format: date-time
row:
type: object
description: Table Row
properties:
id:
$ref: '#/components/schemas/row_id'
created_at:
$ref: '#/components/schemas/row_created_at'
updated_at:
$ref: '#/components/schemas/row_updated_at'
user_name:
type: string
description: '`string` custom column created by user'
example: Bayaraa Joe
user_age:
type: number
description: '`number` custom column created by user'
example: 13
is_admin:
type: boolean
description: '`boolean` custom column created by user'
example: true
date_of_birth:
type: string
format: date
description: '`date` custom column created by user'
example: '2019-08-24'
last_login_at:
type: string
format: date-time
description: '`datetime` custom column created by user'
example: '2019-08-24T14:15:22Z'
interests:
type: array
description: '`array` custom column created by user'
items:
type: string
example:
- basketball
- fishing
- hiking
user_settings:
type: object
description: '`object` custom column created by user'
properties:
language:
type: string
description: Display Language
example: Mongolian
theme:
type: string
description: Theme
example: Dark
rows:
type: object
description: Table Rows
properties:
total_count:
type: integer
description: >-
The total number of search records that match the query If you send
request with query parameter ?total_count=true only. Otherwise the
total_count is not included.
title: Total Count
count:
type: integer
description: The number of items returned in the current range.
title: Count
has_more:
type: boolean
description: >-
Indicates whether more resources are available on the server than
the subset returned in the response. If the value is true, then
there are more resources to retrieve from the server. The default
value is false.
title: HasMore
limit:
type: integer
description: The actual paging size used by the server.
title: Limit
offset:
type: integer
description: The offset value used in the current page.
title: Offset
default: 10
items:
type: array
description: The table's rows in the collection.
items:
$ref: '#/components/schemas/row'
row_create:
type: object
description: Create Row
properties:
user_name:
type: string
description: '`string` custom column created by user'
example: Bayaraa Joe
user_age:
type: number
description: '`number` custom column created by user'
example: 13
is_admin:
type: boolean
description: '`boolean` custom column created by user'
example: true
date_of_birth:
type: string
format: date
description: '`date` custom column created by user'
example: '2019-08-24'
last_login_at:
type: string
format: date-time
description: '`datetime` custom column created by user'
example: '2019-08-24T14:15:22Z'
interests:
type: array
description: '`array` custom column created by user'
items:
type: string
example:
- basketball
- fishing
- hiking
user_settings:
type: object
description: '`object` custom column created by user'
properties:
language:
type: string
description: Display Language
example: Mongolian
theme:
type: string
description: Theme
example: Dark
row_update:
type: object
description: Update Row
properties:
user_name:
type: string
description: '`string` custom column created by user'
example: Bayaraa Joe
user_age:
type: number
description: '`number` custom column created by user'
example: 13
is_admin:
type: boolean
description: '`boolean` custom column created by user'
example: true
date_of_birth:
type: string
format: date
description: '`date` custom column created by user'
example: '2019-08-24'
last_login_at:
type: string
format: date-time
description: '`datetime` custom column created by user'
example: '2019-08-24T14:15:22Z'
interests:
type: array
description: '`array` custom column created by user'
items:
type: string
example:
- basketball
- fishing
- hiking
user_settings:
type: object
description: '`object` custom column created by user'
properties:
language:
type: string
description: Display Language
example: Mongolian
theme:
type: string
description: Theme
example: Dark
index_id:
type: string
format: uuid
description: Index Unique Identifier (ID)
index_name:
type: string
description: Index Name
example: secondary_index
index_type:
type: string
description: Index Type
example: key
enum:
- key
- unique
- fulltext
index_description:
type: string
description: Index Description
example: PK index for id column
index_metadata:
type: object
description: Index Metadata
properties:
columns:
type: array
description: Indexed Columns
items:
$ref: '#/components/schemas/column_name'
index:
type: object
description: Index
properties:
id:
$ref: '#/components/schemas/index_id'
name:
$ref: '#/components/schemas/index_name'
type:
$ref: '#/components/schemas/index_type'
description:
$ref: '#/components/schemas/index_description'
metadata:
$ref: '#/components/schemas/index_metadata'
builtin:
type: boolean
description: Built-in Index
default: false
example: true
created_date:
$ref: '#/components/schemas/created_at'
updated_date:
$ref: '#/components/schemas/updated_at'
indexes:
type: object
description: Indexes
properties:
total_count:
type: integer
description: >-
The total number of search records that match the query If you send
request with query parameter ?total_count=true only. Otherwise the
total_count is not included.
title: Total Count
count:
type: integer
description: The number of items returned in the current range.
title: Count
has_more:
type: boolean
description: >-
Indicates whether more resources are available on the server than
the subset returned in the response. If the value is true, then
there are more resources to retrieve from the server. The default
value is false.
title: HasMore
limit:
type: integer
description: The actual paging size used by the server.
title: Limit
offset:
type: integer
description: The offset value used in the current page.
title: Offset
default: 10
items:
type: array
description: The indexes in the collection.
items:
$ref: '#/components/schemas/index'
index_create:
type: object
description: Create Index
required:
- name
- type
properties:
name:
$ref: '#/components/schemas/index_name'
type:
$ref: '#/components/schemas/index_type'
description:
$ref: '#/components/schemas/index_description'
metadata:
$ref: '#/components/schemas/index_metadata'
index_update:
type: object
description: Update Index
properties:
description:
$ref: '#/components/schemas/index_description'
metadata:
$ref: '#/components/schemas/index_metadata'
index_rename:
type: object
description: Rename Index
properties:
new_name:
$ref: '#/components/schemas/index_name'
example:
new_name: renamed_index
requestBodies:
server_settings_update:
description: Update Settings
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/settings'
database_create:
description: Create Database
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/database_create'
database_update:
description: Update Database
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/database_update'
database_rename:
description: Rename Database
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/database_rename'
table_create:
description: Create Table
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_create'
table_update:
description: Update Table
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_update'
table_rename:
description: Rename Table
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_rename'
column_create:
description: Create Column
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/column_create'
column_update:
description: Update Column
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/column_update'
column_rename:
description: Rename Column
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/column_rename'
row_create:
description: Create Row
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/row_create'
row_update:
description: Update Row
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/row_update'
index_create:
description: Create Index
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/index_create'
index_update:
description: Update Index
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/index_update'
index_rename:
description: Rename Index
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/index_rename'
securitySchemes:
basic_auth:
description: Basic Authentication
type: http
scheme: basic
bearer_auth:
description: Bearer Authentication
type: http
scheme: bearer
bearerFormat: JWT
api_key:
type: apiKey
description: >
For this sample, you can use the api key `special-key` to test the
authorization filters.
in: header
name: X-API-KEY
Scopes:
description: |
Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.
[See more](https://developer.aircampi.com/docs/database)
type: oauth2
flows:
implicit:
authorizationUrl: /authorize
scopes: {}
open_id_connect:
type: openIdConnect
openIdConnectUrl: >-
https://{subdomain}.aircampi.com/database/{version}/.well-known/openid-configuration
cookie_auth:
type: apiKey
in: cookie
name: JSESSIONID
examples:
user_examples_user_signup_email:
summary: Request example for create user.
value:
email: bayaraa@email.com