Skip to content

Commit 9588022

Browse files
committed
fix(ent3): Update Ent3 API reference request trigger_specification syntax to string request:<REQUEST_PATH>
1 parent 3d1ef2b commit 9588022

File tree

1 file changed

+193
-15
lines changed
  • api-docs/influxdb3/enterprise/v3

1 file changed

+193
-15
lines changed

api-docs/influxdb3/enterprise/v3/ref.yml

Lines changed: 193 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -922,9 +922,25 @@ paths:
922922
summary: Delete a database
923923
description: |
924924
Soft deletes a database.
925-
The database is scheduled for deletion and unavailable for querying.
925+
The database is scheduled for deletion and unavailable for querying.
926+
Use the `hard_delete_at` parameter to schedule a hard deletion.
926927
parameters:
927928
- $ref: '#/components/parameters/db'
929+
- name: hard_delete_at
930+
in: query
931+
required: false
932+
schema:
933+
type: string
934+
format: date-time
935+
description: |
936+
Schedule the database for hard deletion at the specified time.
937+
If not provided, the database will be soft deleted.
938+
Use ISO 8601 date-time format (for example, "2025-12-31T23:59:59Z").
939+
940+
#### Deleting a database cannot be undone
941+
942+
Deleting a database is a destructive action.
943+
Once a database is deleted, data stored in that database cannot be recovered.
928944
responses:
929945
'200':
930946
description: Success. Database deleted.
@@ -961,14 +977,30 @@ paths:
961977
summary: Delete a table
962978
description: |
963979
Soft deletes a table.
964-
The table is scheduled for deletion and unavailable for querying.
980+
The table is scheduled for deletion and unavailable for querying.
981+
Use the `hard_delete_at` parameter to schedule a hard deletion.
982+
983+
#### Deleting a table cannot be undone
984+
985+
Deleting a table is a destructive action.
986+
Once a table is deleted, data stored in that table cannot be recovered.
965987
parameters:
966988
- $ref: '#/components/parameters/db'
967989
- name: table
968990
in: query
969991
required: true
970992
schema:
971993
type: string
994+
- name: hard_delete_at
995+
in: query
996+
required: false
997+
schema:
998+
type: string
999+
format: date-time
1000+
description: |
1001+
Schedule the table for hard deletion at the specified time.
1002+
If not provided, the table will be soft deleted.
1003+
Use ISO 8601 format (for example, "2025-12-31T23:59:59Z").
9721004
responses:
9731005
'200':
9741006
description: Success (no content). The table has been deleted.
@@ -978,6 +1010,77 @@ paths:
9781010
description: Table not found.
9791011
tags:
9801012
- Table
1013+
patch:
1014+
operationId: PatchConfigureTable
1015+
summary: Update a table
1016+
description: |
1017+
Updates table configuration, such as retention period.
1018+
requestBody:
1019+
required: true
1020+
content:
1021+
application/json:
1022+
schema:
1023+
$ref: '#/components/schemas/UpdateTableRequest'
1024+
responses:
1025+
'200':
1026+
description: Success. The table has been updated.
1027+
'400':
1028+
description: Bad request.
1029+
'401':
1030+
$ref: '#/components/responses/Unauthorized'
1031+
'404':
1032+
description: Table not found.
1033+
tags:
1034+
- Table
1035+
/api/v3/configure/database/{db}:
1036+
patch:
1037+
operationId: PatchConfigureDatabase
1038+
summary: Update a database
1039+
description: |
1040+
Updates database configuration, such as retention period.
1041+
parameters:
1042+
- name: db
1043+
in: path
1044+
required: true
1045+
schema:
1046+
type: string
1047+
description: The name of the database to update.
1048+
requestBody:
1049+
required: true
1050+
content:
1051+
application/json:
1052+
schema:
1053+
$ref: '#/components/schemas/UpdateDatabaseRequest'
1054+
responses:
1055+
'200':
1056+
description: Success. The database has been updated.
1057+
'400':
1058+
description: Bad request.
1059+
'401':
1060+
$ref: '#/components/responses/Unauthorized'
1061+
'404':
1062+
description: Database not found.
1063+
tags:
1064+
- Database
1065+
/api/v3/show/license:
1066+
get:
1067+
operationId: GetShowLicense
1068+
summary: Show license information
1069+
description: |
1070+
Retrieves information about the current InfluxDB 3 Enterprise license.
1071+
responses:
1072+
'200':
1073+
description: Success. The response body contains license information.
1074+
content:
1075+
application/json:
1076+
schema:
1077+
$ref: '#/components/schemas/LicenseResponse'
1078+
'401':
1079+
$ref: '#/components/responses/Unauthorized'
1080+
'403':
1081+
description: Access denied.
1082+
tags:
1083+
- Server information
9811084
/api/v3/configure/distinct_cache:
9821085
post:
9831086
operationId: PostConfigureDistinctCache
@@ -1136,7 +1239,7 @@ paths:
11361239
db: mydb
11371240
plugin_filename: request.py
11381241
trigger_name: hello_world_trigger
1139-
trigger_specification: path:hello-world
1242+
trigger_specification: "request:hello-world"
11401243
cron_friday_afternoon:
11411244
summary: Cron trigger for Friday afternoons
11421245
description: |
@@ -1365,16 +1468,16 @@ paths:
13651468
description: Plugin not enabled.
13661469
tags:
13671470
- Processing engine
1368-
/api/v3/engine/{plugin_path}:
1471+
/api/v3/engine/{request_path}:
13691472
parameters:
1370-
- name: plugin_path
1473+
- name: request_path
13711474
description: |
1372-
The path configured in the request trigger specification "path:<plugin_path>"` for the plugin.
1475+
The path configured in the request trigger specification "request:<request_path>"` for the plugin.
13731476
13741477
For example, if you define a trigger with the following:
13751478
13761479
```json
1377-
trigger-spec: "path:hello-world"
1480+
trigger_specification: "request:hello-world"
13781481
```
13791482
13801483
then, the HTTP API exposes the following plugin endpoint:
@@ -1390,7 +1493,7 @@ paths:
13901493
operationId: GetProcessingEnginePluginRequest
13911494
summary: On Request processing engine plugin request
13921495
description: |
1393-
Executes the On Request processing engine plugin specified in `<plugin_path>`.
1496+
Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`.
13941497
The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin.
13951498
13961499
An On Request plugin implements the following signature:
@@ -1417,7 +1520,7 @@ paths:
14171520
operationId: PostProcessingEnginePluginRequest
14181521
summary: On Request processing engine plugin request
14191522
description: |
1420-
Executes the On Request processing engine plugin specified in `<plugin_path>`.
1523+
Executes the On Request processing engine plugin specified in the trigger's `plugin_filename`.
14211524
The request can include request headers, query string parameters, and a request body, which InfluxDB passes to the plugin.
14221525
14231526
An On Request plugin implements the following signature:
@@ -1812,6 +1915,16 @@ components:
18121915
properties:
18131916
db:
18141917
type: string
1918+
pattern: '^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$|^[a-zA-Z0-9]$'
1919+
description: |-
1920+
The database name. Database names cannot contain underscores (_).
1921+
Names must start and end with alphanumeric characters and can contain hyphens (-) in the middle.
1922+
retention_period:
1923+
type: string
1924+
description: |-
1925+
The retention period for the database. Specifies how long data should be retained.
1926+
Use duration format (for example, "1d", "1h", "30m", "7d").
1927+
example: "7d"
18151928
required:
18161929
- db
18171930
CreateTableRequest:
@@ -1843,6 +1956,12 @@ components:
18431956
required:
18441957
- name
18451958
- type
1959+
retention_period:
1960+
type: string
1961+
description: |-
1962+
The retention period for the table. Specifies how long data in this table should be retained.
1963+
Use duration format (for example, "1d", "1h", "30m", "7d").
1964+
example: "30d"
18461965
required:
18471966
- db
18481967
- table
@@ -1929,7 +2048,7 @@ components:
19292048
`schedule.py` or `endpoints/report.py`.
19302049
The path can be absolute or relative to the `--plugins-dir` directory configured when starting InfluxDB 3.
19312050
1932-
The plugin file must implement the trigger interface associated with the trigger's specification (`trigger_spec`).
2051+
The plugin file must implement the trigger interface associated with the trigger's specification.
19332052
trigger_name:
19342053
type: string
19352054
trigger_specification:
@@ -1972,12 +2091,12 @@ components:
19722091
- `table:TABLE_NAME` - Triggers on write events to a specific table
19732092
19742093
### On-demand triggers
1975-
Format: `path:ENDPOINT_NAME`
2094+
Format: `request:REQUEST_PATH`
19762095
1977-
Creates an HTTP endpoint `/api/v3/engine/ENDPOINT_NAME` for manual invocation:
1978-
- `path:hello-world` - Creates endpoint `/api/v3/engine/hello-world`
1979-
- `path:data-export` - Creates endpoint `/api/v3/engine/data-export`
1980-
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|path:[a-zA-Z0-9_-]+)$
2096+
Creates an HTTP endpoint `/api/v3/engine/REQUEST_PATH` for manual invocation:
2097+
- `request:hello-world` - Creates endpoint `/api/v3/engine/hello-world`
2098+
- `request:data-export` - Creates endpoint `/api/v3/engine/data-export`
2099+
pattern: ^(cron:[0-9 *,/-]+|every:[0-9]+[smhd]|all_tables|table:[a-zA-Z_][a-zA-Z0-9_]*|request:[a-zA-Z0-9_-]+)$
19812100
example: cron:0 0 6 * * 1-5
19822101
trigger_arguments:
19832102
type: object
@@ -2074,6 +2193,65 @@ components:
20742193
- m
20752194
- h
20762195
type: string
2196+
UpdateDatabaseRequest:
2197+
type: object
2198+
properties:
2199+
retention_period:
2200+
type: string
2201+
description: |
2202+
The retention period for the database. Specifies how long data should be retained.
2203+
Use duration format (for example, "1d", "1h", "30m", "7d").
2204+
example: "7d"
2205+
description: Request schema for updating database configuration.
2206+
UpdateTableRequest:
2207+
type: object
2208+
properties:
2209+
db:
2210+
type: string
2211+
description: The name of the database containing the table.
2212+
table:
2213+
type: string
2214+
description: The name of the table to update.
2215+
retention_period:
2216+
type: string
2217+
description: |
2218+
The retention period for the table. Specifies how long data in this table should be retained.
2219+
Use duration format (for example, "1d", "1h", "30m", "7d").
2220+
example: "30d"
2221+
required:
2222+
- db
2223+
- table
2224+
description: Request schema for updating table configuration.
2225+
LicenseResponse:
2226+
type: object
2227+
properties:
2228+
license_type:
2229+
type: string
2230+
description: The type of license (for example, "enterprise", "trial").
2231+
example: "enterprise"
2232+
expires_at:
2233+
type: string
2234+
format: date-time
2235+
description: The expiration date of the license in ISO 8601 format.
2236+
example: "2025-12-31T23:59:59Z"
2237+
features:
2238+
type: array
2239+
items:
2240+
type: string
2241+
description: List of features enabled by the license.
2242+
example:
2243+
- "clustering"
2244+
- "processing_engine"
2245+
- "advanced_auth"
2246+
status:
2247+
type: string
2248+
enum:
2249+
- "active"
2250+
- "expired"
2251+
- "invalid"
2252+
description: The current status of the license.
2253+
example: "active"
2254+
description: Response schema for license information.
20772255
responses:
20782256
Unauthorized:
20792257
description: Unauthorized access.

0 commit comments

Comments
 (0)