Merge branch 'master' into patch-1

Author: jstirnaman

.circleci/config.yml

@@ -31,10 +31,10 @@ jobs:
           command: cd api-docs && bash generate-api-docs.sh      
       - run:
           name: Inject Flux stdlib frontmatter
-          command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.js
+          command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.cjs
       - run:
           name: Update Flux/InfluxDB versions
-          command: node ./flux-build-scripts/update-flux-versions.js
+          command: node ./flux-build-scripts/update-flux-versions.cjs
       - save_cache:
           key: install-{{ .Environment.CACHE_VERSION }}-{{ checksum ".circleci/config.yml" }}
           paths:

.gitignore

@@ -16,6 +16,8 @@ node_modules
 !telegraf-build/scripts
 !telegraf-build/README.md
 /cypress/screenshots/*
+/cypress/videos/*
+test-results.xml
 /influxdb3cli-build-scripts/content
 .vscode/*
 .idea

.husky/_/serve

@@ -0,0 +1,57 @@
+#!/bin/sh
+
+if [ "$LEFTHOOK_VERBOSE" = "1" -o "$LEFTHOOK_VERBOSE" = "true" ]; then
+  set -x
+fi
+
+if [ "$LEFTHOOK" = "0" ]; then
+  exit 0
+fi
+
+call_lefthook()
+{
+  if test -n "$LEFTHOOK_BIN"
+  then
+    "$LEFTHOOK_BIN" "$@"
+  elif lefthook -h >/dev/null 2>&1
+  then
+    lefthook "$@"
+  else
+    dir="$(git rev-parse --show-toplevel)"
+    osArch=$(uname | tr '[:upper:]' '[:lower:]')
+    cpuArch=$(uname -m | sed 's/aarch64/arm64/;s/x86_64/x64/')
+    if test -f "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook"
+    then
+      "$dir/node_modules/lefthook-${osArch}-${cpuArch}/bin/lefthook" "$@"
+    elif test -f "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook"
+    then
+      "$dir/node_modules/@evilmartians/lefthook/bin/lefthook-${osArch}-${cpuArch}/lefthook" "$@"
+    elif test -f "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook"
+    then
+      "$dir/node_modules/@evilmartians/lefthook-installer/bin/lefthook" "$@"
+    elif test -f "$dir/node_modules/lefthook/bin/index.js"
+    then
+      "$dir/node_modules/lefthook/bin/index.js" "$@"
+    
+    elif bundle exec lefthook -h >/dev/null 2>&1
+    then
+      bundle exec lefthook "$@"
+    elif yarn lefthook -h >/dev/null 2>&1
+    then
+      yarn lefthook "$@"
+    elif pnpm lefthook -h >/dev/null 2>&1
+    then
+      pnpm lefthook "$@"
+    elif swift package plugin lefthook >/dev/null 2>&1
+    then
+      swift package --disable-sandbox plugin lefthook "$@"
+    elif command -v mint >/dev/null 2>&1
+    then
+      mint run csjones/lefthook-plugin "$@"
+    else
+      echo "Can't find lefthook in PATH"
+    fi
+  fi
+}
+
+call_lefthook run "serve" "$@"

.nvmrc

@@ -0,0 +1 @@
+v23.10.0

CONTRIBUTING.md

@@ -28,8 +28,10 @@ For the linting and tests to run, you need to install Docker and Node.js
 dependencies.
 
 \_**Note:**
-We strongly recommend running linting and tests, but you can skip them
-(and avoid installing dependencies)
+The git pre-commit and pre-push hooks are configured to run linting and tests automatically
+when you commit or push changes.
+We strongly recommend letting them run, but you can skip them
+(and avoid installing related dependencies)
 by including the `--no-verify` flag with your commit--for example, enter the following command in your terminal:
 
 ```sh
@@ -51,7 +53,7 @@ dev dependencies used in pre-commit hooks for linting, syntax-checking, and test
 Dev dependencies include:
 
 - [Lefthook](https://github.com/evilmartians/lefthook): configures and
-manages pre-commit hooks for linting and testing Markdown content.
+manages git pre-commit and pre-push hooks for linting and testing Markdown content.
 - [prettier](https://prettier.io/docs/en/): formats code, including Markdown, according to style rules for consistency
 - [Cypress]: e2e testing for UI elements and URLs in content
 
@@ -93,9 +95,11 @@ Make your suggested changes being sure to follow the [style and formatting guide
 
 ## Lint and test your changes
 
+`package.json` contains scripts for running tests and linting.
+
 ### Automatic pre-commit checks
 
-docs-v2 uses Lefthook to manage Git hooks, such as pre-commit hooks that lint Markdown and test code blocks.
+docs-v2 uses Lefthook to manage Git hooks that run during pre-commit and pre-push. The hooks run the scripts defined in `package.json` to lint Markdown and test code blocks.
 When you try to commit changes (`git commit`), Git runs
 the commands configured in `lefthook.yml` which pass your **staged** files to Vale,
 Prettier, Cypress (for UI tests and link-checking), and Pytest (for testing Python and shell code in code blocks).

api-docs/.config.yml

@@ -1,5 +1,5 @@
 plugins:
-  - './../openapi/plugins/docs-plugin.js'
+  - './../openapi/plugins/docs-plugin.cjs'
 extends:
   - recommended
   - docs/all

api-docs/influxdb/cloud/.config.yml

@@ -1,5 +1,5 @@
 plugins:
-  - '../../openapi/plugins/docs-plugin.js'
+  - '../../openapi/plugins/docs-plugin.cjs'
 extends:
   - recommended
   - docs/all

api-docs/influxdb/v2/.config.yml

@@ -1,5 +1,5 @@
 plugins:
-  - '../../openapi/plugins/docs-plugin.js'
+  - '../../openapi/plugins/docs-plugin.cjs'
 extends:
   - recommended
   - docs/all

api-docs/influxdb/v2/v2/ref.yml

@@ -218,11 +218,11 @@ tags:
       |:-----------:|:------------------------ |:--------------------- |
       | `200`       | Success                  |                       |
       | `204`       | Success. No content      | InfluxDB doesn't return data for the request. |
-      | `400`       | Bad request              | May indicate one of the following: <ul><li>Line protocol is malformed. The response body contains the first malformed line in the data and indicates what was expected. For partial writes, the number of points written and the number of points rejected are also included. For more information, check the `rejected_points` measurement in your `_monitoring` bucket.</li><li>`Authorization` header is missing or malformed or the API token doesn't have permission for the operation.</li></ul> |
+      | `400`       | Bad request              | May indicate one of the following:<ul><li>the request body is malformed</li><li>`Authorization` header is missing or malformed</li><li>the API token doesn't have permission for the operation.</li></ul> |
       | `401`       | Unauthorized             | May indicate one of the following: <ul><li>`Authorization: Token` header is missing or malformed</li><li>API token value is missing from the header</li><li>API token doesn't have permission. For more information about token types and permissions, see [Manage API tokens](/influxdb/v2/security/tokens/)</li></ul> |
       | `404`       | Not found                | Requested resource was not found. `message` in the response body provides details about the requested resource. |
       | `413`       | Request entity too large | Request payload exceeds the size limit. |
-      | `422`       | Unprocessable entity     | Request data is invalid. `code` and `message` in the response body provide details about the problem. |
+      | `422`       | Unprocessable entity     | Request data is invalid. The request was well-formed, but couldn't complete due to semantic errors--for example, some or all points in a write request were rejected due to a schema or retention policy violation. The response body provides details about the problem. For more information about rejected points, see how to [Troubleshoot issues writing data](/influxdb/v2/write-data/troubleshoot/)|
       | `429`       | Too many requests        | API token is temporarily over the request quota. The `Retry-After` header describes when to try the request again. |
       | `500`       | Internal server error    |                       |
       | `503`       | Service unavailable      | Server is temporarily unavailable to process the request. The `Retry-After` header describes when to try the request again. |
@@ -12752,6 +12752,12 @@ paths:
 
              - Returns this error only if the [Go (golang) `ioutil.ReadAll()`](https://pkg.go.dev/io/ioutil#ReadAll) function raises an error.
              - Returns `Content-Type: application/json` for this error.
+        '422':
+          content:
+            application/json:
+              schema:
+               $ref: '#/components/schemas/Error' 
+          description: The request was well-formed, but some or all the points were rejected due to semantic errors--for example, schema conflicts or retention policy violations. Error message contains details for one or more rejected points.
         '429':
           description: |
             Too many requests.
@@ -13190,6 +13196,14 @@ paths:
         - Legacy Query
   /write:
     post:
+      description: |-
+        Writes line protocol to the specified bucket.
+
+        This endpoint provides backward compatibility for InfluxDB 1.x write workloads using tools such as InfluxDB 1.x client libraries, the Telegraf `outputs.influxdb` output plugin, or third-party tools.
+
+        Use this endpoint to send data in [line protocol](https://docs.influxdata.com/influxdb/v2/reference/syntax/line-protocol/) format to InfluxDB.
+        Use query parameters to specify options for writing data.
+
       operationId: PostLegacyWrite
       parameters:
         - $ref: '#/components/parameters/TraceSpan'
@@ -13263,6 +13277,12 @@ paths:
               schema:
                 $ref: '#/components/schemas/LineProtocolLengthError'
           description: Write has been rejected because the payload is too large. Error message returns max size supported. All data in body was rejected and not written.
+        '422':
+          content:
+            application/json:
+              schema:
+               $ref: '#/components/schemas/Error' 
+          description: The request was well-formed, but some or all the points were rejected due to semantic errors--for example, schema conflicts or retention policy violations. Error message contains details for one or more rejected points.
         '429':
           description: Token is temporarily over quota. The Retry-After header describes when to try the write again.
           headers:

api-docs/influxdb3/cloud-dedicated/.config.yml

@@ -1,5 +1,5 @@
 plugins:
-  - '../../openapi/plugins/docs-plugin.js'
+  - '../../openapi/plugins/docs-plugin.cjs'
 extends:
   - recommended
   - docs/all