Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: broken links and formatting, missing Management API ReDoc security section for auth types

pull/6076/head
Jason Stirnaman 2025-05-15 13:46:17 -05:00
parent 6f8707363d
commit 18b90035a4
11 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-docs/influxdb3/cloud-dedicated/management/openapi.yml
View File

@ -40,6 +40,7 @@ tags:
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
<!-- ReDoc-Inject: <security-definitions> -->
- name: Database tokens
description: Manage database read/write tokens for a cluster
- name: Databases

2
api-docs/influxdb3/core/v3/ref.yml
View File

@ -52,7 +52,7 @@ tags:
#### Related guides
- [Manage tokens](/influxdb3/core/admin/tokens/)
- [Authentication and authorization](/influxdb3/core/reference/authentication/)
- [Authentication and authorization](/influxdb3/core/reference/internals/authentication/)
x-traitTag: true
- name: Cache data
description: |

4
api-docs/influxdb3/enterprise/v3/ref.yml
View File

@ -52,7 +52,7 @@ tags:
#### Related guides
- [Manage tokens](/influxdb3/enterprise/admin/tokens/)
- [Authentication and authorization](/influxdb3/enterprise/reference/authentication/)
- [Authentication and authorization](/influxdb3/enterprise/reference/internals/authentication/)
x-traitTag: true
- name: Cache data
description: |
@ -1936,8 +1936,6 @@ components:
scheme: bearer
bearerFormat: JWT
description: |
_During Alpha release, an API token is not required._
A Bearer token for authentication.
Provide the scheme and the API token in the `Authorization` header--for example:

2
content/influxdb3/core/query-data/execute-queries/influxdb3-cli.md
View File

@ -13,7 +13,7 @@ related:
- /influxdb3/core/reference/cli/influxdb3/query/
- /influxdb3/core/reference/sql/
- /influxdb3/core/reference/influxql/
# - /influxdb3/core/get-started/query/#execute-an-sql-query, Get started querying data
# - /influxdb3/core/query-data/execute-queries/, Get started querying data
list_code_example: |
```sh
influxdb3 query \

2
content/influxdb3/enterprise/query-data/execute-queries/influxdb3-cli.md
View File

@ -13,7 +13,7 @@ related:
- /influxdb3/enterprise/reference/cli/influxdb3/query/
- /influxdb3/enterprise/reference/sql/
- /influxdb3/enterprise/reference/influxql/
# - /influxdb3/enterprise/get-started/query/#execute-an-sql-query, Get started querying data
# - /influxdb3/enterprise/query-data/execute-queries/, Get started querying data
list_code_example: |
```sh
influxdb3 query \

2
content/shared/influxdb-client-libraries-reference/flight/csharp-flight.md
View File

@ -8,5 +8,5 @@ For more information, see the [C# client example on GitHub](https://github.com/a
> We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/version/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code.
>
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.

2
content/shared/influxdb-client-libraries-reference/flight/go-flight.md
View File

@ -6,7 +6,7 @@
> We recommend using the [`influxdb3-go` Go client library](/influxdb3/version/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code.
>
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
## Flight SQL client

2
content/shared/influxdb-client-libraries-reference/flight/java-flightsql.md
View File

@ -6,7 +6,7 @@
> We recommend using the [`influxdb3-java` Java client library](/influxdb3/version/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code.
>
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
<!-- TOC -->

12
content/shared/influxdb-client-libraries-reference/flight/python-flight.md
View File

@ -6,21 +6,20 @@
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/version/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
>
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
The following examples show how to use the `pyarrow.flight` and `pandas` Python modules to query and format data stored in an {{% product-name %}} database:
{{% code-tabs-wrapper %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[SQL](#sql-python)
[InfluxQL](#influxql-python)
{{% /code-tabs %}}
{{% code-tab-content %}}
<!-- BEGIN SQL -->
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
```py
```python
# Using pyarrow>=12.0.0 FlightClient
from pyarrow.flight import FlightClient, Ticket, FlightCallOptions
import json
@ -62,7 +61,7 @@ print(data_frame.to_markdown())
{{% code-tab-content %}}
<!-- BEGIN INFLUXQL -->
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
```py
```python
# Using pyarrow>=12.0.0 FlightClient
from pyarrow.flight import FlightClient, Ticket, FlightCallOptions
import json
@ -97,6 +96,7 @@ print(data_frame.to_markdown())
{{% /code-placeholders %}}
<!-- END INFLUXQL -->
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
Replace the following:
@ -104,5 +104,3 @@ Replace the following:
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}:
a [database token](/influxdb3/version/admin/tokens/database/)
with sufficient permissions to the specified database
{{% /code-tabs-wrapper %}}

12
content/shared/influxdb-client-libraries-reference/flight/python-flightsql-dbapi.md
View File

@ -6,7 +6,7 @@ The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influ
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/version/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
>
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
## Installation
@ -32,7 +32,7 @@ from flightsql import FlightSQLClient
```
- `flightsql.FlightSQLClient` class: an interface for [initializing
a client](#initialization) and interacting with a Flight SQL server.
a client](#initialize-a-client) and interacting with a Flight SQL server.
## API reference
@ -41,11 +41,11 @@ a client](#initialization) and interacting with a Flight SQL server.
- [Initialize a client](#initialize-a-client)
- [Instance methods](#instance-methods)
- [FlightSQLClient.execute](#flightsqlclientexecute)
- [Syntax {#execute-query-syntax}](#syntax-execute-query-syntax)
- [Example {#execute-query-example}](#example-execute-query-example)
- [Syntax](#execute-query-syntax)
- [Example](#execute-query-example)
- [FlightSQLClient.do_get](#flightsqlclientdo_get)
- [Syntax {#retrieve-data-syntax}](#syntax-retrieve-data-syntax)
- [Example {#retrieve-data-example}](#example-retrieve-data-example)
- [Syntax](#retrieve-data-syntax)
- [Example](#retrieve-data-example)
## Class FlightSQLClient

2
content/shared/influxdb3-write-guides/troubleshoot.md
View File

@ -41,7 +41,7 @@ Write requests return the following status codes:
| :-------------------------------| :--------------------------------------------------------------- | :------------- |
| `204 "Success"` | | If InfluxDB ingested the data |
| `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections | If some or all request data isn't allowed (for example, if it is malformed or falls outside of the bucket's retention period)--the response body indicates whether a partial write has occurred or if all data has been rejected |
| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/version/admin/tokens/) doesn't have [permission](/influxdb3/version/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb) in write requests. |
| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/version/admin/tokens/) doesn't have [permission](/influxdb3/version/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/version/write-data/api-client-libraries/) in write requests. |
| `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found |
| `500 "Internal server error"` | | Default status for an error |
| `503` "Service unavailable" | | If the server is temporarily unavailable to accept writes. The `Retry-After` header describes when to try the write again.