From bae9b0e1b0de24becd1d3425bc706437acd98379 Mon Sep 17 00:00:00 2001 From: Ben Tasker <88340935+btasker@users.noreply.github.com> Date: Tue, 3 Sep 2024 21:17:07 +0100 Subject: [PATCH] docs: correct description of status codes (#5587) * docs: correct description of status codes * Update api-docs/cloud-dedicated/v2/ref.yml Co-authored-by: Fraser Savage * Update api-docs/cloud-dedicated/v2/ref.yml Co-authored-by: Fraser Savage * Apply suggestions from code review Co-authored-by: Fraser Savage --------- Co-authored-by: Fraser Savage Co-authored-by: Scott Anderson --- api-docs/cloud-dedicated/v2/ref.yml | 5 ++--- api-docs/cloud-serverless/v2/ref.yml | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/api-docs/cloud-dedicated/v2/ref.yml b/api-docs/cloud-dedicated/v2/ref.yml index 590f58f0f..15dbd9307 100644 --- a/api-docs/cloud-dedicated/v2/ref.yml +++ b/api-docs/cloud-dedicated/v2/ref.yml @@ -229,9 +229,8 @@ paths: 2. If successful, attempts to [ingest data](/influxdb/cloud-dedicated/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-dedicated/write-data/troubleshoot/#review-http-status-codes). 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - `204 No Content`: all data in the batch is ingested - - `201 Created` (_If the cluster is configured to allow **partial writes**_): some points in the batch are ingested and queryable, and some points are rejected - - `400 Bad Request`: all data is rejected + - `204 No Content`: All data in the batch is ingested. + - `400 Bad Request`: Some (_when **partial writes** are configured for the cluster_) or all of the data has been rejected. Data that has not been rejected is ingested and queryable. The response body contains error details about [rejected points](/influxdb/cloud-dedicated/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points. diff --git a/api-docs/cloud-serverless/v2/ref.yml b/api-docs/cloud-serverless/v2/ref.yml index 06f602597..4c6c01654 100644 --- a/api-docs/cloud-serverless/v2/ref.yml +++ b/api-docs/cloud-serverless/v2/ref.yml @@ -7491,9 +7491,8 @@ paths: 2. If successful, attempts to [ingest data](/influxdb/cloud-serverless/reference/internals/durability/#data-ingest) from the request body; otherwise, responds with an [error status](/influxdb/cloud-serverless/write-data/troubleshoot/#review-http-status-codes). 3. Ingests or rejects data in the batch and returns one of the following HTTP status codes: - - `204 No Content`: all data in the batch is ingested - - `201 Created`: some points in the batch are ingested and queryable, and some points are rejected - - `400 Bad Request`: all data is rejected + - `204 No Content`: All data in the batch is ingested. + - `400 Bad Request`: Data from the batch was rejected and not written. The response body indicates if a partial write occurred. The response body contains error details about [rejected points](/influxdb/cloud-serverless/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.