From 0095133db2cd194f907e84b81dfd193388a4f60c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 13:52:55 +0000 Subject: [PATCH 1/2] Initial plan From 51df38ad8c7514ebf3fcc50094853587cbda2540 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 14:09:29 +0000 Subject: [PATCH 2/2] Add comprehensive introductory content to CLI and API reference pages Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --- .../influxdb3/core/reference/api/_index.md | 8 +++---- .../influxdb3/core/reference/cli/_index.md | 18 ++++++++++++++-- .../enterprise/reference/api/_index.md | 8 +++---- .../enterprise/reference/cli/_index.md | 18 ++++++++++++++-- .../shared/influxdb3-api-reference/_index.md | 21 ++++++++++++++----- 5 files changed, 56 insertions(+), 17 deletions(-) diff --git a/content/influxdb3/core/reference/api/_index.md b/content/influxdb3/core/reference/api/_index.md index 6a2200b1e5..3816956e5f 100644 --- a/content/influxdb3/core/reference/api/_index.md +++ b/content/influxdb3/core/reference/api/_index.md @@ -1,10 +1,10 @@ --- title: InfluxDB HTTP API description: > - The InfluxDB HTTP API for {{% product-name %}} provides a programmatic interface - for interactions with InfluxDB, - including writing, querying, and processing data, and managing an InfluxDB 3 - instance. + The InfluxDB HTTP API provides a comprehensive programmatic interface for all + interactions with InfluxDB 3 Core, including writing and querying time series data, + triggering Processing engine plugins, and managing your InfluxDB instance. + The API includes endpoints for backward compatibility with InfluxDB v1 and v2 workloads. menu: influxdb3_core: parent: Reference diff --git a/content/influxdb3/core/reference/cli/_index.md b/content/influxdb3/core/reference/cli/_index.md index 5487421a67..f98a8f656a 100644 --- a/content/influxdb3/core/reference/cli/_index.md +++ b/content/influxdb3/core/reference/cli/_index.md @@ -1,7 +1,10 @@ --- title: Command line tools description: > - View command line tools used to manage and interact with InfluxDB 3 Core. + InfluxDB 3 Core provides powerful command line tools for database + administration, data management, and system operations. These CLI tools enable + you to efficiently manage your InfluxDB instance, write and query data, and + perform administrative tasks from the command line. menu: influxdb3_core: name: CLIs @@ -9,6 +12,17 @@ menu: weight: 101 --- -View command line tools used to run, manage, and interact with InfluxDB 3 Core: +InfluxDB 3 Core provides powerful command line tools for database administration, data management, and system operations. +These CLI tools enable you to efficiently manage your InfluxDB instance, write and query data, and perform administrative tasks from the command line. + +The command line interface offers a streamlined way to: + +- Start and configure your InfluxDB 3 Core instance +- Create and manage databases and tables +- Write and query time series data +- Perform system administration tasks +- Automate database operations in scripts and workflows + +The following command line tools are available for InfluxDB 3 Core: {{< children >}} diff --git a/content/influxdb3/enterprise/reference/api/_index.md b/content/influxdb3/enterprise/reference/api/_index.md index ea78867f6d..a5b7ae5144 100644 --- a/content/influxdb3/enterprise/reference/api/_index.md +++ b/content/influxdb3/enterprise/reference/api/_index.md @@ -1,10 +1,10 @@ --- title: InfluxDB HTTP API description: > - The InfluxDB HTTP API for {{% product-name %}} provides a programmatic interface - for interactions with InfluxDB, - including writing, querying, and processing data, and managing an InfluxDB 3 - instance. + The InfluxDB HTTP API provides a comprehensive programmatic interface for all + interactions with InfluxDB 3 Enterprise, including writing and querying time series data, + triggering Processing engine plugins, and managing your InfluxDB instance. + The API includes endpoints for backward compatibility with InfluxDB v1 and v2 workloads. menu: influxdb3_enterprise: parent: Reference diff --git a/content/influxdb3/enterprise/reference/cli/_index.md b/content/influxdb3/enterprise/reference/cli/_index.md index dc8ff03fd9..147829cbec 100644 --- a/content/influxdb3/enterprise/reference/cli/_index.md +++ b/content/influxdb3/enterprise/reference/cli/_index.md @@ -1,7 +1,10 @@ --- title: Command line tools description: > - View command line tools used to manage and interact with InfluxDB 3 Enterprise. + InfluxDB 3 Enterprise provides powerful command line tools for database + administration, data management, and system operations. These CLI tools enable + you to efficiently manage your InfluxDB Enterprise instance, write and query data, + and perform administrative tasks from the command line. menu: influxdb3_enterprise: name: CLIs @@ -9,6 +12,17 @@ menu: weight: 101 --- -View command line tools used to run, manage, and interact with InfluxDB 3 Enterprise: +InfluxDB 3 Enterprise provides powerful command line tools for database administration, data management, and system operations. +These CLI tools enable you to efficiently manage your InfluxDB Enterprise instance, write and query data, and perform administrative tasks from the command line. + +The command line interface offers a streamlined way to: + +- Start and configure your InfluxDB 3 Enterprise instance +- Create and manage databases and tables +- Write and query time series data +- Perform system administration tasks +- Automate database operations in scripts and workflows + +The following command line tools are available for InfluxDB 3 Enterprise: {{< children >}} diff --git a/content/shared/influxdb3-api-reference/_index.md b/content/shared/influxdb3-api-reference/_index.md index 89495f21e0..2737c1ba04 100644 --- a/content/shared/influxdb3-api-reference/_index.md +++ b/content/shared/influxdb3-api-reference/_index.md @@ -1,7 +1,18 @@ -The InfluxDB HTTP API provides a programmatic interface for interactions with -{{% product-name %}}, such as writing and querying data, triggering Processing -engine plugins, and managing an InfluxDB 3 instance. -The API includes endpoints for backward compatibility with -InfluxDB v1 and v2 workloads, clients, and third-party tools. +The InfluxDB HTTP API provides a comprehensive programmatic interface for all interactions with +{{% product-name %}}, including writing and querying time series data, triggering Processing +engine plugins, and managing your InfluxDB 3 instance. + +The API is designed for flexibility and performance, offering multiple endpoints to accommodate +different use cases and client library requirements. +Whether you're building real-time monitoring applications, data analytics pipelines, or custom +integrations, the InfluxDB HTTP API provides the tools you need. + +The API includes endpoints for: + +- **Data operations**: Write time series data, execute SQL and InfluxQL queries +- **Database management**: Create and manage databases, tables, and schemas +- **Authentication and authorization**: Manage API tokens and access controls +- **System administration**: Monitor system health and performance metrics +- **Backward compatibility**: Support for InfluxDB v1 and v2 workloads, clients, and third-party tools {{% product-name %}} HTTP API