feat(api): Add compatibility version badges for v1/v2 endpoints
Add visual badges to distinguish v1-compatible and v2-compatible API endpoints in the sidebar navigation. This helps users migrating from InfluxDB v1 or v2 quickly identify which compatibility layer each endpoint belongs to. Changes: - Add x-compatibility-version extension to compatibility operations - Add externalDocs links to reduce verbose descriptions in specs - Update generator to extract compatVersion and externalDocs fields - Display colored badges (purple for v1, cyan for v2) in sidebar nav - Strip redundant "(v1-compatible)" text when badge is shown - Add hover tooltips explaining compatibility contextworktree-2025-12-30T19-16-55
Jason Stirnaman
parent
918f7ffeef
commit
da990a3252
|
|
@ -230,17 +230,13 @@ paths:
|
|||
post:
|
||||
operationId: PostV1Write
|
||||
summary: Write line protocol (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: |
|
||||
Writes line protocol to the specified database.
|
||||
|
||||
This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools.
|
||||
|
||||
Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
Use query parameters to specify options for writing data.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/)
|
||||
Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/dbWriteParam'
|
||||
- $ref: '#/components/parameters/compatibilityPrecisionParam'
|
||||
|
|
@ -353,17 +349,13 @@ paths:
|
|||
post:
|
||||
operationId: PostV2Write
|
||||
summary: Write line protocol (v2-compatible)
|
||||
x-compatibility-version: v2
|
||||
description: |
|
||||
Writes line protocol to the specified database.
|
||||
|
||||
This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools.
|
||||
|
||||
Use this endpoint to send data in [line protocol](/influxdb3/core/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
Use query parameters to specify options for writing data.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use compatibility APIs to write data](/influxdb3/core/write-data/http-api/compatibility-apis/)
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
parameters:
|
||||
- name: Content-Type
|
||||
in: header
|
||||
|
|
@ -736,15 +728,13 @@ paths:
|
|||
get:
|
||||
operationId: GetV1ExecuteQuery
|
||||
summary: Execute InfluxQL query (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: |
|
||||
Executes an InfluxQL query to retrieve data from the specified database.
|
||||
|
||||
This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
Use query parameters to specify the database and the InfluxQL query.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/)
|
||||
Compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
parameters:
|
||||
- name: Accept
|
||||
in: header
|
||||
|
|
@ -869,12 +859,11 @@ paths:
|
|||
post:
|
||||
operationId: PostExecuteV1Query
|
||||
summary: Execute InfluxQL query (v1-compatible)
|
||||
description: |
|
||||
Executes an InfluxQL query to retrieve data from the specified database.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/core/query-data/execute-queries/influxdb-v1-api/)
|
||||
x-compatibility-version: v1
|
||||
description: Executes an InfluxQL query to retrieve data from the specified database.
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -1000,7 +989,8 @@ paths:
|
|||
/api/v1/health:
|
||||
get:
|
||||
operationId: GetHealthV1
|
||||
summary: Health check (v1)
|
||||
summary: Health check (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: Checks the status of the service.
|
||||
responses:
|
||||
'200':
|
||||
|
|
|
|||
|
|
@ -230,17 +230,13 @@ paths:
|
|||
post:
|
||||
operationId: PostV1Write
|
||||
summary: Write line protocol (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: |
|
||||
Writes line protocol to the specified database.
|
||||
|
||||
This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools.
|
||||
|
||||
Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
Use query parameters to specify options for writing data.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/)
|
||||
Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/enterprise/write-data/http-api/compatibility-apis/
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/dbWriteParam'
|
||||
- $ref: '#/components/parameters/compatibilityPrecisionParam'
|
||||
|
|
@ -353,17 +349,13 @@ paths:
|
|||
post:
|
||||
operationId: PostV2Write
|
||||
summary: Write line protocol (v2-compatible)
|
||||
x-compatibility-version: v2
|
||||
description: |
|
||||
Writes line protocol to the specified database.
|
||||
|
||||
This endpoint provides backward compatibility for InfluxDB 2.x write workloads using tools such as InfluxDB 2.x client libraries, the Telegraf `outputs.influxdb_v2` output plugin, or third-party tools.
|
||||
|
||||
Use this endpoint to send data in [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/) format to InfluxDB.
|
||||
Use query parameters to specify options for writing data.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use compatibility APIs to write data](/influxdb3/enterprise/write-data/http-api/compatibility-apis/)
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/enterprise/write-data/http-api/compatibility-apis/
|
||||
parameters:
|
||||
- name: Content-Type
|
||||
in: header
|
||||
|
|
@ -736,15 +728,13 @@ paths:
|
|||
get:
|
||||
operationId: GetV1ExecuteQuery
|
||||
summary: Execute InfluxQL query (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: |
|
||||
Executes an InfluxQL query to retrieve data from the specified database.
|
||||
|
||||
This endpoint is compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
Use query parameters to specify the database and the InfluxQL query.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/)
|
||||
Compatible with InfluxDB 1.x client libraries and third-party integrations such as Grafana.
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/
|
||||
parameters:
|
||||
- name: Accept
|
||||
in: header
|
||||
|
|
@ -869,12 +859,11 @@ paths:
|
|||
post:
|
||||
operationId: PostExecuteV1Query
|
||||
summary: Execute InfluxQL query (v1-compatible)
|
||||
description: |
|
||||
Executes an InfluxQL query to retrieve data from the specified database.
|
||||
|
||||
#### Related
|
||||
|
||||
- [Use the InfluxDB v1 HTTP query API and InfluxQL to query data](/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/)
|
||||
x-compatibility-version: v1
|
||||
description: Executes an InfluxQL query to retrieve data from the specified database.
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -1000,7 +989,8 @@ paths:
|
|||
/api/v1/health:
|
||||
get:
|
||||
operationId: GetHealthV1
|
||||
summary: Health check (v1)
|
||||
summary: Health check (v1-compatible)
|
||||
x-compatibility-version: v1
|
||||
description: Checks the status of the service.
|
||||
responses:
|
||||
'200':
|
||||
|
|
|
|||
|
|
@ -395,14 +395,15 @@ const productConfigs = {
|
|||
// menuKey: 'influxdb_v2',
|
||||
// },
|
||||
// InfluxDB 3 products use tag-based generation for better UX
|
||||
'influxdb3-core': {
|
||||
// Keys use underscores to match Hugo data directory structure
|
||||
influxdb3_core: {
|
||||
specFile: path.join(API_DOCS_ROOT, 'influxdb3/core/v3/ref.yml'),
|
||||
pagesDir: path.join(DOCS_ROOT, 'content/influxdb3/core'),
|
||||
description: 'InfluxDB 3 Core',
|
||||
menuKey: 'influxdb3_core',
|
||||
useTagBasedGeneration: true,
|
||||
},
|
||||
'influxdb3-enterprise': {
|
||||
influxdb3_enterprise: {
|
||||
specFile: path.join(API_DOCS_ROOT, 'influxdb3/enterprise/v3/ref.yml'),
|
||||
pagesDir: path.join(DOCS_ROOT, 'content/influxdb3/enterprise'),
|
||||
description: 'InfluxDB 3 Enterprise',
|
||||
|
|
@ -464,7 +465,7 @@ function processProduct(productKey, config) {
|
|||
const staticPathsPath = path.join(staticPath, `influxdb-${productKey}/paths`);
|
||||
const articlesPath = path.join(
|
||||
DOCS_ROOT,
|
||||
`data/article-data/influxdb/${productKey}`
|
||||
`data/article_data/influxdb/${productKey}`
|
||||
);
|
||||
// Check if spec file exists
|
||||
if (!fs.existsSync(config.specFile)) {
|
||||
|
|
|
|||
|
|
@ -191,6 +191,17 @@ function extractOperationsByTag(openapi) {
|
|||
summary: operation.summary || '',
|
||||
tags: operation.tags || [],
|
||||
};
|
||||
// Extract compatibility version if present
|
||||
if (operation['x-compatibility-version']) {
|
||||
opMeta.compatVersion = operation['x-compatibility-version'];
|
||||
}
|
||||
// Extract externalDocs if present
|
||||
if (operation.externalDocs) {
|
||||
opMeta.externalDocs = {
|
||||
description: operation.externalDocs.description || '',
|
||||
url: operation.externalDocs.url,
|
||||
};
|
||||
}
|
||||
// Add operation to each of its tags
|
||||
(operation.tags || []).forEach((tag) => {
|
||||
if (!tagOperations.has(tag)) {
|
||||
|
|
@ -578,6 +589,8 @@ function createArticleDataForTag(openapi, operations, tagMeta) {
|
|||
path: op.path,
|
||||
summary: op.summary,
|
||||
tags: op.tags,
|
||||
...(op.compatVersion && { compatVersion: op.compatVersion }),
|
||||
...(op.externalDocs && { externalDocs: op.externalDocs }),
|
||||
})),
|
||||
},
|
||||
};
|
||||
|
|
@ -630,13 +643,25 @@ function writeOpenapiTagArticleData(sourcePath, targetPath, openapi, opts) {
|
|||
HTTP_METHODS.forEach((method) => {
|
||||
const operation = pathItem[method];
|
||||
if (operation) {
|
||||
operations.push({
|
||||
const opMeta = {
|
||||
operationId: operation.operationId || `${method}-${pathKey}`,
|
||||
method: method.toUpperCase(),
|
||||
path: pathKey,
|
||||
summary: operation.summary || '',
|
||||
tags: operation.tags || [],
|
||||
});
|
||||
};
|
||||
// Extract compatibility version if present
|
||||
if (operation['x-compatibility-version']) {
|
||||
opMeta.compatVersion = operation['x-compatibility-version'];
|
||||
}
|
||||
// Extract externalDocs if present
|
||||
if (operation.externalDocs) {
|
||||
opMeta.externalDocs = {
|
||||
description: operation.externalDocs.description || '',
|
||||
url: operation.externalDocs.url,
|
||||
};
|
||||
}
|
||||
operations.push(opMeta);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -480,14 +480,15 @@ const productConfigs: ProductConfigMap = {
|
|||
// menuKey: 'influxdb_v2',
|
||||
// },
|
||||
// InfluxDB 3 products use tag-based generation for better UX
|
||||
'influxdb3-core': {
|
||||
// Keys use underscores to match Hugo data directory structure
|
||||
influxdb3_core: {
|
||||
specFile: path.join(API_DOCS_ROOT, 'influxdb3/core/v3/ref.yml'),
|
||||
pagesDir: path.join(DOCS_ROOT, 'content/influxdb3/core'),
|
||||
description: 'InfluxDB 3 Core',
|
||||
menuKey: 'influxdb3_core',
|
||||
useTagBasedGeneration: true,
|
||||
},
|
||||
'influxdb3-enterprise': {
|
||||
influxdb3_enterprise: {
|
||||
specFile: path.join(API_DOCS_ROOT, 'influxdb3/enterprise/v3/ref.yml'),
|
||||
pagesDir: path.join(DOCS_ROOT, 'content/influxdb3/enterprise'),
|
||||
description: 'InfluxDB 3 Enterprise',
|
||||
|
|
@ -550,7 +551,7 @@ function processProduct(productKey: string, config: ProductConfig): void {
|
|||
const staticPathsPath = path.join(staticPath, `influxdb-${productKey}/paths`);
|
||||
const articlesPath = path.join(
|
||||
DOCS_ROOT,
|
||||
`data/article-data/influxdb/${productKey}`
|
||||
`data/article_data/influxdb/${productKey}`
|
||||
);
|
||||
|
||||
// Check if spec file exists
|
||||
|
|
|
|||
|
|
@ -38,6 +38,9 @@ interface Operation {
|
|||
parameters?: Parameter[];
|
||||
requestBody?: RequestBody;
|
||||
responses?: Record<string, Response>;
|
||||
externalDocs?: ExternalDocs;
|
||||
/** Compatibility version for migration context (v1 or v2) */
|
||||
'x-compatibility-version'?: string;
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
|
|
@ -225,6 +228,13 @@ interface OperationMeta {
|
|||
path: string;
|
||||
summary: string;
|
||||
tags: string[];
|
||||
/** Compatibility version (v1 or v2) for migration context */
|
||||
compatVersion?: string;
|
||||
/** External documentation link */
|
||||
externalDocs?: {
|
||||
description: string;
|
||||
url: string;
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -432,6 +442,19 @@ function extractOperationsByTag(
|
|||
tags: operation.tags || [],
|
||||
};
|
||||
|
||||
// Extract compatibility version if present
|
||||
if (operation['x-compatibility-version']) {
|
||||
opMeta.compatVersion = operation['x-compatibility-version'];
|
||||
}
|
||||
|
||||
// Extract externalDocs if present
|
||||
if (operation.externalDocs) {
|
||||
opMeta.externalDocs = {
|
||||
description: operation.externalDocs.description || '',
|
||||
url: operation.externalDocs.url,
|
||||
};
|
||||
}
|
||||
|
||||
// Add operation to each of its tags
|
||||
(operation.tags || []).forEach((tag) => {
|
||||
if (!tagOperations.has(tag)) {
|
||||
|
|
@ -888,6 +911,8 @@ function createArticleDataForTag(
|
|||
path: op.path,
|
||||
summary: op.summary,
|
||||
tags: op.tags,
|
||||
...(op.compatVersion && { compatVersion: op.compatVersion }),
|
||||
...(op.externalDocs && { externalDocs: op.externalDocs }),
|
||||
})),
|
||||
},
|
||||
};
|
||||
|
|
@ -952,13 +977,28 @@ function writeOpenapiTagArticleData(
|
|||
HTTP_METHODS.forEach((method) => {
|
||||
const operation = pathItem[method] as Operation | undefined;
|
||||
if (operation) {
|
||||
operations.push({
|
||||
const opMeta: OperationMeta = {
|
||||
operationId: operation.operationId || `${method}-${pathKey}`,
|
||||
method: method.toUpperCase(),
|
||||
path: pathKey,
|
||||
summary: operation.summary || '',
|
||||
tags: operation.tags || [],
|
||||
});
|
||||
};
|
||||
|
||||
// Extract compatibility version if present
|
||||
if (operation['x-compatibility-version']) {
|
||||
opMeta.compatVersion = operation['x-compatibility-version'];
|
||||
}
|
||||
|
||||
// Extract externalDocs if present
|
||||
if (operation.externalDocs) {
|
||||
opMeta.externalDocs = {
|
||||
description: operation.externalDocs.description || '',
|
||||
url: operation.externalDocs.url,
|
||||
};
|
||||
}
|
||||
|
||||
operations.push(opMeta);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -281,6 +281,23 @@
|
|||
&--patch { background: #50e3c2; color: white; }
|
||||
}
|
||||
|
||||
// Compatibility version badge (v1 or v2)
|
||||
.api-compat-badge {
|
||||
font-size: 0.55rem;
|
||||
font-weight: 600;
|
||||
padding: 0.1rem 0.3rem;
|
||||
border-radius: 3px;
|
||||
text-transform: uppercase;
|
||||
flex-shrink: 0;
|
||||
line-height: 1;
|
||||
margin-left: auto;
|
||||
opacity: 0.8;
|
||||
cursor: help;
|
||||
|
||||
&--v1 { background: #8b5cf6; color: white; } // Purple for v1
|
||||
&--v2 { background: #06b6d4; color: white; } // Cyan for v2
|
||||
}
|
||||
|
||||
// Non-link group labels (for multi-tag groups)
|
||||
.nav-group-label {
|
||||
color: $nav-item;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,791 @@
|
|||
{
|
||||
"articles": [
|
||||
{
|
||||
"path": "api/authentication",
|
||||
"fields": {
|
||||
"name": "Authentication",
|
||||
"describes": [
|
||||
"/api/v3/configure/token/admin",
|
||||
"/api/v3/configure/token/admin/regenerate",
|
||||
"/api/v3/configure/token",
|
||||
"/api/v3/configure/token/named_admin"
|
||||
],
|
||||
"title": "Authentication",
|
||||
"description": "Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API:\n\n| Authentication scheme | Works with |\n|:----------------------|:-----------|\n| Bearer authentication | All endpoints |\n| Token authentication | v1, v2 endpoints |\n| Basic authentication | v1 endpoints |\n| Querystring authentication | v1 endpoints |\n\nSee the **Security Schemes** section below for details on each authentication method.\n",
|
||||
"tag": "Authentication",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostCreateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin",
|
||||
"summary": "Create admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostRegenerateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin/regenerate",
|
||||
"summary": "Regenerate admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteToken",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/token",
|
||||
"summary": "Delete token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateNamedAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/named_admin",
|
||||
"summary": "Create named admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API:\n\n| Authentication scheme | Works with |\n|:----------------------|:-----------|\n| Bearer authentication | All endpoints |\n| Token authentication | v1, v2 endpoints |\n| Basic authentication | v1 endpoints |\n| Querystring authentication | v1 endpoints |\n\nSee the **Security Schemes** section below for details on each authentication method.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-authentication.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-authentication.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/cache-data",
|
||||
"fields": {
|
||||
"name": "Cache data",
|
||||
"describes": [
|
||||
"/api/v3/configure/distinct_cache",
|
||||
"/api/v3/configure/last_cache"
|
||||
],
|
||||
"title": "Cache data",
|
||||
"description": "Manage the in-memory cache.\n\n#### Distinct Value Cache\n\nThe Distinct Value Cache (DVC) lets you cache distinct\nvalues of one or more columns in a table, improving the performance of\nqueries that return distinct tag and field values. \n\nThe DVC is an in-memory cache that stores distinct values for specific columns\nin a table. When you create an DVC, you can specify what columns' distinct\nvalues to cache, the maximum number of distinct value combinations to cache, and\nthe maximum age of cached values. A DVC is associated with a table, which can\nhave multiple DVCs.\n\n#### Last value cache\n\nThe Last Value Cache (LVC) lets you cache the most recent\nvalues for specific fields in a table, improving the performance of queries that\nreturn the most recent value of a field for specific series or the last N values\nof a field.\n\nThe LVC is an in-memory cache that stores the last N number of values for\nspecific fields of series in a table. When you create an LVC, you can specify\nwhat fields to cache, what tags to use to identify each series, and the\nnumber of values to cache for each unique series.\nAn LVC is associated with a table, which can have multiple LVCs.\n\n#### Related guides\n\n- [Manage the Distinct Value Cache](/influxdb3/core/admin/distinct-value-cache/)\n- [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/)\n",
|
||||
"tag": "Cache data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureDistinctCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Create distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDistinctCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Delete distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureLastCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Create last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureLastCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Delete last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage the in-memory cache.\n\n#### Distinct Value Cache\n\nThe Distinct Value Cache (DVC) lets you cache distinct\nvalues of one or more columns in a table, improving the performance of\nqueries that return distinct tag and field values. \n\nThe DVC is an in-memory cache that stores distinct values for specific columns\nin a table. When you create an DVC, you can specify what columns' distinct\nvalues to cache, the maximum number of distinct value combinations to cache, and\nthe maximum age of cached values. A DVC is associated with a table, which can\nhave multiple DVCs.\n\n#### Last value cache\n\nThe Last Value Cache (LVC) lets you cache the most recent\nvalues for specific fields in a table, improving the performance of queries that\nreturn the most recent value of a field for specific series or the last N values\nof a field.\n\nThe LVC is an in-memory cache that stores the last N number of values for\nspecific fields of series in a table. When you create an LVC, you can specify\nwhat fields to cache, what tags to use to identify each series, and the\nnumber of values to cache for each unique series.\nAn LVC is associated with a table, which can have multiple LVCs.\n\n#### Related guides\n\n- [Manage the Distinct Value Cache](/influxdb3/core/admin/distinct-value-cache/)\n- [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/)\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-cache-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-cache-data.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/compatibility-endpoints",
|
||||
"fields": {
|
||||
"name": "Compatibility endpoints",
|
||||
"describes": [
|
||||
"/write",
|
||||
"/api/v2/write",
|
||||
"/query",
|
||||
"/api/v1/health"
|
||||
],
|
||||
"title": "Compatibility endpoints",
|
||||
"description": "InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients.\n\n### Write data using v1- or v2-compatible endpoints\n\n- [`/api/v2/write` endpoint](#operation/PostV2Write)\n for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.\n- [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.\n\nFor new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP).\n\nAll endpoints accept the same line protocol format.\n\n### Query data\n\nUse the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL.\n\nFor new workloads, use one of the following:\n\n- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.\n- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.\n- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).\n\n### Server information\n\nServer information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients.\n",
|
||||
"tag": "Compatibility endpoints",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Compatibility",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostV1Write",
|
||||
"method": "POST",
|
||||
"path": "/write",
|
||||
"summary": "Write line protocol (v1-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/core/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostV2Write",
|
||||
"method": "POST",
|
||||
"path": "/api/v2/write",
|
||||
"summary": "Write line protocol (v2-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v2",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/core/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "GetV1ExecuteQuery",
|
||||
"method": "GET",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/core/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteV1Query",
|
||||
"method": "POST",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/core/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "GetHealthV1",
|
||||
"method": "GET",
|
||||
"path": "/api/v1/health",
|
||||
"summary": "Health check (v1-compatible)",
|
||||
"tags": [
|
||||
"Server information",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1"
|
||||
}
|
||||
],
|
||||
"tagDescription": "InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients.\n\n### Write data using v1- or v2-compatible endpoints\n\n- [`/api/v2/write` endpoint](#operation/PostV2Write)\n for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.\n- [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.\n\nFor new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP).\n\nAll endpoints accept the same line protocol format.\n\n### Query data\n\nUse the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL.\n\nFor new workloads, use one of the following:\n\n- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.\n- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.\n- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).\n\n### Server information\n\nServer information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-compatibility-endpoints.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-compatibility-endpoints.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/database",
|
||||
"fields": {
|
||||
"name": "Database",
|
||||
"describes": [
|
||||
"/api/v3/configure/database",
|
||||
"/api/v3/configure/database/retention_period"
|
||||
],
|
||||
"title": "Database",
|
||||
"description": "Manage databases",
|
||||
"tag": "Database",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetConfigureDatabase",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "List databases",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureDatabase",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "Create a database",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDatabase",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "Delete a database",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteDatabaseRetentionPeriod",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/database/retention_period",
|
||||
"summary": "Remove database retention period",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage databases",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-database.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-database.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/headers-and-parameters",
|
||||
"fields": {
|
||||
"name": "Headers and parameters",
|
||||
"describes": [],
|
||||
"title": "Headers and parameters",
|
||||
"description": "Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use.\n\n### Common parameters\n\nThe following table shows common parameters used by many InfluxDB API endpoints.\nMany endpoints may require other parameters in the query string or in the\nrequest body that perform functions specific to those endpoints.\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `db` | string | The database name |\n\nInfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The authorization scheme and credential. |\n| `Content-Length` | integer | The size of the entity-body, in bytes. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
|
||||
"tag": "Headers and parameters",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [],
|
||||
"tagDescription": "Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use.\n\n### Common parameters\n\nThe following table shows common parameters used by many InfluxDB API endpoints.\nMany endpoints may require other parameters in the query string or in the\nrequest body that perform functions specific to those endpoints.\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `db` | string | The database name |\n\nInfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The authorization scheme and credential. |\n| `Content-Length` | integer | The size of the entity-body, in bytes. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-headers-and-parameters.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-headers-and-parameters.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/processing-engine",
|
||||
"fields": {
|
||||
"name": "Processing engine",
|
||||
"describes": [
|
||||
"/api/v3/configure/processing_engine_trigger",
|
||||
"/api/v3/configure/processing_engine_trigger/disable",
|
||||
"/api/v3/configure/processing_engine_trigger/enable",
|
||||
"/api/v3/configure/plugin_environment/install_packages",
|
||||
"/api/v3/configure/plugin_environment/install_requirements",
|
||||
"/api/v3/plugin_test/wal",
|
||||
"/api/v3/plugin_test/schedule",
|
||||
"/api/v3/engine/{request_path}",
|
||||
"/api/v3/plugins/files",
|
||||
"/api/v3/plugins/directory"
|
||||
],
|
||||
"title": "Processing engine",
|
||||
"description": "Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.\n\nInfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.\nUse Processing engine plugins and triggers to run code and perform tasks for different database events.\n\nTo get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/core/processing-engine/) guide.\n",
|
||||
"tag": "Processing engine",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Processing Engine",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger",
|
||||
"summary": "Create processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureProcessingEngineTrigger",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/processing_engine_trigger",
|
||||
"summary": "Delete processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostDisableProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger/disable",
|
||||
"summary": "Disable processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostEnableProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger/enable",
|
||||
"summary": "Enable processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostInstallPluginPackages",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/plugin_environment/install_packages",
|
||||
"summary": "Install plugin packages",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostInstallPluginRequirements",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/plugin_environment/install_requirements",
|
||||
"summary": "Install plugin requirements",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostTestWALPlugin",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/plugin_test/wal",
|
||||
"summary": "Test WAL plugin",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostTestSchedulingPlugin",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/plugin_test/schedule",
|
||||
"summary": "Test scheduling plugin",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetProcessingEnginePluginRequest",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/engine/{request_path}",
|
||||
"summary": "On Request processing engine plugin request",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostProcessingEnginePluginRequest",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/engine/{request_path}",
|
||||
"summary": "On Request processing engine plugin request",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PutPluginFile",
|
||||
"method": "PUT",
|
||||
"path": "/api/v3/plugins/files",
|
||||
"summary": "Update plugin file",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PutPluginDirectory",
|
||||
"method": "PUT",
|
||||
"path": "/api/v3/plugins/directory",
|
||||
"summary": "Update plugin directory",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.\n\nInfluxDB 3 Core provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.\nUse Processing engine plugins and triggers to run code and perform tasks for different database events.\n\nTo get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/core/processing-engine/) guide.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-processing-engine.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-processing-engine.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/query-data",
|
||||
"fields": {
|
||||
"name": "Query data",
|
||||
"describes": [
|
||||
"/api/v3/query_sql",
|
||||
"/api/v3/query_influxql",
|
||||
"/query"
|
||||
],
|
||||
"title": "Query data",
|
||||
"description": "Query data using SQL or InfluxQL",
|
||||
"tag": "Query data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetExecuteQuerySQL",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/query_sql",
|
||||
"summary": "Execute SQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteQuerySQL",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/query_sql",
|
||||
"summary": "Execute SQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetExecuteInfluxQLQuery",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/query_influxql",
|
||||
"summary": "Execute InfluxQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteQueryInfluxQL",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/query_influxql",
|
||||
"summary": "Execute InfluxQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetV1ExecuteQuery",
|
||||
"method": "GET",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/core/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteV1Query",
|
||||
"method": "POST",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/core/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tagDescription": "Query data using SQL or InfluxQL",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-query-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-query-data.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/quick-start",
|
||||
"fields": {
|
||||
"name": "Quick start",
|
||||
"describes": [],
|
||||
"title": "Quick start",
|
||||
"description": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n",
|
||||
"tag": "Quick start",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [],
|
||||
"tagDescription": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Core, see the [Get started](/influxdb3/core/get-started/) guide.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-quick-start.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-quick-start.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/server-information",
|
||||
"fields": {
|
||||
"name": "Server information",
|
||||
"describes": [
|
||||
"/health",
|
||||
"/api/v1/health",
|
||||
"/ping",
|
||||
"/metrics"
|
||||
],
|
||||
"title": "Server information",
|
||||
"description": "Retrieve server metrics, status, and version information",
|
||||
"tag": "Server information",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Server",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetHealth",
|
||||
"method": "GET",
|
||||
"path": "/health",
|
||||
"summary": "Health check",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetHealthV1",
|
||||
"method": "GET",
|
||||
"path": "/api/v1/health",
|
||||
"summary": "Health check (v1-compatible)",
|
||||
"tags": [
|
||||
"Server information",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1"
|
||||
},
|
||||
{
|
||||
"operationId": "GetPing",
|
||||
"method": "GET",
|
||||
"path": "/ping",
|
||||
"summary": "Ping the server",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetMetrics",
|
||||
"method": "GET",
|
||||
"path": "/metrics",
|
||||
"summary": "Metrics",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Retrieve server metrics, status, and version information",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-server-information.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-server-information.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/table",
|
||||
"fields": {
|
||||
"name": "Table",
|
||||
"describes": [
|
||||
"/api/v3/configure/table",
|
||||
"/api/v3/configure/distinct_cache",
|
||||
"/api/v3/configure/last_cache"
|
||||
],
|
||||
"title": "Table",
|
||||
"description": "Manage table schemas and data",
|
||||
"tag": "Table",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureTable",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/table",
|
||||
"summary": "Create a table",
|
||||
"tags": [
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureTable",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/table",
|
||||
"summary": "Delete a table",
|
||||
"tags": [
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureDistinctCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Create distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDistinctCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Delete distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureLastCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Create last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureLastCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Delete last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage table schemas and data",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-table.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-table.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/token",
|
||||
"fields": {
|
||||
"name": "Token",
|
||||
"describes": [
|
||||
"/api/v3/configure/token/admin",
|
||||
"/api/v3/configure/token/admin/regenerate",
|
||||
"/api/v3/configure/token",
|
||||
"/api/v3/configure/token/named_admin"
|
||||
],
|
||||
"title": "Token",
|
||||
"description": "Manage tokens for authentication and authorization",
|
||||
"tag": "Token",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostCreateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin",
|
||||
"summary": "Create admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostRegenerateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin/regenerate",
|
||||
"summary": "Regenerate admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteToken",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/token",
|
||||
"summary": "Delete token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateNamedAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/named_admin",
|
||||
"summary": "Create named admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage tokens for authentication and authorization",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-token.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-token.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/write-data",
|
||||
"fields": {
|
||||
"name": "Write data",
|
||||
"describes": [
|
||||
"/write",
|
||||
"/api/v2/write",
|
||||
"/api/v3/write_lp"
|
||||
],
|
||||
"title": "Write data",
|
||||
"description": "Write data to InfluxDB 3 using line protocol format.\n\n#### Timestamp precision across write APIs\n\nInfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions.\nThe following table compares timestamp precision support across v1, v2, and v3 write APIs:\n\n| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |\n|-----------|---------------|----------------------|-------------------------|\n| **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |\n| **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |\n| **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |\n| **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |\n| **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |\n| **Minutes** | ✅ `m` | ❌ No | ❌ No |\n| **Hours** | ✅ `h` | ❌ No | ❌ No |\n| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |\n\nAll timestamps are stored internally as nanoseconds.\n",
|
||||
"tag": "Write data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostV1Write",
|
||||
"method": "POST",
|
||||
"path": "/write",
|
||||
"summary": "Write line protocol (v1-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/core/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostV2Write",
|
||||
"method": "POST",
|
||||
"path": "/api/v2/write",
|
||||
"summary": "Write line protocol (v2-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v2",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/core/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostWriteLP",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/write_lp",
|
||||
"summary": "Write line protocol",
|
||||
"tags": [
|
||||
"Write data"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Write data to InfluxDB 3 using line protocol format.\n\n#### Timestamp precision across write APIs\n\nInfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions.\nThe following table compares timestamp precision support across v1, v2, and v3 write APIs:\n\n| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |\n|-----------|---------------|----------------------|-------------------------|\n| **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |\n| **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |\n| **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |\n| **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |\n| **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |\n| **Minutes** | ✅ `m` | ❌ No | ❌ No |\n| **Hours** | ✅ `h` | ❌ No | ❌ No |\n| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |\n\nAll timestamps are stored internally as nanoseconds.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_core/tags/tags/ref-write-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_core/tags/tags/ref-write-data.yaml"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -80,8 +80,8 @@ articles:
|
|||
|
||||
See the **Security Schemes** section below for details on each
|
||||
authentication method.
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-authentication.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-authentication.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-authentication.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-authentication.yaml
|
||||
- path: api/cache-data
|
||||
fields:
|
||||
name: Cache data
|
||||
|
|
@ -247,8 +247,8 @@ articles:
|
|||
Cache](/influxdb3/core/admin/distinct-value-cache/)
|
||||
|
||||
- [Manage the Last Value Cache](/influxdb3/core/admin/last-value-cache/)
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-cache-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-cache-data.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-cache-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-cache-data.yaml
|
||||
- path: api/compatibility-endpoints
|
||||
fields:
|
||||
name: Compatibility endpoints
|
||||
|
|
@ -318,6 +318,10 @@ articles:
|
|||
tags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
- operationId: PostV2Write
|
||||
method: POST
|
||||
path: /api/v2/write
|
||||
|
|
@ -325,6 +329,10 @@ articles:
|
|||
tags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
compatVersion: v2
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
- operationId: GetV1ExecuteQuery
|
||||
method: GET
|
||||
path: /query
|
||||
|
|
@ -332,6 +340,10 @@ articles:
|
|||
tags:
|
||||
- Query data
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
- operationId: PostExecuteV1Query
|
||||
method: POST
|
||||
path: /query
|
||||
|
|
@ -339,13 +351,18 @@ articles:
|
|||
tags:
|
||||
- Query data
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
- operationId: GetHealthV1
|
||||
method: GET
|
||||
path: /api/v1/health
|
||||
summary: Health check (v1)
|
||||
summary: Health check (v1-compatible)
|
||||
tags:
|
||||
- Server information
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
tagDescription: >
|
||||
InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and
|
||||
InfluxDB 2.x workloads and clients.
|
||||
|
|
@ -396,9 +413,9 @@ articles:
|
|||
Server information endpoints such as `/health` and `metrics` are
|
||||
compatible with InfluxDB 1.x and InfluxDB 2.x clients.
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-core/tags/tags/ref-compatibility-endpoints.yaml
|
||||
static/openapi/influxdb-influxdb3_core/tags/tags/ref-compatibility-endpoints.yaml
|
||||
staticFilePath: >-
|
||||
/openapi/influxdb-influxdb3-core/tags/tags/ref-compatibility-endpoints.yaml
|
||||
/openapi/influxdb-influxdb3_core/tags/tags/ref-compatibility-endpoints.yaml
|
||||
- path: api/database
|
||||
fields:
|
||||
name: Database
|
||||
|
|
@ -436,8 +453,8 @@ articles:
|
|||
tags:
|
||||
- Database
|
||||
tagDescription: Manage databases
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-database.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-database.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-database.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-database.yaml
|
||||
- path: api/headers-and-parameters
|
||||
fields:
|
||||
name: Headers and parameters
|
||||
|
|
@ -560,9 +577,9 @@ articles:
|
|||
| `Content-Type` | string | The format of the
|
||||
data in the request body. |
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-core/tags/tags/ref-headers-and-parameters.yaml
|
||||
static/openapi/influxdb-influxdb3_core/tags/tags/ref-headers-and-parameters.yaml
|
||||
staticFilePath: >-
|
||||
/openapi/influxdb-influxdb3-core/tags/tags/ref-headers-and-parameters.yaml
|
||||
/openapi/influxdb-influxdb3_core/tags/tags/ref-headers-and-parameters.yaml
|
||||
- path: api/processing-engine
|
||||
fields:
|
||||
name: Processing engine
|
||||
|
|
@ -685,8 +702,8 @@ articles:
|
|||
To get started with the processing engine, see the [Processing engine
|
||||
and Python plugins](/influxdb3/core/processing-engine/) guide.
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-core/tags/tags/ref-processing-engine.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-processing-engine.yaml
|
||||
static/openapi/influxdb-influxdb3_core/tags/tags/ref-processing-engine.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-processing-engine.yaml
|
||||
- path: api/query-data
|
||||
fields:
|
||||
name: Query data
|
||||
|
|
@ -731,6 +748,10 @@ articles:
|
|||
tags:
|
||||
- Query data
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
- operationId: PostExecuteV1Query
|
||||
method: POST
|
||||
path: /query
|
||||
|
|
@ -738,9 +759,13 @@ articles:
|
|||
tags:
|
||||
- Query data
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use the InfluxDB v1 HTTP query API and InfluxQL to query data
|
||||
url: /influxdb3/core/query-data/execute-queries/influxdb-v1-api/
|
||||
tagDescription: Query data using SQL or InfluxQL
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-query-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-query-data.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-query-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-query-data.yaml
|
||||
- path: api/quick-start
|
||||
fields:
|
||||
name: Quick start
|
||||
|
|
@ -838,8 +863,8 @@ articles:
|
|||
|
||||
For more information about using InfluxDB 3 Core, see the [Get
|
||||
started](/influxdb3/core/get-started/) guide.
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-quick-start.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-quick-start.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-quick-start.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-quick-start.yaml
|
||||
- path: api/server-information
|
||||
fields:
|
||||
name: Server information
|
||||
|
|
@ -863,10 +888,11 @@ articles:
|
|||
- operationId: GetHealthV1
|
||||
method: GET
|
||||
path: /api/v1/health
|
||||
summary: Health check (v1)
|
||||
summary: Health check (v1-compatible)
|
||||
tags:
|
||||
- Server information
|
||||
- Compatibility endpoints
|
||||
compatVersion: v1
|
||||
- operationId: GetPing
|
||||
method: GET
|
||||
path: /ping
|
||||
|
|
@ -881,8 +907,8 @@ articles:
|
|||
- Server information
|
||||
tagDescription: Retrieve server metrics, status, and version information
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-core/tags/tags/ref-server-information.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-server-information.yaml
|
||||
static/openapi/influxdb-influxdb3_core/tags/tags/ref-server-information.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-server-information.yaml
|
||||
- path: api/table
|
||||
fields:
|
||||
name: Table
|
||||
|
|
@ -937,8 +963,8 @@ articles:
|
|||
- Cache data
|
||||
- Table
|
||||
tagDescription: Manage table schemas and data
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-table.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-table.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-table.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-table.yaml
|
||||
- path: api/token
|
||||
fields:
|
||||
name: Token
|
||||
|
|
@ -982,8 +1008,8 @@ articles:
|
|||
- Authentication
|
||||
- Token
|
||||
tagDescription: Manage tokens for authentication and authorization
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-token.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-token.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-token.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-token.yaml
|
||||
- path: api/write-data
|
||||
fields:
|
||||
name: Write data
|
||||
|
|
@ -1040,6 +1066,10 @@ articles:
|
|||
tags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
compatVersion: v1
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
- operationId: PostV2Write
|
||||
method: POST
|
||||
path: /api/v2/write
|
||||
|
|
@ -1047,6 +1077,10 @@ articles:
|
|||
tags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
compatVersion: v2
|
||||
externalDocs:
|
||||
description: Use compatibility APIs to write data
|
||||
url: /influxdb3/core/write-data/http-api/compatibility-apis/
|
||||
- operationId: PostWriteLP
|
||||
method: POST
|
||||
path: /api/v3/write_lp
|
||||
|
|
@ -1090,5 +1124,5 @@ articles:
|
|||
|
||||
|
||||
All timestamps are stored internally as nanoseconds.
|
||||
source: static/openapi/influxdb-influxdb3-core/tags/tags/ref-write-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-core/tags/tags/ref-write-data.yaml
|
||||
source: static/openapi/influxdb-influxdb3_core/tags/tags/ref-write-data.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3_core/tags/tags/ref-write-data.yaml
|
||||
|
|
|
|||
|
|
@ -0,0 +1,842 @@
|
|||
{
|
||||
"articles": [
|
||||
{
|
||||
"path": "api/authentication",
|
||||
"fields": {
|
||||
"name": "Authentication",
|
||||
"describes": [
|
||||
"/api/v3/configure/enterprise/token",
|
||||
"/api/v3/configure/token/admin",
|
||||
"/api/v3/configure/token/admin/regenerate",
|
||||
"/api/v3/configure/token",
|
||||
"/api/v3/configure/token/named_admin"
|
||||
],
|
||||
"title": "Authentication",
|
||||
"description": "Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API:\n\n| Authentication scheme | Works with |\n|:----------------------|:-----------|\n| Bearer authentication | All endpoints |\n| Token authentication | v1, v2 endpoints |\n| Basic authentication | v1 endpoints |\n| Querystring authentication | v1 endpoints |\n\nSee the **Security Schemes** section below for details on each authentication method.\n",
|
||||
"tag": "Authentication",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostCreateResourceToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/enterprise/token",
|
||||
"summary": "Create a resource token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin",
|
||||
"summary": "Create admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostRegenerateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin/regenerate",
|
||||
"summary": "Regenerate admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteToken",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/token",
|
||||
"summary": "Delete token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateNamedAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/named_admin",
|
||||
"summary": "Create named admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Depending on your workflow, use one of the following schemes to authenticate to the InfluxDB 3 API:\n\n| Authentication scheme | Works with |\n|:----------------------|:-----------|\n| Bearer authentication | All endpoints |\n| Token authentication | v1, v2 endpoints |\n| Basic authentication | v1 endpoints |\n| Querystring authentication | v1 endpoints |\n\nSee the **Security Schemes** section below for details on each authentication method.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-authentication.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-authentication.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/cache-data",
|
||||
"fields": {
|
||||
"name": "Cache data",
|
||||
"describes": [
|
||||
"/api/v3/configure/distinct_cache",
|
||||
"/api/v3/configure/last_cache"
|
||||
],
|
||||
"title": "Cache data",
|
||||
"description": "Manage the in-memory cache.\n\n#### Distinct Value Cache\n\nThe Distinct Value Cache (DVC) lets you cache distinct\nvalues of one or more columns in a table, improving the performance of\nqueries that return distinct tag and field values. \n\nThe DVC is an in-memory cache that stores distinct values for specific columns\nin a table. When you create an DVC, you can specify what columns' distinct\nvalues to cache, the maximum number of distinct value combinations to cache, and\nthe maximum age of cached values. A DVC is associated with a table, which can\nhave multiple DVCs.\n\n#### Last value cache\n\nThe Last Value Cache (LVC) lets you cache the most recent\nvalues for specific fields in a table, improving the performance of queries that\nreturn the most recent value of a field for specific series or the last N values\nof a field.\n\nThe LVC is an in-memory cache that stores the last N number of values for\nspecific fields of series in a table. When you create an LVC, you can specify\nwhat fields to cache, what tags to use to identify each series, and the\nnumber of values to cache for each unique series.\nAn LVC is associated with a table, which can have multiple LVCs.\n\n#### Related guides\n\n- [Manage the Distinct Value Cache](/influxdb3/enterprise/admin/distinct-value-cache/)\n- [Manage the Last Value Cache](/influxdb3/enterprise/admin/last-value-cache/)\n",
|
||||
"tag": "Cache data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureDistinctCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Create distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDistinctCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Delete distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureLastCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Create last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureLastCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Delete last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage the in-memory cache.\n\n#### Distinct Value Cache\n\nThe Distinct Value Cache (DVC) lets you cache distinct\nvalues of one or more columns in a table, improving the performance of\nqueries that return distinct tag and field values. \n\nThe DVC is an in-memory cache that stores distinct values for specific columns\nin a table. When you create an DVC, you can specify what columns' distinct\nvalues to cache, the maximum number of distinct value combinations to cache, and\nthe maximum age of cached values. A DVC is associated with a table, which can\nhave multiple DVCs.\n\n#### Last value cache\n\nThe Last Value Cache (LVC) lets you cache the most recent\nvalues for specific fields in a table, improving the performance of queries that\nreturn the most recent value of a field for specific series or the last N values\nof a field.\n\nThe LVC is an in-memory cache that stores the last N number of values for\nspecific fields of series in a table. When you create an LVC, you can specify\nwhat fields to cache, what tags to use to identify each series, and the\nnumber of values to cache for each unique series.\nAn LVC is associated with a table, which can have multiple LVCs.\n\n#### Related guides\n\n- [Manage the Distinct Value Cache](/influxdb3/enterprise/admin/distinct-value-cache/)\n- [Manage the Last Value Cache](/influxdb3/enterprise/admin/last-value-cache/)\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-cache-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-cache-data.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/compatibility-endpoints",
|
||||
"fields": {
|
||||
"name": "Compatibility endpoints",
|
||||
"describes": [
|
||||
"/write",
|
||||
"/api/v2/write",
|
||||
"/query",
|
||||
"/api/v1/health"
|
||||
],
|
||||
"title": "Compatibility endpoints",
|
||||
"description": "InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients.\n\n### Write data using v1- or v2-compatible endpoints\n\n- [`/api/v2/write` endpoint](#operation/PostV2Write)\n for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.\n- [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.\n\nFor new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP).\n\nAll endpoints accept the same line protocol format.\n\n### Query data\n\nUse the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL.\n\nFor new workloads, use one of the following:\n\n- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.\n- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.\n- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).\n\n### Server information\n\nServer information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients.\n",
|
||||
"tag": "Compatibility endpoints",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Compatibility",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostV1Write",
|
||||
"method": "POST",
|
||||
"path": "/write",
|
||||
"summary": "Write line protocol (v1-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/enterprise/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostV2Write",
|
||||
"method": "POST",
|
||||
"path": "/api/v2/write",
|
||||
"summary": "Write line protocol (v2-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v2",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/enterprise/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "GetV1ExecuteQuery",
|
||||
"method": "GET",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteV1Query",
|
||||
"method": "POST",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "GetHealthV1",
|
||||
"method": "GET",
|
||||
"path": "/api/v1/health",
|
||||
"summary": "Health check (v1-compatible)",
|
||||
"tags": [
|
||||
"Server information",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1"
|
||||
}
|
||||
],
|
||||
"tagDescription": "InfluxDB 3 provides compatibility endpoints for InfluxDB 1.x and InfluxDB 2.x workloads and clients.\n\n### Write data using v1- or v2-compatible endpoints\n\n- [`/api/v2/write` endpoint](#operation/PostV2Write)\n for InfluxDB v2 clients and when you bring existing InfluxDB v2 write workloads to InfluxDB 3.\n- [`/write` endpoint](#operation/PostV1Write) for InfluxDB v1 clients and when you bring existing InfluxDB v1 write workloads to InfluxDB 3.\n\nFor new workloads, use the [`/api/v3/write_lp` endpoint](#operation/PostWriteLP).\n\nAll endpoints accept the same line protocol format.\n\n### Query data\n\nUse the HTTP [`/query`](#operation/GetV1ExecuteQuery) endpoint for InfluxDB v1 clients and v1 query workloads using InfluxQL.\n\nFor new workloads, use one of the following:\n\n- HTTP [`/api/v3/query_sql` endpoint](#operation/GetExecuteQuerySQL) for new query workloads using SQL.\n- HTTP [`/api/v3/query_influxql` endpoint](#operation/GetExecuteInfluxQLQuery) for new query workloads using InfluxQL.\n- Flight SQL and InfluxDB 3 _Flight+gRPC_ APIs for querying with SQL or InfluxQL. For more information about using Flight APIs, see [InfluxDB 3 client libraries](https://github.com/InfluxCommunity?q=influxdb3&type=public&language=&sort=).\n\n### Server information\n\nServer information endpoints such as `/health` and `metrics` are compatible with InfluxDB 1.x and InfluxDB 2.x clients.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-compatibility-endpoints.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-compatibility-endpoints.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/database",
|
||||
"fields": {
|
||||
"name": "Database",
|
||||
"describes": [
|
||||
"/api/v3/configure/database",
|
||||
"/api/v3/configure/database/retention_period",
|
||||
"/api/v3/configure/database/{db}"
|
||||
],
|
||||
"title": "Database",
|
||||
"description": "Manage databases",
|
||||
"tag": "Database",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetConfigureDatabase",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "List databases",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureDatabase",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "Create a database",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDatabase",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/database",
|
||||
"summary": "Delete a database",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteDatabaseRetentionPeriod",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/database/retention_period",
|
||||
"summary": "Remove database retention period",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PatchConfigureDatabase",
|
||||
"method": "PATCH",
|
||||
"path": "/api/v3/configure/database/{db}",
|
||||
"summary": "Update a database",
|
||||
"tags": [
|
||||
"Database"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage databases",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-database.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-database.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/headers-and-parameters",
|
||||
"fields": {
|
||||
"name": "Headers and parameters",
|
||||
"describes": [],
|
||||
"title": "Headers and parameters",
|
||||
"description": "Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use.\n\n### Common parameters\n\nThe following table shows common parameters used by many InfluxDB API endpoints.\nMany endpoints may require other parameters in the query string or in the\nrequest body that perform functions specific to those endpoints.\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `db` | string | The database name |\n\nInfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The authorization scheme and credential. |\n| `Content-Length` | integer | The size of the entity-body, in bytes. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
|
||||
"tag": "Headers and parameters",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [],
|
||||
"tagDescription": "Most InfluxDB API endpoints require parameters in the request--for example, specifying the database to use.\n\n### Common parameters\n\nThe following table shows common parameters used by many InfluxDB API endpoints.\nMany endpoints may require other parameters in the query string or in the\nrequest body that perform functions specific to those endpoints.\n\n| Query parameter | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `db` | string | The database name |\n\nInfluxDB HTTP API endpoints use standard HTTP request and response headers.\nThe following table shows common headers used by many InfluxDB API endpoints.\nSome endpoints may use other headers that perform functions more specific to those endpoints--for example,\nthe write endpoints accept the `Content-Encoding` header to indicate that line protocol is compressed in the request body.\n\n| Header | Value type | Description |\n|:------------------------ |:--------------------- |:-------------------------------------------|\n| `Accept` | string | The content type that the client can understand. |\n| `Authorization` | string | The authorization scheme and credential. |\n| `Content-Length` | integer | The size of the entity-body, in bytes. |\n| `Content-Type` | string | The format of the data in the request body. |\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-headers-and-parameters.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-headers-and-parameters.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/processing-engine",
|
||||
"fields": {
|
||||
"name": "Processing engine",
|
||||
"describes": [
|
||||
"/api/v3/configure/processing_engine_trigger",
|
||||
"/api/v3/configure/processing_engine_trigger/disable",
|
||||
"/api/v3/configure/processing_engine_trigger/enable",
|
||||
"/api/v3/configure/plugin_environment/install_packages",
|
||||
"/api/v3/configure/plugin_environment/install_requirements",
|
||||
"/api/v3/plugin_test/wal",
|
||||
"/api/v3/plugin_test/schedule",
|
||||
"/api/v3/engine/{request_path}",
|
||||
"/api/v3/plugins/files",
|
||||
"/api/v3/plugins/directory"
|
||||
],
|
||||
"title": "Processing engine",
|
||||
"description": "Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.\n\nInfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.\nUse Processing engine plugins and triggers to run code and perform tasks for different database events.\n\nTo get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/enterprise/processing-engine/) guide.\n",
|
||||
"tag": "Processing engine",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Processing Engine",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger",
|
||||
"summary": "Create processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureProcessingEngineTrigger",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/processing_engine_trigger",
|
||||
"summary": "Delete processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostDisableProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger/disable",
|
||||
"summary": "Disable processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostEnableProcessingEngineTrigger",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/processing_engine_trigger/enable",
|
||||
"summary": "Enable processing engine trigger",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostInstallPluginPackages",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/plugin_environment/install_packages",
|
||||
"summary": "Install plugin packages",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostInstallPluginRequirements",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/plugin_environment/install_requirements",
|
||||
"summary": "Install plugin requirements",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostTestWALPlugin",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/plugin_test/wal",
|
||||
"summary": "Test WAL plugin",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostTestSchedulingPlugin",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/plugin_test/schedule",
|
||||
"summary": "Test scheduling plugin",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetProcessingEnginePluginRequest",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/engine/{request_path}",
|
||||
"summary": "On Request processing engine plugin request",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostProcessingEnginePluginRequest",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/engine/{request_path}",
|
||||
"summary": "On Request processing engine plugin request",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PutPluginFile",
|
||||
"method": "PUT",
|
||||
"path": "/api/v3/plugins/files",
|
||||
"summary": "Update plugin file",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PutPluginDirectory",
|
||||
"method": "PUT",
|
||||
"path": "/api/v3/plugins/directory",
|
||||
"summary": "Update plugin directory",
|
||||
"tags": [
|
||||
"Processing engine"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage Processing engine triggers, test plugins, and send requests to trigger On Request plugins.\n\nInfluxDB 3 Enterprise provides the InfluxDB 3 processing engine, an embedded Python VM that can dynamically load and trigger Python plugins in response to events in your database.\nUse Processing engine plugins and triggers to run code and perform tasks for different database events.\n\nTo get started with the processing engine, see the [Processing engine and Python plugins](/influxdb3/enterprise/processing-engine/) guide.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-processing-engine.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-processing-engine.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/query-data",
|
||||
"fields": {
|
||||
"name": "Query data",
|
||||
"describes": [
|
||||
"/api/v3/query_sql",
|
||||
"/api/v3/query_influxql",
|
||||
"/query"
|
||||
],
|
||||
"title": "Query data",
|
||||
"description": "Query data using SQL or InfluxQL",
|
||||
"tag": "Query data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetExecuteQuerySQL",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/query_sql",
|
||||
"summary": "Execute SQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteQuerySQL",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/query_sql",
|
||||
"summary": "Execute SQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetExecuteInfluxQLQuery",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/query_influxql",
|
||||
"summary": "Execute InfluxQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteQueryInfluxQL",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/query_influxql",
|
||||
"summary": "Execute InfluxQL query",
|
||||
"tags": [
|
||||
"Query data"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetV1ExecuteQuery",
|
||||
"method": "GET",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostExecuteV1Query",
|
||||
"method": "POST",
|
||||
"path": "/query",
|
||||
"summary": "Execute InfluxQL query (v1-compatible)",
|
||||
"tags": [
|
||||
"Query data",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use the InfluxDB v1 HTTP query API and InfluxQL to query data",
|
||||
"url": "/influxdb3/enterprise/query-data/execute-queries/influxdb-v1-api/"
|
||||
}
|
||||
}
|
||||
],
|
||||
"tagDescription": "Query data using SQL or InfluxQL",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-query-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-query-data.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/quick-start",
|
||||
"fields": {
|
||||
"name": "Quick start",
|
||||
"describes": [],
|
||||
"title": "Quick start",
|
||||
"description": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n",
|
||||
"tag": "Quick start",
|
||||
"isConceptual": true,
|
||||
"menuGroup": "Concepts",
|
||||
"operations": [],
|
||||
"tagDescription": "1. [Create an admin token](#section/Authentication) to authorize API requests.\n\n ```bash\n curl -X POST \"http://localhost:8181/api/v3/configure/token/admin\"\n ```\n2. [Check the status](#section/Server-information) of the InfluxDB server.\n\n ```bash\n curl \"http://localhost:8181/health\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\"\n ```\n\n3. [Write data](#operation/PostWriteLP) to InfluxDB.\n\n ```bash\n curl \"http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto\"\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-raw \"home,room=Kitchen temp=72.0\n home,room=Living\\ room temp=71.5\"\n ```\n\n If all data is written, the response is `204 No Content`.\n\n4. [Query data](#operation/GetExecuteQuerySQL) from InfluxDB.\n\n ```bash\n curl -G \"http://localhost:8181/api/v3/query_sql\" \\\n --header \"Authorization: Bearer ADMIN_TOKEN\" \\\n --data-urlencode \"db=sensors\" \\\n --data-urlencode \"q=SELECT * FROM home WHERE room='Living room'\" \\\n --data-urlencode \"format=jsonl\"\n ```\n \n Output:\n\n ```jsonl\n {\"room\":\"Living room\",\"temp\":71.5,\"time\":\"2025-02-25T20:19:34.984098\"}\n ```\n \nFor more information about using InfluxDB 3 Enterprise, see the [Get started](/influxdb3/enterprise/get-started/) guide.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-quick-start.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-quick-start.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/server-information",
|
||||
"fields": {
|
||||
"name": "Server information",
|
||||
"describes": [
|
||||
"/health",
|
||||
"/api/v1/health",
|
||||
"/ping",
|
||||
"/metrics",
|
||||
"/api/v3/show/license"
|
||||
],
|
||||
"title": "Server information",
|
||||
"description": "Retrieve server metrics, status, and version information",
|
||||
"tag": "Server information",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Server",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "GetHealth",
|
||||
"method": "GET",
|
||||
"path": "/health",
|
||||
"summary": "Health check",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetHealthV1",
|
||||
"method": "GET",
|
||||
"path": "/api/v1/health",
|
||||
"summary": "Health check (v1-compatible)",
|
||||
"tags": [
|
||||
"Server information",
|
||||
"Compatibility endpoints"
|
||||
],
|
||||
"compatVersion": "v1"
|
||||
},
|
||||
{
|
||||
"operationId": "GetPing",
|
||||
"method": "GET",
|
||||
"path": "/ping",
|
||||
"summary": "Ping the server",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetMetrics",
|
||||
"method": "GET",
|
||||
"path": "/metrics",
|
||||
"summary": "Metrics",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "GetShowLicense",
|
||||
"method": "GET",
|
||||
"path": "/api/v3/show/license",
|
||||
"summary": "Show license information",
|
||||
"tags": [
|
||||
"Server information"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Retrieve server metrics, status, and version information",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-server-information.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-server-information.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/table",
|
||||
"fields": {
|
||||
"name": "Table",
|
||||
"describes": [
|
||||
"/api/v3/configure/table",
|
||||
"/api/v3/configure/distinct_cache",
|
||||
"/api/v3/configure/last_cache"
|
||||
],
|
||||
"title": "Table",
|
||||
"description": "Manage table schemas and data",
|
||||
"tag": "Table",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostConfigureTable",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/table",
|
||||
"summary": "Create a table",
|
||||
"tags": [
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PatchConfigureTable",
|
||||
"method": "PATCH",
|
||||
"path": "/api/v3/configure/table",
|
||||
"summary": "Update a table",
|
||||
"tags": [
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureTable",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/table",
|
||||
"summary": "Delete a table",
|
||||
"tags": [
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureDistinctCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Create distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureDistinctCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/distinct_cache",
|
||||
"summary": "Delete distinct cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostConfigureLastCache",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Create last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteConfigureLastCache",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/last_cache",
|
||||
"summary": "Delete last cache",
|
||||
"tags": [
|
||||
"Cache data",
|
||||
"Table"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage table schemas and data",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-table.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-table.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/token",
|
||||
"fields": {
|
||||
"name": "Token",
|
||||
"describes": [
|
||||
"/api/v3/configure/enterprise/token",
|
||||
"/api/v3/configure/token/admin",
|
||||
"/api/v3/configure/token/admin/regenerate",
|
||||
"/api/v3/configure/token",
|
||||
"/api/v3/configure/token/named_admin"
|
||||
],
|
||||
"title": "Token",
|
||||
"description": "Manage tokens for authentication and authorization",
|
||||
"tag": "Token",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Administration",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostCreateResourceToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/enterprise/token",
|
||||
"summary": "Create a resource token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin",
|
||||
"summary": "Create admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostRegenerateAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/admin/regenerate",
|
||||
"summary": "Regenerate admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "DeleteToken",
|
||||
"method": "DELETE",
|
||||
"path": "/api/v3/configure/token",
|
||||
"summary": "Delete token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
},
|
||||
{
|
||||
"operationId": "PostCreateNamedAdminToken",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/configure/token/named_admin",
|
||||
"summary": "Create named admin token",
|
||||
"tags": [
|
||||
"Authentication",
|
||||
"Token"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Manage tokens for authentication and authorization",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-token.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-token.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api/write-data",
|
||||
"fields": {
|
||||
"name": "Write data",
|
||||
"describes": [
|
||||
"/write",
|
||||
"/api/v2/write",
|
||||
"/api/v3/write_lp"
|
||||
],
|
||||
"title": "Write data",
|
||||
"description": "Write data to InfluxDB 3 using line protocol format.\n\n#### Timestamp precision across write APIs\n\nInfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions.\nThe following table compares timestamp precision support across v1, v2, and v3 write APIs:\n\n| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |\n|-----------|---------------|----------------------|-------------------------|\n| **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |\n| **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |\n| **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |\n| **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |\n| **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |\n| **Minutes** | ✅ `m` | ❌ No | ❌ No |\n| **Hours** | ✅ `h` | ❌ No | ❌ No |\n| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |\n\nAll timestamps are stored internally as nanoseconds.\n",
|
||||
"tag": "Write data",
|
||||
"isConceptual": false,
|
||||
"menuGroup": "Data Operations",
|
||||
"operations": [
|
||||
{
|
||||
"operationId": "PostV1Write",
|
||||
"method": "POST",
|
||||
"path": "/write",
|
||||
"summary": "Write line protocol (v1-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v1",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/enterprise/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostV2Write",
|
||||
"method": "POST",
|
||||
"path": "/api/v2/write",
|
||||
"summary": "Write line protocol (v2-compatible)",
|
||||
"tags": [
|
||||
"Compatibility endpoints",
|
||||
"Write data"
|
||||
],
|
||||
"compatVersion": "v2",
|
||||
"externalDocs": {
|
||||
"description": "Use compatibility APIs to write data",
|
||||
"url": "/influxdb3/enterprise/write-data/http-api/compatibility-apis/"
|
||||
}
|
||||
},
|
||||
{
|
||||
"operationId": "PostWriteLP",
|
||||
"method": "POST",
|
||||
"path": "/api/v3/write_lp",
|
||||
"summary": "Write line protocol",
|
||||
"tags": [
|
||||
"Write data"
|
||||
]
|
||||
}
|
||||
],
|
||||
"tagDescription": "Write data to InfluxDB 3 using line protocol format.\n\n#### Timestamp precision across write APIs\n\nInfluxDB 3 provides multiple write endpoints for compatibility with different InfluxDB versions.\nThe following table compares timestamp precision support across v1, v2, and v3 write APIs:\n\n| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |\n|-----------|---------------|----------------------|-------------------------|\n| **Auto detection** | ❌ No | ❌ No | ✅ `auto` (default) |\n| **Seconds** | ✅ `s` | ✅ `s` | ✅ `second` |\n| **Milliseconds** | ✅ `ms` | ✅ `ms` | ✅ `millisecond` |\n| **Microseconds** | ✅ `u` or `µ` | ✅ `us` | ✅ `microsecond` |\n| **Nanoseconds** | ✅ `ns` | ✅ `ns` | ✅ `nanosecond` |\n| **Minutes** | ✅ `m` | ❌ No | ❌ No |\n| **Hours** | ✅ `h` | ❌ No | ❌ No |\n| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |\n\nAll timestamps are stored internally as nanoseconds.\n",
|
||||
"source": "static/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-write-data.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-influxdb3_enterprise/tags/tags/ref-write-data.yaml"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -141,7 +141,13 @@
|
|||
<li class="nav-item api-operation">
|
||||
<a href="{{ $fullUrl | safeURL }}">
|
||||
<span class="api-method api-method--{{ lower .method }}">{{ upper .method }}</span>
|
||||
{{ with .summary }}{{ . }}{{ else }}<code>{{ $apiPath }}</code>{{ end }}
|
||||
{{- $summary := .summary -}}
|
||||
{{- with .compatVersion -}}
|
||||
{{- /* Strip redundant compatibility text when badge is shown */ -}}
|
||||
{{- $summary = replaceRE `\s*\(v[12]-compatible\)` "" $summary -}}
|
||||
{{- end -}}
|
||||
{{ with $summary }}{{ . }}{{ else }}<code>{{ $apiPath }}</code>{{ end }}
|
||||
{{ with .compatVersion }}<span class="api-compat-badge api-compat-badge--{{ . }}" title="InfluxDB {{ . }}-compatible endpoint">{{ . }}</span>{{ end }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
|
|
@ -199,7 +205,13 @@
|
|||
<li class="nav-item api-operation">
|
||||
<a href="{{ $fullUrl | safeURL }}">
|
||||
<span class="api-method api-method--{{ lower .method }}">{{ upper .method }}</span>
|
||||
{{ with .summary }}{{ . }}{{ else }}<code>{{ $apiPath }}</code>{{ end }}
|
||||
{{- $summary := .summary -}}
|
||||
{{- with .compatVersion -}}
|
||||
{{- /* Strip redundant compatibility text when badge is shown */ -}}
|
||||
{{- $summary = replaceRE `\s*\(v[12]-compatible\)` "" $summary -}}
|
||||
{{- end -}}
|
||||
{{ with $summary }}{{ . }}{{ else }}<code>{{ $apiPath }}</code>{{ end }}
|
||||
{{ with .compatVersion }}<span class="api-compat-badge api-compat-badge--{{ . }}" title="InfluxDB {{ . }}-compatible endpoint">{{ . }}</span>{{ end }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
|
|
|
|||
Loading…
Reference in New Issue