From 3beca454ae0a21572224a2d7bed9dd5c7d8e8fe6 Mon Sep 17 00:00:00 2001 From: Peter Barnett Date: Tue, 14 Jan 2025 21:27:41 -0500 Subject: [PATCH 1/2] fix: updating API write endpoint --- content/shared/v3-core-get-started/_index.md | 10 +++++----- content/shared/v3-enterprise-get-started/_index.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md index 078b1249a2..baaab5b1b8 100644 --- a/content/shared/v3-core-get-started/_index.md +++ b/content/shared/v3-core-get-started/_index.md @@ -158,17 +158,17 @@ This means that individual write requests may not complete quickly, but you can The database has three write API endpoints that respond to HTTP `POST` requests: -* `/write?db=mydb,precision=ns` -* `/api/v2/write?db=mydb,precision=ns` -* `/api/v3/write?db=mydb,precision=ns` +* `/write_lp?db=mydb,precision=ns` +* `/api/v2/write_lp?db=mydb,precision=ns` +* `/api/v3/write_lp?db=mydb,precision=ns` -{{% product-name %}} provides the `/write` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +{{% product-name %}} provides the `/write_lp` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. However, these APIs differ from the APIs in the previous versions in the following ways: - Tags in a table (measurement) are _immutable_ - A tag and a field can't have the same name within a table. -The `/api/v3/write` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). +The `/api/v3/write_lp` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). The following code block is an example of [line protocol](/influxdb3/core/reference/syntax/line-protocol/), which shows the table name followed by tags, which are an ordered, comma-separated list of key/value pairs where the values are strings, followed by a comma-separated list of key/value pairs that are the fields, and ending with an optional timestamp. The timestamp by default is a nanosecond epoch, but you can specify a different precision through the `precision` query parameter. diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md index e69cf375e7..381d62aa30 100644 --- a/content/shared/v3-enterprise-get-started/_index.md +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -156,17 +156,17 @@ This means that individual write requests may not complete quickly, but you can The database has three write API endpoints that respond to HTTP `POST` requests: -* `/write?db=mydb,precision=ns` -* `/api/v2/write?db=mydb,precision=ns` -* `/api/v3/write?db=mydb,precision=ns` +* `/write_lp?db=mydb,precision=ns` +* `/api/v2/write_lp?db=mydb,precision=ns` +* `/api/v3/write_lp?db=mydb,precision=ns` -{{% product-name %}} provides the `/write` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +{{% product-name %}} provides the `/write_lp` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. However, these APIs differ from the APIs in the previous versions in the following ways: - Tags in a table (measurement) are _immutable_ - A tag and a field can't have the same name within a table. -The `/api/v3/write` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). +The `/api/v3/write_lp` endpoint accepts the same line protocol syntax as previous versions, and brings new functionality that lets you accept or reject partial writes using the `accept_partial` parameter (`true` is default). The following code block is an example of [line protocol](/influxdb3/enterprise/reference/syntax/line-protocol/), which shows the table name followed by tags, which are an ordered, comma-separated list of key/value pairs where the values are strings, followed by a comma-separated list of key/value pairs that are the fields, and ending with an optional timestamp. The timestamp by default is a nanosecond epoch, but you can specify a different precision through the `precision` query parameter. From d242c25e1c606c9f1af9e74d1c6215c65f4bbc5f Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Thu, 16 Jan 2025 14:01:04 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Jason Stirnaman --- content/shared/v3-core-get-started/_index.md | 6 +++--- content/shared/v3-enterprise-get-started/_index.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md index 0333c3a867..196e4fbb62 100644 --- a/content/shared/v3-core-get-started/_index.md +++ b/content/shared/v3-core-get-started/_index.md @@ -158,11 +158,11 @@ This means that individual write requests may not complete quickly, but you can The database has three write API endpoints that respond to HTTP `POST` requests: -* `/write_lp?db=mydb,precision=ns` -* `/api/v2/write_lp?db=mydb,precision=ns` +* `/write?db=mydb,precision=ns` +* `/api/v2/write?db=mydb,precision=ns` * `/api/v3/write_lp?db=mydb,precision=ns` -{{% product-name %}} provides the `/write_lp` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +{{% product-name %}} provides the `/write` and `/api/v2/write` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. However, these APIs differ from the APIs in the previous versions in the following ways: - Tags in a table (measurement) are _immutable_ diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md index 6b98c2a8d8..6a5d6bb013 100644 --- a/content/shared/v3-enterprise-get-started/_index.md +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -156,11 +156,11 @@ This means that individual write requests may not complete quickly, but you can The database has three write API endpoints that respond to HTTP `POST` requests: -* `/write_lp?db=mydb,precision=ns` -* `/api/v2/write_lp?db=mydb,precision=ns` +* `/write?db=mydb,precision=ns` +* `/api/v2/write?db=mydb,precision=ns` * `/api/v3/write_lp?db=mydb,precision=ns` -{{% product-name %}} provides the `/write_lp` and `/api/v2` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. +{{% product-name %}} provides the `/write` and `/api/v2/write` endpoints for backward compatibility with clients that can write data to previous versions of InfluxDB. However, these APIs differ from the APIs in the previous versions in the following ways: - Tags in a table (measurement) are _immutable_