feat(api): Add article data files and sidebar navigation partial
- Add YAML article data files for all InfluxDB products - Add sidebar-nav.html partial for API navigation rendering - Rename data directory from article-data to article_data for Hugo compatibility - Remove obsolete JSON articles fileworktree-2025-12-30T19-16-55
Jason Stirnaman
parent
40cf280c5e
commit
fca01004c5
|
|
@ -1,597 +0,0 @@
|
|||
{
|
||||
"articles": [
|
||||
{
|
||||
"path": "api-v2-authorizations",
|
||||
"fields": {
|
||||
"name": "/api/v2/authorizations",
|
||||
"describes": [
|
||||
"/api/v2/authorizations",
|
||||
"/api/v2/authorizations/{authID}"
|
||||
],
|
||||
"title": "/api/v2/authorizations\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"authorizations"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-buckets",
|
||||
"fields": {
|
||||
"name": "/api/v2/buckets",
|
||||
"describes": [
|
||||
"/api/v2/buckets",
|
||||
"/api/v2/buckets/{bucketID}",
|
||||
"/api/v2/buckets/{bucketID}/labels",
|
||||
"/api/v2/buckets/{bucketID}/labels/{labelID}",
|
||||
"/api/v2/buckets/{bucketID}/members",
|
||||
"/api/v2/buckets/{bucketID}/members/{userID}",
|
||||
"/api/v2/buckets/{bucketID}/owners",
|
||||
"/api/v2/buckets/{bucketID}/owners/{userID}",
|
||||
"/api/v2/buckets/{bucketID}/schema/measurements",
|
||||
"/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}"
|
||||
],
|
||||
"title": "/api/v2/buckets\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"buckets"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-checks",
|
||||
"fields": {
|
||||
"name": "/api/v2/checks",
|
||||
"describes": [
|
||||
"/api/v2/checks",
|
||||
"/api/v2/checks/{checkID}",
|
||||
"/api/v2/checks/{checkID}/labels",
|
||||
"/api/v2/checks/{checkID}/labels/{labelID}",
|
||||
"/api/v2/checks/{checkID}/query"
|
||||
],
|
||||
"title": "/api/v2/checks\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"checks"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-dashboards",
|
||||
"fields": {
|
||||
"name": "/api/v2/dashboards",
|
||||
"describes": [
|
||||
"/api/v2/dashboards",
|
||||
"/api/v2/dashboards/{dashboardID}",
|
||||
"/api/v2/dashboards/{dashboardID}/cells",
|
||||
"/api/v2/dashboards/{dashboardID}/cells/{cellID}",
|
||||
"/api/v2/dashboards/{dashboardID}/cells/{cellID}/view",
|
||||
"/api/v2/dashboards/{dashboardID}/labels",
|
||||
"/api/v2/dashboards/{dashboardID}/labels/{labelID}",
|
||||
"/api/v2/dashboards/{dashboardID}/members",
|
||||
"/api/v2/dashboards/{dashboardID}/members/{userID}",
|
||||
"/api/v2/dashboards/{dashboardID}/owners",
|
||||
"/api/v2/dashboards/{dashboardID}/owners/{userID}"
|
||||
],
|
||||
"title": "/api/v2/dashboards\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"dashboards"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-dbrps",
|
||||
"fields": {
|
||||
"name": "/api/v2/dbrps",
|
||||
"describes": [
|
||||
"/api/v2/dbrps",
|
||||
"/api/v2/dbrps/{dbrpID}"
|
||||
],
|
||||
"title": "/api/v2/dbrps\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"dbrps"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-delete",
|
||||
"fields": {
|
||||
"name": "/api/v2/delete",
|
||||
"describes": [
|
||||
"/api/v2/delete"
|
||||
],
|
||||
"title": "/api/v2/delete\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"delete"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-flags",
|
||||
"fields": {
|
||||
"name": "/api/v2/flags",
|
||||
"describes": [
|
||||
"/api/v2/flags"
|
||||
],
|
||||
"title": "/api/v2/flags\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"flags"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-labels",
|
||||
"fields": {
|
||||
"name": "/api/v2/labels",
|
||||
"describes": [
|
||||
"/api/v2/labels",
|
||||
"/api/v2/labels/{labelID}"
|
||||
],
|
||||
"title": "/api/v2/labels\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"labels"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-maps",
|
||||
"fields": {
|
||||
"name": "/api/v2/maps",
|
||||
"describes": [
|
||||
"/api/v2/maps/mapToken"
|
||||
],
|
||||
"title": "/api/v2/maps\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"maps"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-me",
|
||||
"fields": {
|
||||
"name": "/api/v2/me",
|
||||
"describes": [
|
||||
"/api/v2/me",
|
||||
"/api/v2/me/password"
|
||||
],
|
||||
"title": "/api/v2/me\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"me"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-notificationEndpoints",
|
||||
"fields": {
|
||||
"name": "/api/v2/notificationEndpoints",
|
||||
"describes": [
|
||||
"/api/v2/notificationEndpoints",
|
||||
"/api/v2/notificationEndpoints/{endpointID}",
|
||||
"/api/v2/notificationEndpoints/{endpointID}/labels",
|
||||
"/api/v2/notificationEndpoints/{endpointID}/labels/{labelID}"
|
||||
],
|
||||
"title": "/api/v2/notificationEndpoints\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"notificationEndpoints"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-notificationRules",
|
||||
"fields": {
|
||||
"name": "/api/v2/notificationRules",
|
||||
"describes": [
|
||||
"/api/v2/notificationRules",
|
||||
"/api/v2/notificationRules/{ruleID}",
|
||||
"/api/v2/notificationRules/{ruleID}/labels",
|
||||
"/api/v2/notificationRules/{ruleID}/labels/{labelID}",
|
||||
"/api/v2/notificationRules/{ruleID}/query"
|
||||
],
|
||||
"title": "/api/v2/notificationRules\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"notificationRules"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-orgs",
|
||||
"fields": {
|
||||
"name": "/api/v2/orgs",
|
||||
"describes": [
|
||||
"/api/v2/orgs",
|
||||
"/api/v2/orgs/{orgID}",
|
||||
"/api/v2/orgs/{orgID}/limits",
|
||||
"/api/v2/orgs/{orgID}/members",
|
||||
"/api/v2/orgs/{orgID}/members/{userID}",
|
||||
"/api/v2/orgs/{orgID}/owners",
|
||||
"/api/v2/orgs/{orgID}/owners/{userID}",
|
||||
"/api/v2/orgs/{orgID}/secrets",
|
||||
"/api/v2/orgs/{orgID}/secrets/delete",
|
||||
"/api/v2/orgs/{orgID}/secrets/{secretID}",
|
||||
"/api/v2/orgs/{orgID}/usage"
|
||||
],
|
||||
"title": "/api/v2/orgs\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"orgs"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-query",
|
||||
"fields": {
|
||||
"name": "/api/v2/query",
|
||||
"describes": [
|
||||
"/api/v2/query",
|
||||
"/api/v2/query/analyze",
|
||||
"/api/v2/query/ast",
|
||||
"/api/v2/query/suggestions",
|
||||
"/api/v2/query/suggestions/{name}"
|
||||
],
|
||||
"title": "/api/v2/query\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"query"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-resources",
|
||||
"fields": {
|
||||
"name": "/api/v2/resources",
|
||||
"describes": [
|
||||
"/api/v2/resources"
|
||||
],
|
||||
"title": "/api/v2/resources\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"resources"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-scripts",
|
||||
"fields": {
|
||||
"name": "/api/v2/scripts",
|
||||
"describes": [
|
||||
"/api/v2/scripts",
|
||||
"/api/v2/scripts/{scriptID}",
|
||||
"/api/v2/scripts/{scriptID}/invoke",
|
||||
"/api/v2/scripts/{scriptID}/params"
|
||||
],
|
||||
"title": "/api/v2/scripts\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"scripts"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-setup",
|
||||
"fields": {
|
||||
"name": "/api/v2/setup",
|
||||
"describes": [
|
||||
"/api/v2/setup",
|
||||
"/api/v2/setup/user"
|
||||
],
|
||||
"title": "/api/v2/setup\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"setup"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-signin",
|
||||
"fields": {
|
||||
"name": "/api/v2/signin",
|
||||
"describes": [
|
||||
"/api/v2/signin"
|
||||
],
|
||||
"title": "/api/v2/signin\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"signin"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-signout",
|
||||
"fields": {
|
||||
"name": "/api/v2/signout",
|
||||
"describes": [
|
||||
"/api/v2/signout"
|
||||
],
|
||||
"title": "/api/v2/signout\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"signout"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-stacks",
|
||||
"fields": {
|
||||
"name": "/api/v2/stacks",
|
||||
"describes": [
|
||||
"/api/v2/stacks",
|
||||
"/api/v2/stacks/{stack_id}",
|
||||
"/api/v2/stacks/{stack_id}/uninstall"
|
||||
],
|
||||
"title": "/api/v2/stacks\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"stacks"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-tasks",
|
||||
"fields": {
|
||||
"name": "/api/v2/tasks",
|
||||
"describes": [
|
||||
"/api/v2/tasks",
|
||||
"/api/v2/tasks/{taskID}",
|
||||
"/api/v2/tasks/{taskID}/labels",
|
||||
"/api/v2/tasks/{taskID}/labels/{labelID}",
|
||||
"/api/v2/tasks/{taskID}/logs",
|
||||
"/api/v2/tasks/{taskID}/members",
|
||||
"/api/v2/tasks/{taskID}/members/{userID}",
|
||||
"/api/v2/tasks/{taskID}/owners",
|
||||
"/api/v2/tasks/{taskID}/owners/{userID}",
|
||||
"/api/v2/tasks/{taskID}/runs",
|
||||
"/api/v2/tasks/{taskID}/runs/{runID}",
|
||||
"/api/v2/tasks/{taskID}/runs/{runID}/logs",
|
||||
"/api/v2/tasks/{taskID}/runs/{runID}/retry"
|
||||
],
|
||||
"title": "/api/v2/tasks\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"tasks"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-telegraf",
|
||||
"fields": {
|
||||
"name": "/api/v2/telegraf",
|
||||
"describes": [
|
||||
"/api/v2/telegraf/plugins"
|
||||
],
|
||||
"title": "/api/v2/telegraf\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"telegraf"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-telegrafs",
|
||||
"fields": {
|
||||
"name": "/api/v2/telegrafs",
|
||||
"describes": [
|
||||
"/api/v2/telegrafs",
|
||||
"/api/v2/telegrafs/{telegrafID}",
|
||||
"/api/v2/telegrafs/{telegrafID}/labels",
|
||||
"/api/v2/telegrafs/{telegrafID}/labels/{labelID}",
|
||||
"/api/v2/telegrafs/{telegrafID}/members",
|
||||
"/api/v2/telegrafs/{telegrafID}/members/{userID}",
|
||||
"/api/v2/telegrafs/{telegrafID}/owners",
|
||||
"/api/v2/telegrafs/{telegrafID}/owners/{userID}"
|
||||
],
|
||||
"title": "/api/v2/telegrafs\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"telegrafs"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-templates",
|
||||
"fields": {
|
||||
"name": "/api/v2/templates",
|
||||
"describes": [
|
||||
"/api/v2/templates/apply",
|
||||
"/api/v2/templates/export"
|
||||
],
|
||||
"title": "/api/v2/templates\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"templates"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-users",
|
||||
"fields": {
|
||||
"name": "/api/v2/users",
|
||||
"describes": [
|
||||
"/api/v2/users",
|
||||
"/api/v2/users/{userID}",
|
||||
"/api/v2/users/{userID}/password"
|
||||
],
|
||||
"title": "/api/v2/users\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"users"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-variables",
|
||||
"fields": {
|
||||
"name": "/api/v2/variables",
|
||||
"describes": [
|
||||
"/api/v2/variables",
|
||||
"/api/v2/variables/{variableID}",
|
||||
"/api/v2/variables/{variableID}/labels",
|
||||
"/api/v2/variables/{variableID}/labels/{labelID}"
|
||||
],
|
||||
"title": "/api/v2/variables\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"variables"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2-write",
|
||||
"fields": {
|
||||
"name": "/api/v2/write",
|
||||
"describes": [
|
||||
"/api/v2/write"
|
||||
],
|
||||
"title": "/api/v2/write\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api-v2",
|
||||
"write"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "api-v2",
|
||||
"fields": {
|
||||
"name": "/api/v2",
|
||||
"describes": [
|
||||
"/api/v2"
|
||||
],
|
||||
"title": "/api/v2\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"api",
|
||||
"v2"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "legacy-authorizations",
|
||||
"fields": {
|
||||
"name": "/legacy/authorizations",
|
||||
"describes": [
|
||||
"/legacy/authorizations",
|
||||
"/legacy/authorizations/{authID}",
|
||||
"/legacy/authorizations/{authID}/password"
|
||||
],
|
||||
"title": "/legacy/authorizations\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"legacy",
|
||||
"authorizations"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "ping",
|
||||
"fields": {
|
||||
"name": "/ping",
|
||||
"describes": [
|
||||
"/ping"
|
||||
],
|
||||
"title": "/ping\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"",
|
||||
"ping"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-ping.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-ping.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "query",
|
||||
"fields": {
|
||||
"name": "/query",
|
||||
"describes": [
|
||||
"/query"
|
||||
],
|
||||
"title": "/query\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"",
|
||||
"query"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-query.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-query.yaml"
|
||||
}
|
||||
},
|
||||
{
|
||||
"path": "write",
|
||||
"fields": {
|
||||
"name": "/write",
|
||||
"describes": [
|
||||
"/write"
|
||||
],
|
||||
"title": "/write\nInfluxDB Cloud API Service",
|
||||
"tags": [
|
||||
"",
|
||||
"write"
|
||||
],
|
||||
"source": "static/openapi/influxdb-cloud-v2/paths/ref-write.yaml",
|
||||
"staticFilePath": "/openapi/influxdb-cloud-v2/paths/ref-write.yaml"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
articles:
|
||||
- path: api/accounts/{accountId}/clusters
|
||||
fields:
|
||||
name: /accounts/{accountId}/clusters
|
||||
describes:
|
||||
- /accounts/{accountId}/clusters/{clusterId}/databases
|
||||
- /accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}
|
||||
- >-
|
||||
/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables
|
||||
- /accounts/{accountId}/clusters/{clusterId}/tokens
|
||||
- /accounts/{accountId}/clusters/{clusterId}/tokens/{tokenId}
|
||||
menuName: /accounts/{accountId}/clusters
|
||||
title: /accounts/{accountId}/clusters
|
||||
tags:
|
||||
- accounts-{accountId}
|
||||
- clusters
|
||||
apiTags:
|
||||
- Databases
|
||||
- Tables
|
||||
- Database tokens
|
||||
source: >-
|
||||
static/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
|
||||
staticFilePath: >-
|
||||
/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
|
||||
|
|
@ -0,0 +1,499 @@
|
|||
articles:
|
||||
- path: api/v2/authorizations
|
||||
fields:
|
||||
name: /api/v2/authorizations
|
||||
describes:
|
||||
- /api/v2/authorizations
|
||||
- /api/v2/authorizations/{authID}
|
||||
title: |-
|
||||
/api/v2/authorizations
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- authorizations
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-authorizations.yaml
|
||||
- path: api/v2/buckets
|
||||
fields:
|
||||
name: /api/v2/buckets
|
||||
describes:
|
||||
- /api/v2/buckets
|
||||
- /api/v2/buckets/{bucketID}
|
||||
- /api/v2/buckets/{bucketID}/labels
|
||||
- /api/v2/buckets/{bucketID}/labels/{labelID}
|
||||
- /api/v2/buckets/{bucketID}/members
|
||||
- /api/v2/buckets/{bucketID}/members/{userID}
|
||||
- /api/v2/buckets/{bucketID}/owners
|
||||
- /api/v2/buckets/{bucketID}/owners/{userID}
|
||||
- /api/v2/buckets/{bucketID}/schema/measurements
|
||||
- /api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
|
||||
title: |-
|
||||
/api/v2/buckets
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- buckets
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-buckets.yaml
|
||||
- path: api/v2/checks
|
||||
fields:
|
||||
name: /api/v2/checks
|
||||
describes:
|
||||
- /api/v2/checks
|
||||
- /api/v2/checks/{checkID}
|
||||
- /api/v2/checks/{checkID}/labels
|
||||
- /api/v2/checks/{checkID}/labels/{labelID}
|
||||
- /api/v2/checks/{checkID}/query
|
||||
title: |-
|
||||
/api/v2/checks
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- checks
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-checks.yaml
|
||||
- path: api/v2/dashboards
|
||||
fields:
|
||||
name: /api/v2/dashboards
|
||||
describes:
|
||||
- /api/v2/dashboards
|
||||
- /api/v2/dashboards/{dashboardID}
|
||||
- /api/v2/dashboards/{dashboardID}/cells
|
||||
- /api/v2/dashboards/{dashboardID}/cells/{cellID}
|
||||
- /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
|
||||
- /api/v2/dashboards/{dashboardID}/labels
|
||||
- /api/v2/dashboards/{dashboardID}/labels/{labelID}
|
||||
- /api/v2/dashboards/{dashboardID}/members
|
||||
- /api/v2/dashboards/{dashboardID}/members/{userID}
|
||||
- /api/v2/dashboards/{dashboardID}/owners
|
||||
- /api/v2/dashboards/{dashboardID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/dashboards
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- dashboards
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-dashboards.yaml
|
||||
- path: api/v2/dbrps
|
||||
fields:
|
||||
name: /api/v2/dbrps
|
||||
describes:
|
||||
- /api/v2/dbrps
|
||||
- /api/v2/dbrps/{dbrpID}
|
||||
title: |-
|
||||
/api/v2/dbrps
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- dbrps
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-dbrps.yaml
|
||||
- path: api/v2/delete
|
||||
fields:
|
||||
name: /api/v2/delete
|
||||
describes:
|
||||
- /api/v2/delete
|
||||
title: |-
|
||||
/api/v2/delete
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- delete
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-delete.yaml
|
||||
- path: api/v2/flags
|
||||
fields:
|
||||
name: /api/v2/flags
|
||||
describes:
|
||||
- /api/v2/flags
|
||||
title: |-
|
||||
/api/v2/flags
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- flags
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-flags.yaml
|
||||
- path: api/v2/labels
|
||||
fields:
|
||||
name: /api/v2/labels
|
||||
describes:
|
||||
- /api/v2/labels
|
||||
- /api/v2/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/labels
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- labels
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-labels.yaml
|
||||
- path: api/v2/maps
|
||||
fields:
|
||||
name: /api/v2/maps
|
||||
describes:
|
||||
- /api/v2/maps/mapToken
|
||||
title: |-
|
||||
/api/v2/maps
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- maps
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-maps.yaml
|
||||
- path: api/v2/me
|
||||
fields:
|
||||
name: /api/v2/me
|
||||
describes:
|
||||
- /api/v2/me
|
||||
- /api/v2/me/password
|
||||
title: |-
|
||||
/api/v2/me
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- me
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-me.yaml
|
||||
- path: api/v2/notificationEndpoints
|
||||
fields:
|
||||
name: /api/v2/notificationEndpoints
|
||||
describes:
|
||||
- /api/v2/notificationEndpoints
|
||||
- /api/v2/notificationEndpoints/{endpointID}
|
||||
- /api/v2/notificationEndpoints/{endpointID}/labels
|
||||
- /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/notificationEndpoints
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- notificationEndpoints
|
||||
source: >-
|
||||
static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationEndpoints.yaml
|
||||
- path: api/v2/notificationRules
|
||||
fields:
|
||||
name: /api/v2/notificationRules
|
||||
describes:
|
||||
- /api/v2/notificationRules
|
||||
- /api/v2/notificationRules/{ruleID}
|
||||
- /api/v2/notificationRules/{ruleID}/labels
|
||||
- /api/v2/notificationRules/{ruleID}/labels/{labelID}
|
||||
- /api/v2/notificationRules/{ruleID}/query
|
||||
title: |-
|
||||
/api/v2/notificationRules
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- notificationRules
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-notificationRules.yaml
|
||||
- path: api/v2/orgs
|
||||
fields:
|
||||
name: /api/v2/orgs
|
||||
describes:
|
||||
- /api/v2/orgs
|
||||
- /api/v2/orgs/{orgID}
|
||||
- /api/v2/orgs/{orgID}/limits
|
||||
- /api/v2/orgs/{orgID}/members
|
||||
- /api/v2/orgs/{orgID}/members/{userID}
|
||||
- /api/v2/orgs/{orgID}/owners
|
||||
- /api/v2/orgs/{orgID}/owners/{userID}
|
||||
- /api/v2/orgs/{orgID}/secrets
|
||||
- /api/v2/orgs/{orgID}/secrets/delete
|
||||
- /api/v2/orgs/{orgID}/secrets/{secretID}
|
||||
- /api/v2/orgs/{orgID}/usage
|
||||
title: |-
|
||||
/api/v2/orgs
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- orgs
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-orgs.yaml
|
||||
- path: api/v2/query
|
||||
fields:
|
||||
name: /api/v2/query
|
||||
describes:
|
||||
- /api/v2/query
|
||||
- /api/v2/query/analyze
|
||||
- /api/v2/query/ast
|
||||
- /api/v2/query/suggestions
|
||||
- /api/v2/query/suggestions/{name}
|
||||
title: |-
|
||||
/api/v2/query
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- query
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-query.yaml
|
||||
- path: api/v2/resources
|
||||
fields:
|
||||
name: /api/v2/resources
|
||||
describes:
|
||||
- /api/v2/resources
|
||||
title: |-
|
||||
/api/v2/resources
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- resources
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-resources.yaml
|
||||
- path: api/v2/scripts
|
||||
fields:
|
||||
name: /api/v2/scripts
|
||||
describes:
|
||||
- /api/v2/scripts
|
||||
- /api/v2/scripts/{scriptID}
|
||||
- /api/v2/scripts/{scriptID}/invoke
|
||||
- /api/v2/scripts/{scriptID}/params
|
||||
title: |-
|
||||
/api/v2/scripts
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- scripts
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-scripts.yaml
|
||||
- path: api/v2/setup
|
||||
fields:
|
||||
name: /api/v2/setup
|
||||
describes:
|
||||
- /api/v2/setup
|
||||
- /api/v2/setup/user
|
||||
title: |-
|
||||
/api/v2/setup
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- setup
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-setup.yaml
|
||||
- path: api/v2/signin
|
||||
fields:
|
||||
name: /api/v2/signin
|
||||
describes:
|
||||
- /api/v2/signin
|
||||
title: |-
|
||||
/api/v2/signin
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- signin
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-signin.yaml
|
||||
- path: api/v2/signout
|
||||
fields:
|
||||
name: /api/v2/signout
|
||||
describes:
|
||||
- /api/v2/signout
|
||||
title: |-
|
||||
/api/v2/signout
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- signout
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-signout.yaml
|
||||
- path: api/v2/stacks
|
||||
fields:
|
||||
name: /api/v2/stacks
|
||||
describes:
|
||||
- /api/v2/stacks
|
||||
- /api/v2/stacks/{stack_id}
|
||||
- /api/v2/stacks/{stack_id}/uninstall
|
||||
title: |-
|
||||
/api/v2/stacks
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- stacks
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-stacks.yaml
|
||||
- path: api/v2/tasks
|
||||
fields:
|
||||
name: /api/v2/tasks
|
||||
describes:
|
||||
- /api/v2/tasks
|
||||
- /api/v2/tasks/{taskID}
|
||||
- /api/v2/tasks/{taskID}/labels
|
||||
- /api/v2/tasks/{taskID}/labels/{labelID}
|
||||
- /api/v2/tasks/{taskID}/logs
|
||||
- /api/v2/tasks/{taskID}/members
|
||||
- /api/v2/tasks/{taskID}/members/{userID}
|
||||
- /api/v2/tasks/{taskID}/owners
|
||||
- /api/v2/tasks/{taskID}/owners/{userID}
|
||||
- /api/v2/tasks/{taskID}/runs
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}/logs
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}/retry
|
||||
title: |-
|
||||
/api/v2/tasks
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- tasks
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-tasks.yaml
|
||||
- path: api/v2/telegraf
|
||||
fields:
|
||||
name: /api/v2/telegraf
|
||||
describes:
|
||||
- /api/v2/telegraf/plugins
|
||||
title: |-
|
||||
/api/v2/telegraf
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- telegraf
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-telegraf.yaml
|
||||
- path: api/v2/telegrafs
|
||||
fields:
|
||||
name: /api/v2/telegrafs
|
||||
describes:
|
||||
- /api/v2/telegrafs
|
||||
- /api/v2/telegrafs/{telegrafID}
|
||||
- /api/v2/telegrafs/{telegrafID}/labels
|
||||
- /api/v2/telegrafs/{telegrafID}/labels/{labelID}
|
||||
- /api/v2/telegrafs/{telegrafID}/members
|
||||
- /api/v2/telegrafs/{telegrafID}/members/{userID}
|
||||
- /api/v2/telegrafs/{telegrafID}/owners
|
||||
- /api/v2/telegrafs/{telegrafID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/telegrafs
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- telegrafs
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-telegrafs.yaml
|
||||
- path: api/v2/templates
|
||||
fields:
|
||||
name: /api/v2/templates
|
||||
describes:
|
||||
- /api/v2/templates/apply
|
||||
- /api/v2/templates/export
|
||||
title: |-
|
||||
/api/v2/templates
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- templates
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-templates.yaml
|
||||
- path: api/v2/users
|
||||
fields:
|
||||
name: /api/v2/users
|
||||
describes:
|
||||
- /api/v2/users
|
||||
- /api/v2/users/{userID}
|
||||
- /api/v2/users/{userID}/password
|
||||
title: |-
|
||||
/api/v2/users
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- users
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-users.yaml
|
||||
- path: api/v2/variables
|
||||
fields:
|
||||
name: /api/v2/variables
|
||||
describes:
|
||||
- /api/v2/variables
|
||||
- /api/v2/variables/{variableID}
|
||||
- /api/v2/variables/{variableID}/labels
|
||||
- /api/v2/variables/{variableID}/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/variables
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- variables
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-variables.yaml
|
||||
- path: api/v2/write
|
||||
fields:
|
||||
name: /api/v2/write
|
||||
describes:
|
||||
- /api/v2/write
|
||||
title: |-
|
||||
/api/v2/write
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- write
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2-write.yaml
|
||||
- path: api/v2
|
||||
fields:
|
||||
name: /api/v2
|
||||
describes:
|
||||
- /api/v2
|
||||
title: |-
|
||||
/api/v2
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- api
|
||||
- v2
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-api-v2.yaml
|
||||
- path: legacy/authorizations
|
||||
fields:
|
||||
name: /legacy/authorizations
|
||||
describes:
|
||||
- /legacy/authorizations
|
||||
- /legacy/authorizations/{authID}
|
||||
- /legacy/authorizations/{authID}/password
|
||||
title: |-
|
||||
/legacy/authorizations
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- legacy
|
||||
- authorizations
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-legacy-authorizations.yaml
|
||||
- path: ping
|
||||
fields:
|
||||
name: /ping
|
||||
describes:
|
||||
- /ping
|
||||
title: |-
|
||||
/ping
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- ''
|
||||
- ping
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-ping.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-ping.yaml
|
||||
- path: query
|
||||
fields:
|
||||
name: /query
|
||||
describes:
|
||||
- /query
|
||||
title: |-
|
||||
/query
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- ''
|
||||
- query
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-query.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-query.yaml
|
||||
- path: write
|
||||
fields:
|
||||
name: /write
|
||||
describes:
|
||||
- /write
|
||||
title: |-
|
||||
/write
|
||||
InfluxDB Cloud API Service
|
||||
tags:
|
||||
- ''
|
||||
- write
|
||||
source: static/openapi/influxdb-cloud-v2/paths/ref-write.yaml
|
||||
staticFilePath: /openapi/influxdb-cloud-v2/paths/ref-write.yaml
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
articles:
|
||||
- path: api/databases/{databaseName}/tables
|
||||
fields:
|
||||
name: /databases/{databaseName}/tables
|
||||
describes:
|
||||
- /databases/{databaseName}/tables
|
||||
menuName: /databases/{databaseName}/tables
|
||||
title: /databases/{databaseName}/tables
|
||||
tags:
|
||||
- databases-{databaseName}
|
||||
- tables
|
||||
apiTags:
|
||||
- Tables
|
||||
source: >-
|
||||
static/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
|
||||
staticFilePath: >-
|
||||
/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
|
||||
- path: api/databases
|
||||
fields:
|
||||
name: /databases
|
||||
describes:
|
||||
- /databases
|
||||
- /databases/{databaseName}
|
||||
menuName: /databases
|
||||
title: /databases
|
||||
tags:
|
||||
- ''
|
||||
- databases
|
||||
apiTags:
|
||||
- Databases
|
||||
source: static/openapi/influxdb-clustered/paths/openapi-databases.yaml
|
||||
staticFilePath: /openapi/influxdb-clustered/paths/openapi-databases.yaml
|
||||
- path: api/tokens
|
||||
fields:
|
||||
name: /tokens
|
||||
describes:
|
||||
- /tokens
|
||||
- /tokens/{tokenId}
|
||||
menuName: /tokens
|
||||
title: /tokens
|
||||
tags:
|
||||
- ''
|
||||
- tokens
|
||||
apiTags:
|
||||
- Database tokens
|
||||
source: static/openapi/influxdb-clustered/paths/openapi-tokens.yaml
|
||||
staticFilePath: /openapi/influxdb-clustered/paths/openapi-tokens.yaml
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,246 @@
|
|||
articles:
|
||||
- path: api/v1/health
|
||||
fields:
|
||||
name: /api/v1/health
|
||||
describes:
|
||||
- /api/v1/health
|
||||
menuName: /api/v1/health
|
||||
title: /api/v1/health
|
||||
tags:
|
||||
- api-v1
|
||||
- health
|
||||
apiTags:
|
||||
- Server information
|
||||
- Compatibility endpoints
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v1-health.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v1-health.yaml
|
||||
- path: api/v2/write
|
||||
fields:
|
||||
name: /api/v2/write
|
||||
describes:
|
||||
- /api/v2/write
|
||||
menuName: /api/v2/write
|
||||
title: /api/v2/write
|
||||
tags:
|
||||
- api-v2
|
||||
- write
|
||||
apiTags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v2-write.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v2-write.yaml
|
||||
- path: api/v3/configure
|
||||
fields:
|
||||
name: /api/v3/configure
|
||||
describes:
|
||||
- /api/v3/configure/database
|
||||
- /api/v3/configure/database/retention_period
|
||||
- /api/v3/configure/database/{db}
|
||||
- /api/v3/configure/distinct_cache
|
||||
- /api/v3/configure/enterprise/token
|
||||
- /api/v3/configure/last_cache
|
||||
- /api/v3/configure/plugin_environment/install_packages
|
||||
- /api/v3/configure/plugin_environment/install_requirements
|
||||
- /api/v3/configure/processing_engine_trigger
|
||||
- /api/v3/configure/processing_engine_trigger/disable
|
||||
- /api/v3/configure/processing_engine_trigger/enable
|
||||
- /api/v3/configure/table
|
||||
- /api/v3/configure/token
|
||||
- /api/v3/configure/token/admin
|
||||
- /api/v3/configure/token/admin/regenerate
|
||||
- /api/v3/configure/token/named_admin
|
||||
menuName: /api/v3/configure
|
||||
title: /api/v3/configure
|
||||
tags:
|
||||
- api-v3
|
||||
- configure
|
||||
apiTags:
|
||||
- Database
|
||||
- Cache data
|
||||
- Table
|
||||
- Authentication
|
||||
- Token
|
||||
- Processing engine
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-configure.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-configure.yaml
|
||||
- path: api/v3/engine
|
||||
fields:
|
||||
name: /api/v3/engine
|
||||
describes:
|
||||
- /api/v3/engine/{request_path}
|
||||
menuName: /api/v3/engine
|
||||
title: /api/v3/engine
|
||||
tags:
|
||||
- api-v3
|
||||
- engine
|
||||
apiTags:
|
||||
- Processing engine
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-engine.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-engine.yaml
|
||||
- path: api/v3/plugin_test
|
||||
fields:
|
||||
name: /api/v3/plugin_test
|
||||
describes:
|
||||
- /api/v3/plugin_test/schedule
|
||||
- /api/v3/plugin_test/wal
|
||||
menuName: /api/v3/plugin_test
|
||||
title: /api/v3/plugin_test
|
||||
tags:
|
||||
- api-v3
|
||||
- plugin_test
|
||||
apiTags:
|
||||
- Processing engine
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugin_test.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugin_test.yaml
|
||||
- path: api/v3/plugins
|
||||
fields:
|
||||
name: /api/v3/plugins
|
||||
describes:
|
||||
- /api/v3/plugins/directory
|
||||
- /api/v3/plugins/files
|
||||
menuName: /api/v3/plugins
|
||||
title: /api/v3/plugins
|
||||
tags:
|
||||
- api-v3
|
||||
- plugins
|
||||
apiTags:
|
||||
- Processing engine
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugins.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-plugins.yaml
|
||||
- path: api/v3/query_influxql
|
||||
fields:
|
||||
name: /api/v3/query_influxql
|
||||
describes:
|
||||
- /api/v3/query_influxql
|
||||
menuName: /api/v3/query_influxql
|
||||
title: /api/v3/query_influxql
|
||||
tags:
|
||||
- api-v3
|
||||
- query_influxql
|
||||
apiTags:
|
||||
- Query data
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_influxql.yaml
|
||||
staticFilePath: >-
|
||||
/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_influxql.yaml
|
||||
- path: api/v3/query_sql
|
||||
fields:
|
||||
name: /api/v3/query_sql
|
||||
describes:
|
||||
- /api/v3/query_sql
|
||||
menuName: /api/v3/query_sql
|
||||
title: /api/v3/query_sql
|
||||
tags:
|
||||
- api-v3
|
||||
- query_sql
|
||||
apiTags:
|
||||
- Query data
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_sql.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-query_sql.yaml
|
||||
- path: api/v3/show
|
||||
fields:
|
||||
name: /api/v3/show
|
||||
describes:
|
||||
- /api/v3/show/license
|
||||
menuName: /api/v3/show
|
||||
title: /api/v3/show
|
||||
tags:
|
||||
- api-v3
|
||||
- show
|
||||
apiTags:
|
||||
- Server information
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-show.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-show.yaml
|
||||
- path: api/v3/write_lp
|
||||
fields:
|
||||
name: /api/v3/write_lp
|
||||
describes:
|
||||
- /api/v3/write_lp
|
||||
menuName: /api/v3/write_lp
|
||||
title: /api/v3/write_lp
|
||||
tags:
|
||||
- api-v3
|
||||
- write_lp
|
||||
apiTags:
|
||||
- Write data
|
||||
source: >-
|
||||
static/openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-write_lp.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-api-v3-write_lp.yaml
|
||||
- path: api/health
|
||||
fields:
|
||||
name: /health
|
||||
describes:
|
||||
- /health
|
||||
menuName: /health
|
||||
title: /health
|
||||
tags:
|
||||
- ''
|
||||
- health
|
||||
apiTags:
|
||||
- Server information
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-health.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-health.yaml
|
||||
- path: api/metrics
|
||||
fields:
|
||||
name: /metrics
|
||||
describes:
|
||||
- /metrics
|
||||
menuName: /metrics
|
||||
title: /metrics
|
||||
tags:
|
||||
- ''
|
||||
- metrics
|
||||
apiTags:
|
||||
- Server information
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-metrics.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-metrics.yaml
|
||||
- path: api/ping
|
||||
fields:
|
||||
name: /ping
|
||||
describes:
|
||||
- /ping
|
||||
menuName: /ping
|
||||
title: /ping
|
||||
tags:
|
||||
- ''
|
||||
- ping
|
||||
apiTags:
|
||||
- Server information
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-ping.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-ping.yaml
|
||||
- path: api/query
|
||||
fields:
|
||||
name: /query
|
||||
describes:
|
||||
- /query
|
||||
menuName: /query
|
||||
title: /query
|
||||
tags:
|
||||
- ''
|
||||
- query
|
||||
apiTags:
|
||||
- Query data
|
||||
- Compatibility endpoints
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-query.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-query.yaml
|
||||
- path: api/write
|
||||
fields:
|
||||
name: /write
|
||||
describes:
|
||||
- /write
|
||||
menuName: /write
|
||||
title: /write
|
||||
tags:
|
||||
- ''
|
||||
- write
|
||||
apiTags:
|
||||
- Compatibility endpoints
|
||||
- Write data
|
||||
source: static/openapi/influxdb-influxdb3-enterprise/paths/ref-write.yaml
|
||||
staticFilePath: /openapi/influxdb-influxdb3-enterprise/paths/ref-write.yaml
|
||||
|
|
@ -0,0 +1,757 @@
|
|||
articles:
|
||||
- path: api/v2/authorizations
|
||||
fields:
|
||||
name: /api/v2/authorizations
|
||||
describes:
|
||||
- /api/v2/authorizations
|
||||
- /api/v2/authorizations/{authID}
|
||||
title: |-
|
||||
/api/v2/authorizations
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- authorizations
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-authorizations.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-authorizations.yaml
|
||||
- path: api/v2/backup
|
||||
fields:
|
||||
name: /api/v2/backup
|
||||
describes:
|
||||
- /api/v2/backup/kv
|
||||
- /api/v2/backup/metadata
|
||||
- /api/v2/backup/shards/{shardID}
|
||||
title: |-
|
||||
/api/v2/backup
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- backup
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-backup.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-backup.yaml
|
||||
- path: api/v2/buckets
|
||||
fields:
|
||||
name: /api/v2/buckets
|
||||
describes:
|
||||
- /api/v2/buckets
|
||||
- /api/v2/buckets/{bucketID}
|
||||
- /api/v2/buckets/{bucketID}/labels
|
||||
- /api/v2/buckets/{bucketID}/labels/{labelID}
|
||||
- /api/v2/buckets/{bucketID}/members
|
||||
- /api/v2/buckets/{bucketID}/members/{userID}
|
||||
- /api/v2/buckets/{bucketID}/owners
|
||||
- /api/v2/buckets/{bucketID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/buckets
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- buckets
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-buckets.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-buckets.yaml
|
||||
- path: api/v2/checks
|
||||
fields:
|
||||
name: /api/v2/checks
|
||||
describes:
|
||||
- /api/v2/checks
|
||||
- /api/v2/checks/{checkID}
|
||||
- /api/v2/checks/{checkID}/labels
|
||||
- /api/v2/checks/{checkID}/labels/{labelID}
|
||||
- /api/v2/checks/{checkID}/query
|
||||
title: |-
|
||||
/api/v2/checks
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- checks
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-checks.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-checks.yaml
|
||||
- path: api/v2/config
|
||||
fields:
|
||||
name: /api/v2/config
|
||||
describes:
|
||||
- /api/v2/config
|
||||
title: |-
|
||||
/api/v2/config
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- config
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-config.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-config.yaml
|
||||
- path: api/v2/dashboards
|
||||
fields:
|
||||
name: /api/v2/dashboards
|
||||
describes:
|
||||
- /api/v2/dashboards
|
||||
- /api/v2/dashboards/{dashboardID}
|
||||
- /api/v2/dashboards/{dashboardID}/cells
|
||||
- /api/v2/dashboards/{dashboardID}/cells/{cellID}
|
||||
- /api/v2/dashboards/{dashboardID}/cells/{cellID}/view
|
||||
- /api/v2/dashboards/{dashboardID}/labels
|
||||
- /api/v2/dashboards/{dashboardID}/labels/{labelID}
|
||||
- /api/v2/dashboards/{dashboardID}/members
|
||||
- /api/v2/dashboards/{dashboardID}/members/{userID}
|
||||
- /api/v2/dashboards/{dashboardID}/owners
|
||||
- /api/v2/dashboards/{dashboardID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/dashboards
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- dashboards
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-dashboards.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-dashboards.yaml
|
||||
- path: api/v2/dbrps
|
||||
fields:
|
||||
name: /api/v2/dbrps
|
||||
describes:
|
||||
- /api/v2/dbrps
|
||||
- /api/v2/dbrps/{dbrpID}
|
||||
title: |-
|
||||
/api/v2/dbrps
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- dbrps
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-dbrps.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-dbrps.yaml
|
||||
- path: api/v2/delete
|
||||
fields:
|
||||
name: /api/v2/delete
|
||||
describes:
|
||||
- /api/v2/delete
|
||||
title: |-
|
||||
/api/v2/delete
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- delete
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-delete.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-delete.yaml
|
||||
- path: api/v2/flags
|
||||
fields:
|
||||
name: /api/v2/flags
|
||||
describes:
|
||||
- /api/v2/flags
|
||||
title: |-
|
||||
/api/v2/flags
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- flags
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-flags.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-flags.yaml
|
||||
- path: api/v2/labels
|
||||
fields:
|
||||
name: /api/v2/labels
|
||||
describes:
|
||||
- /api/v2/labels
|
||||
- /api/v2/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/labels
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- labels
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-labels.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-labels.yaml
|
||||
- path: api/v2/maps
|
||||
fields:
|
||||
name: /api/v2/maps
|
||||
describes:
|
||||
- /api/v2/maps/mapToken
|
||||
title: |-
|
||||
/api/v2/maps
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- maps
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-maps.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-maps.yaml
|
||||
- path: api/v2/me
|
||||
fields:
|
||||
name: /api/v2/me
|
||||
describes:
|
||||
- /api/v2/me
|
||||
- /api/v2/me/password
|
||||
title: |-
|
||||
/api/v2/me
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- me
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-me.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-me.yaml
|
||||
- path: api/v2/notificationEndpoints
|
||||
fields:
|
||||
name: /api/v2/notificationEndpoints
|
||||
describes:
|
||||
- /api/v2/notificationEndpoints
|
||||
- /api/v2/notificationEndpoints/{endpointID}
|
||||
- /api/v2/notificationEndpoints/{endpointID}/labels
|
||||
- /api/v2/notificationEndpoints/{endpointID}/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/notificationEndpoints
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- notificationEndpoints
|
||||
source: >-
|
||||
static/openapi/influxdb-oss-v2/paths/ref-api-v2-notificationEndpoints.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-notificationEndpoints.yaml
|
||||
- path: api/v2/notificationRules
|
||||
fields:
|
||||
name: /api/v2/notificationRules
|
||||
describes:
|
||||
- /api/v2/notificationRules
|
||||
- /api/v2/notificationRules/{ruleID}
|
||||
- /api/v2/notificationRules/{ruleID}/labels
|
||||
- /api/v2/notificationRules/{ruleID}/labels/{labelID}
|
||||
- /api/v2/notificationRules/{ruleID}/query
|
||||
title: |-
|
||||
/api/v2/notificationRules
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- notificationRules
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-notificationRules.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-notificationRules.yaml
|
||||
- path: api/v2/orgs
|
||||
fields:
|
||||
name: /api/v2/orgs
|
||||
describes:
|
||||
- /api/v2/orgs
|
||||
- /api/v2/orgs/{orgID}
|
||||
- /api/v2/orgs/{orgID}/members
|
||||
- /api/v2/orgs/{orgID}/members/{userID}
|
||||
- /api/v2/orgs/{orgID}/owners
|
||||
- /api/v2/orgs/{orgID}/owners/{userID}
|
||||
- /api/v2/orgs/{orgID}/secrets
|
||||
- /api/v2/orgs/{orgID}/secrets/delete
|
||||
- /api/v2/orgs/{orgID}/secrets/{secretID}
|
||||
title: |-
|
||||
/api/v2/orgs
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- orgs
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-orgs.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-orgs.yaml
|
||||
- path: api/v2/query
|
||||
fields:
|
||||
name: /api/v2/query
|
||||
describes:
|
||||
- /api/v2/query
|
||||
- /api/v2/query/analyze
|
||||
- /api/v2/query/ast
|
||||
- /api/v2/query/suggestions
|
||||
- /api/v2/query/suggestions/{name}
|
||||
title: |-
|
||||
/api/v2/query
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- query
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-query.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-query.yaml
|
||||
- path: api/v2/remotes
|
||||
fields:
|
||||
name: /api/v2/remotes
|
||||
describes:
|
||||
- /api/v2/remotes
|
||||
- /api/v2/remotes/{remoteID}
|
||||
title: |-
|
||||
/api/v2/remotes
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- remotes
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-remotes.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-remotes.yaml
|
||||
- path: api/v2/replications
|
||||
fields:
|
||||
name: /api/v2/replications
|
||||
describes:
|
||||
- /api/v2/replications
|
||||
- /api/v2/replications/{replicationID}
|
||||
- /api/v2/replications/{replicationID}/validate
|
||||
title: |-
|
||||
/api/v2/replications
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- replications
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-replications.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-replications.yaml
|
||||
- path: api/v2/resources
|
||||
fields:
|
||||
name: /api/v2/resources
|
||||
describes:
|
||||
- /api/v2/resources
|
||||
title: |-
|
||||
/api/v2/resources
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- resources
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-resources.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-resources.yaml
|
||||
- path: api/v2/restore
|
||||
fields:
|
||||
name: /api/v2/restore
|
||||
describes:
|
||||
- /api/v2/restore/bucket/{bucketID}
|
||||
- /api/v2/restore/bucketMetadata
|
||||
- /api/v2/restore/kv
|
||||
- /api/v2/restore/shards/{shardID}
|
||||
- /api/v2/restore/sql
|
||||
title: |-
|
||||
/api/v2/restore
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- restore
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-restore.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-restore.yaml
|
||||
- path: api/v2/scrapers
|
||||
fields:
|
||||
name: /api/v2/scrapers
|
||||
describes:
|
||||
- /api/v2/scrapers
|
||||
- /api/v2/scrapers/{scraperTargetID}
|
||||
- /api/v2/scrapers/{scraperTargetID}/labels
|
||||
- /api/v2/scrapers/{scraperTargetID}/labels/{labelID}
|
||||
- /api/v2/scrapers/{scraperTargetID}/members
|
||||
- /api/v2/scrapers/{scraperTargetID}/members/{userID}
|
||||
- /api/v2/scrapers/{scraperTargetID}/owners
|
||||
- /api/v2/scrapers/{scraperTargetID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/scrapers
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- scrapers
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-scrapers.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-scrapers.yaml
|
||||
- path: api/v2/setup
|
||||
fields:
|
||||
name: /api/v2/setup
|
||||
describes:
|
||||
- /api/v2/setup
|
||||
title: |-
|
||||
/api/v2/setup
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- setup
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-setup.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-setup.yaml
|
||||
- path: api/v2/signin
|
||||
fields:
|
||||
name: /api/v2/signin
|
||||
describes:
|
||||
- /api/v2/signin
|
||||
title: |-
|
||||
/api/v2/signin
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- signin
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-signin.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-signin.yaml
|
||||
- path: api/v2/signout
|
||||
fields:
|
||||
name: /api/v2/signout
|
||||
describes:
|
||||
- /api/v2/signout
|
||||
title: |-
|
||||
/api/v2/signout
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- signout
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-signout.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-signout.yaml
|
||||
- path: api/v2/sources
|
||||
fields:
|
||||
name: /api/v2/sources
|
||||
describes:
|
||||
- /api/v2/sources
|
||||
- /api/v2/sources/{sourceID}
|
||||
- /api/v2/sources/{sourceID}/buckets
|
||||
- /api/v2/sources/{sourceID}/health
|
||||
title: |-
|
||||
/api/v2/sources
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- sources
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-sources.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-sources.yaml
|
||||
- path: api/v2/stacks
|
||||
fields:
|
||||
name: /api/v2/stacks
|
||||
describes:
|
||||
- /api/v2/stacks
|
||||
- /api/v2/stacks/{stack_id}
|
||||
- /api/v2/stacks/{stack_id}/uninstall
|
||||
title: |-
|
||||
/api/v2/stacks
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- stacks
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-stacks.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-stacks.yaml
|
||||
- path: api/v2/tasks
|
||||
fields:
|
||||
name: /api/v2/tasks
|
||||
describes:
|
||||
- /api/v2/tasks
|
||||
- /api/v2/tasks/{taskID}
|
||||
- /api/v2/tasks/{taskID}/labels
|
||||
- /api/v2/tasks/{taskID}/labels/{labelID}
|
||||
- /api/v2/tasks/{taskID}/logs
|
||||
- /api/v2/tasks/{taskID}/members
|
||||
- /api/v2/tasks/{taskID}/members/{userID}
|
||||
- /api/v2/tasks/{taskID}/owners
|
||||
- /api/v2/tasks/{taskID}/owners/{userID}
|
||||
- /api/v2/tasks/{taskID}/runs
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}/logs
|
||||
- /api/v2/tasks/{taskID}/runs/{runID}/retry
|
||||
title: |-
|
||||
/api/v2/tasks
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- tasks
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-tasks.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-tasks.yaml
|
||||
- path: api/v2/telegraf
|
||||
fields:
|
||||
name: /api/v2/telegraf
|
||||
describes:
|
||||
- /api/v2/telegraf/plugins
|
||||
title: |-
|
||||
/api/v2/telegraf
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- telegraf
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-telegraf.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-telegraf.yaml
|
||||
- path: api/v2/telegrafs
|
||||
fields:
|
||||
name: /api/v2/telegrafs
|
||||
describes:
|
||||
- /api/v2/telegrafs
|
||||
- /api/v2/telegrafs/{telegrafID}
|
||||
- /api/v2/telegrafs/{telegrafID}/labels
|
||||
- /api/v2/telegrafs/{telegrafID}/labels/{labelID}
|
||||
- /api/v2/telegrafs/{telegrafID}/members
|
||||
- /api/v2/telegrafs/{telegrafID}/members/{userID}
|
||||
- /api/v2/telegrafs/{telegrafID}/owners
|
||||
- /api/v2/telegrafs/{telegrafID}/owners/{userID}
|
||||
title: |-
|
||||
/api/v2/telegrafs
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- telegrafs
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-telegrafs.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-telegrafs.yaml
|
||||
- path: api/v2/templates
|
||||
fields:
|
||||
name: /api/v2/templates
|
||||
describes:
|
||||
- /api/v2/templates/apply
|
||||
- /api/v2/templates/export
|
||||
title: |-
|
||||
/api/v2/templates
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- templates
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-templates.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-templates.yaml
|
||||
- path: api/v2/users
|
||||
fields:
|
||||
name: /api/v2/users
|
||||
describes:
|
||||
- /api/v2/users
|
||||
- /api/v2/users/{userID}
|
||||
- /api/v2/users/{userID}/password
|
||||
title: |-
|
||||
/api/v2/users
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- users
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-users.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-users.yaml
|
||||
- path: api/v2/variables
|
||||
fields:
|
||||
name: /api/v2/variables
|
||||
describes:
|
||||
- /api/v2/variables
|
||||
- /api/v2/variables/{variableID}
|
||||
- /api/v2/variables/{variableID}/labels
|
||||
- /api/v2/variables/{variableID}/labels/{labelID}
|
||||
title: |-
|
||||
/api/v2/variables
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- variables
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-variables.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-variables.yaml
|
||||
- path: api/v2/write
|
||||
fields:
|
||||
name: /api/v2/write
|
||||
describes:
|
||||
- /api/v2/write
|
||||
title: |-
|
||||
/api/v2/write
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api-v2
|
||||
- write
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2-write.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2-write.yaml
|
||||
- path: api/v2
|
||||
fields:
|
||||
name: /api/v2
|
||||
describes:
|
||||
- /api/v2
|
||||
title: |-
|
||||
/api/v2
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- api
|
||||
- v2
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-api-v2.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-api-v2.yaml
|
||||
- path: debug/pprof/all
|
||||
fields:
|
||||
name: /debug/pprof/all
|
||||
describes:
|
||||
- /debug/pprof/all
|
||||
title: |-
|
||||
/debug/pprof/all
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- all
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-all.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-all.yaml
|
||||
- path: debug/pprof/allocs
|
||||
fields:
|
||||
name: /debug/pprof/allocs
|
||||
describes:
|
||||
- /debug/pprof/allocs
|
||||
title: |-
|
||||
/debug/pprof/allocs
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- allocs
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-allocs.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-allocs.yaml
|
||||
- path: debug/pprof/block
|
||||
fields:
|
||||
name: /debug/pprof/block
|
||||
describes:
|
||||
- /debug/pprof/block
|
||||
title: |-
|
||||
/debug/pprof/block
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- block
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-block.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-block.yaml
|
||||
- path: debug/pprof/cmdline
|
||||
fields:
|
||||
name: /debug/pprof/cmdline
|
||||
describes:
|
||||
- /debug/pprof/cmdline
|
||||
title: |-
|
||||
/debug/pprof/cmdline
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- cmdline
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-cmdline.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-cmdline.yaml
|
||||
- path: debug/pprof/goroutine
|
||||
fields:
|
||||
name: /debug/pprof/goroutine
|
||||
describes:
|
||||
- /debug/pprof/goroutine
|
||||
title: |-
|
||||
/debug/pprof/goroutine
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- goroutine
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-goroutine.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-goroutine.yaml
|
||||
- path: debug/pprof/heap
|
||||
fields:
|
||||
name: /debug/pprof/heap
|
||||
describes:
|
||||
- /debug/pprof/heap
|
||||
title: |-
|
||||
/debug/pprof/heap
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- heap
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-heap.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-heap.yaml
|
||||
- path: debug/pprof/mutex
|
||||
fields:
|
||||
name: /debug/pprof/mutex
|
||||
describes:
|
||||
- /debug/pprof/mutex
|
||||
title: |-
|
||||
/debug/pprof/mutex
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- mutex
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-mutex.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-mutex.yaml
|
||||
- path: debug/pprof/profile
|
||||
fields:
|
||||
name: /debug/pprof/profile
|
||||
describes:
|
||||
- /debug/pprof/profile
|
||||
title: |-
|
||||
/debug/pprof/profile
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- profile
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-profile.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-profile.yaml
|
||||
- path: debug/pprof/threadcreate
|
||||
fields:
|
||||
name: /debug/pprof/threadcreate
|
||||
describes:
|
||||
- /debug/pprof/threadcreate
|
||||
title: |-
|
||||
/debug/pprof/threadcreate
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- threadcreate
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-threadcreate.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-threadcreate.yaml
|
||||
- path: debug/pprof/trace
|
||||
fields:
|
||||
name: /debug/pprof/trace
|
||||
describes:
|
||||
- /debug/pprof/trace
|
||||
title: |-
|
||||
/debug/pprof/trace
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- debug-pprof
|
||||
- trace
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-debug-pprof-trace.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-debug-pprof-trace.yaml
|
||||
- path: health
|
||||
fields:
|
||||
name: /health
|
||||
describes:
|
||||
- /health
|
||||
title: |-
|
||||
/health
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- health
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-health.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-health.yaml
|
||||
- path: legacy/authorizations
|
||||
fields:
|
||||
name: /legacy/authorizations
|
||||
describes:
|
||||
- /legacy/authorizations
|
||||
- /legacy/authorizations/{authID}
|
||||
- /legacy/authorizations/{authID}/password
|
||||
title: |-
|
||||
/legacy/authorizations
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- legacy
|
||||
- authorizations
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-legacy-authorizations.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-legacy-authorizations.yaml
|
||||
- path: metrics
|
||||
fields:
|
||||
name: /metrics
|
||||
describes:
|
||||
- /metrics
|
||||
title: |-
|
||||
/metrics
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- metrics
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-metrics.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-metrics.yaml
|
||||
- path: ping
|
||||
fields:
|
||||
name: /ping
|
||||
describes:
|
||||
- /ping
|
||||
title: |-
|
||||
/ping
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- ping
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-ping.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-ping.yaml
|
||||
- path: query
|
||||
fields:
|
||||
name: /query
|
||||
describes:
|
||||
- /query
|
||||
title: |-
|
||||
/query
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- query
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-query.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-query.yaml
|
||||
- path: ready
|
||||
fields:
|
||||
name: /ready
|
||||
describes:
|
||||
- /ready
|
||||
title: |-
|
||||
/ready
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- ready
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-ready.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-ready.yaml
|
||||
- path: write
|
||||
fields:
|
||||
name: /write
|
||||
describes:
|
||||
- /write
|
||||
title: |-
|
||||
/write
|
||||
InfluxDB OSS API Service
|
||||
tags:
|
||||
- ''
|
||||
- write
|
||||
source: static/openapi/influxdb-oss-v2/paths/ref-write.yaml
|
||||
staticFilePath: /openapi/influxdb-oss-v2/paths/ref-write.yaml
|
||||
|
|
@ -0,0 +1,244 @@
|
|||
{{/*
|
||||
API Reference Navigation for Sidebar
|
||||
|
||||
Displays a collapsible navigation tree for API endpoints,
|
||||
organized by functional groups defined in data/api_nav_groups.yml.
|
||||
|
||||
Uses Hugo data from data/article-data/ to build navigation.
|
||||
Supports both tag-based (new) and path-based (legacy) article data.
|
||||
*/}}
|
||||
|
||||
{{/* Get product path data for data lookup */}}
|
||||
{{ $productPathData := findRE "[^/]+.*?" .RelPermalink }}
|
||||
{{ $product := index $productPathData 0 }}
|
||||
{{ $version := index $productPathData 1 }}
|
||||
|
||||
{{/* Build data key for article data lookup */}}
|
||||
{{/* Hugo converts hyphens to underscores in data file keys */}}
|
||||
{{ $dataKey := "" }}
|
||||
{{ if eq $product "influxdb3" }}
|
||||
{{ $dataKey = print "influxdb3_" $version }}
|
||||
{{ else if eq $product "influxdb" }}
|
||||
{{ $dataKey = print $version }}
|
||||
{{ else }}
|
||||
{{ $dataKey = $product }}
|
||||
{{ end }}
|
||||
|
||||
{{/* Get article data for this product */}}
|
||||
{{/*
|
||||
Hugo data path: data/article_data/influxdb/influxdb3_core/articles.yml
|
||||
Access: .Site.Data.article_data.influxdb.influxdb3_core.articles.articles
|
||||
|
||||
The double "articles" is because:
|
||||
- First "articles" is the filename (articles.yml)
|
||||
- Second "articles" is the key inside the YAML file
|
||||
*/}}
|
||||
{{ $articles := slice }}
|
||||
{{ with .Site.Data.article_data }}
|
||||
{{ with index . "influxdb" }}
|
||||
{{ with index . $dataKey }}
|
||||
{{ with index . "articles" }}
|
||||
{{ with index . "articles" }}
|
||||
{{ $articles = . }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{/* Get navigation groups configuration */}}
|
||||
{{ $navGroups := .Site.Data.api_nav_groups.groups }}
|
||||
|
||||
{{/* Check if articles use tag-based structure */}}
|
||||
{{ $isTagBased := false }}
|
||||
{{ if gt (len $articles) 0 }}
|
||||
{{ $firstArticle := index $articles 0 }}
|
||||
{{ if reflect.IsMap $firstArticle }}
|
||||
{{ with index $firstArticle "fields" }}
|
||||
{{ if reflect.IsMap . }}
|
||||
{{ if isset . "tag" }}
|
||||
{{ $isTagBased = true }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{ if and (gt (len $articles) 0) $navGroups $isTagBased }}
|
||||
{{/* Tag-based navigation */}}
|
||||
<nav class="api-nav" data-component="api-nav">
|
||||
<h4 class="api-nav-header">API Reference</h4>
|
||||
|
||||
{{/* Build a map of tag slug -> article for quick lookup */}}
|
||||
{{ $articlesByTag := dict }}
|
||||
{{ range $articles }}
|
||||
{{ if and (reflect.IsMap .) (isset . "fields") }}
|
||||
{{ $fields := index . "fields" }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "tag") }}
|
||||
{{ $tag := index $fields "tag" }}
|
||||
{{ $articlesByTag = merge $articlesByTag (dict $tag .) }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{/* Render navigation groups */}}
|
||||
{{ range $groupIdx, $group := $navGroups }}
|
||||
{{ $groupTags := $group.tags }}
|
||||
{{ $groupHasArticles := false }}
|
||||
|
||||
{{/* Check if any tags in this group have articles */}}
|
||||
{{ range $groupTags }}
|
||||
{{ if index $articlesByTag . }}
|
||||
{{ $groupHasArticles = true }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{ if $groupHasArticles }}
|
||||
<div class="api-nav-group">
|
||||
<button class="api-nav-group-header{{ if eq $groupIdx 0 }} is-open{{ end }}" aria-expanded="{{ if eq $groupIdx 0 }}true{{ else }}false{{ end }}">
|
||||
{{ $group.name }}
|
||||
</button>
|
||||
<ul class="api-nav-group-items{{ if eq $groupIdx 0 }} is-open{{ end }}">
|
||||
{{ range $groupTags }}
|
||||
{{ $tagName := . }}
|
||||
{{ $article := index $articlesByTag $tagName }}
|
||||
{{ if $article }}
|
||||
{{ $path := index $article "path" }}
|
||||
{{ $fields := index $article "fields" }}
|
||||
{{ $menuName := $tagName }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "menuName") }}
|
||||
{{ $menuName = index $fields "menuName" }}
|
||||
{{ end }}
|
||||
{{ $isConceptual := false }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "isConceptual") }}
|
||||
{{ $isConceptual = index $fields "isConceptual" }}
|
||||
{{ end }}
|
||||
<li class="api-nav-item{{ if eq $.RelPermalink (print "/" $product "/" $version "/" $path "/") }} is-active{{ end }}{{ if $isConceptual }} is-conceptual{{ end }}">
|
||||
<a href="{{ print "/" $product "/" $version "/" $path "/" | relURL }}">
|
||||
{{ $menuName }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
</nav>
|
||||
{{ else if gt (len $articles) 0 }}
|
||||
{{/* Legacy path-based navigation (fallback) */}}
|
||||
<nav class="api-nav" data-component="api-nav">
|
||||
<h4 class="api-nav-header">API Reference</h4>
|
||||
|
||||
{{/* Group by API version (v3, v2, v1, or root) */}}
|
||||
{{ $v3Endpoints := slice }}
|
||||
{{ $v2Endpoints := slice }}
|
||||
{{ $v1Endpoints := slice }}
|
||||
{{ $rootEndpoints := slice }}
|
||||
|
||||
{{ range $idx, $article := $articles }}
|
||||
{{ $articlePath := "" }}
|
||||
{{ if and (reflect.IsMap $article) (isset $article "path") }}
|
||||
{{ $articlePath = index $article "path" }}
|
||||
{{ end }}
|
||||
{{ if $articlePath }}
|
||||
{{ if hasPrefix $articlePath "api/v3" }}
|
||||
{{ $v3Endpoints = $v3Endpoints | append $article }}
|
||||
{{ else if hasPrefix $articlePath "api/v2" }}
|
||||
{{ $v2Endpoints = $v2Endpoints | append $article }}
|
||||
{{ else if hasPrefix $articlePath "api/v1" }}
|
||||
{{ $v1Endpoints = $v1Endpoints | append $article }}
|
||||
{{ else }}
|
||||
{{ $rootEndpoints = $rootEndpoints | append $article }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
|
||||
{{/* API v3 Endpoints */}}
|
||||
{{ if gt (len $v3Endpoints) 0 }}
|
||||
<div class="api-nav-group">
|
||||
<button class="api-nav-group-header is-open" aria-expanded="true">
|
||||
API v3
|
||||
</button>
|
||||
<ul class="api-nav-group-items is-open">
|
||||
{{ range $v3Endpoints }}
|
||||
{{ $path := index . "path" }}
|
||||
{{ $menuName := $path }}
|
||||
{{ if and (reflect.IsMap .) (isset . "fields") }}
|
||||
{{ $fields := index . "fields" }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "menuName") }}
|
||||
{{ $menuName = index $fields "menuName" }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
<li class="api-nav-item{{ if eq $.RelPermalink (print "/" $product "/" $version "/" $path "/") }} is-active{{ end }}">
|
||||
<a href="{{ print "/" $product "/" $version "/" $path "/" | relURL }}">
|
||||
{{ $menuName }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
{{/* Server Management (root endpoints like /health, /metrics, /ping) */}}
|
||||
{{ if gt (len $rootEndpoints) 0 }}
|
||||
<div class="api-nav-group">
|
||||
<button class="api-nav-group-header" aria-expanded="false">
|
||||
Server Management
|
||||
</button>
|
||||
<ul class="api-nav-group-items">
|
||||
{{ range $rootEndpoints }}
|
||||
{{ $path := index . "path" }}
|
||||
{{ $menuName := $path }}
|
||||
{{ if and (reflect.IsMap .) (isset . "fields") }}
|
||||
{{ $fields := index . "fields" }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "menuName") }}
|
||||
{{ $menuName = index $fields "menuName" }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
<li class="api-nav-item{{ if eq $.RelPermalink (print "/" $product "/" $version "/" $path "/") }} is-active{{ end }}">
|
||||
<a href="{{ print "/" $product "/" $version "/" $path "/" | relURL }}">
|
||||
{{ $menuName }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
{{/* Compatibility Endpoints (v1, v2) */}}
|
||||
{{ $compatEndpoints := slice }}
|
||||
{{ range $v1Endpoints }}
|
||||
{{ $compatEndpoints = $compatEndpoints | append . }}
|
||||
{{ end }}
|
||||
{{ range $v2Endpoints }}
|
||||
{{ $compatEndpoints = $compatEndpoints | append . }}
|
||||
{{ end }}
|
||||
{{ if gt (len $compatEndpoints) 0 }}
|
||||
<div class="api-nav-group">
|
||||
<button class="api-nav-group-header" aria-expanded="false">
|
||||
Compatibility
|
||||
</button>
|
||||
<ul class="api-nav-group-items">
|
||||
{{ range $compatEndpoints }}
|
||||
{{ $path := index . "path" }}
|
||||
{{ $menuName := $path }}
|
||||
{{ if and (reflect.IsMap .) (isset . "fields") }}
|
||||
{{ $fields := index . "fields" }}
|
||||
{{ if and (reflect.IsMap $fields) (isset $fields "menuName") }}
|
||||
{{ $menuName = index $fields "menuName" }}
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
<li class="api-nav-item{{ if eq $.RelPermalink (print "/" $product "/" $version "/" $path "/") }} is-active{{ end }}">
|
||||
<a href="{{ print "/" $product "/" $version "/" $path "/" | relURL }}">
|
||||
{{ $menuName }}
|
||||
</a>
|
||||
</li>
|
||||
{{ end }}
|
||||
</ul>
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
</nav>
|
||||
{{ end }}
|
||||
Loading…
Reference in New Issue