Commit Graph

280 Commits (3b4e7931cc331298f617d76bf4acdff522b2283c)

Author SHA1 Message Date
Claude 3b4e7931cc
fix(influxdb3): add disabled field to all trigger examples
Updates all 18 processing engine trigger examples (9 per product) to
include the required disabled: false field, matching the schema
requirement added in the previous commit.

https://claude.ai/code/session_01AAbf2TE2bQTpqgugthTSJF
2026-02-04 21:44:08 +00:00
Claude fafa9eee33
fix(influxdb3): mark disabled field as required for processing engine trigger
The API rejects requests without the disabled field, but the documentation
did not mark it as required. This updates both Core and Enterprise API specs
to correctly indicate that the disabled field is required for
POST /api/v3/configure/processing_engine_trigger.

closes #6611

https://claude.ai/code/session_01AAbf2TE2bQTpqgugthTSJF
2026-02-04 21:39:42 +00:00
Joel Abshier a0a2eec042
chore: Update openapi spec for Dedicated/Clustered Database and table Rename, Undelete endpoints (#6762) 2026-01-23 14:24:50 -07:00
Jason Stirnaman e4f9d440e3
docs(influxdb3): Use a GET request to check ping response headers. (#6749)
- Updates identify-version guide and Core/Ent3 API specs
- Use GET. HEAD `/ping` responds with `404`
- Specify default auth requirement for Enterprise
- Tested with Core and Ent v3.8.0
2026-01-16 20:51:49 -06:00
Jason Stirnaman a5f846b544
Dar 589 cli api params (#6719)
* docs(influxdb3): fix format in GET /api/v3/configure/database

* docs(influxdb3): `fields` is required for `influxdb3 tables create` and
API
2026-01-15 15:51:16 -06:00
Jason Stirnaman abbc4e8c50
fix(influxdb3): add show_deleted parameter for listing databases (#6631)
Add the show_deleted query parameter to the list databases endpoint
in the Enterprise API spec. This parameter allows users to include
soft-deleted databases in the response.

closes #6610
2025-12-16 14:28:35 -06:00
Jason Stirnaman 87083291f5
fix(influxdb3): add trigger settings and related API parameters (#6630)
Add trigger configuration and cluster targeting parameters to API specs:

Core:
- TriggerSettings schema (run_async, error_behavior)
- trigger_settings field in ProcessingEngineTriggerRequest (required)
- Updated all trigger creation examples

Enterprise:
- TriggerSettings schema (run_async, error_behavior)
- ApiNodeSpec schema for cluster node targeting
- trigger_settings and node_spec fields in ProcessingEngineTriggerRequest
- node_spec field in cache creation requests (DistinctCache, LastCache)
- force parameter description for trigger deletion
- Request body schemas for plugin test/update endpoints:
  - WALPluginTestRequest
  - SchedulePluginTestRequest
  - PluginFileRequest
  - PluginDirectoryRequest
  - PluginFileEntry
- Updated all trigger creation examples

closes #6610
2025-12-16 13:31:56 -06:00
Jason Stirnaman c681491423
fix(influxdb3): add retention_period to CreateDatabaseRequest (#6629)
Add the undocumented retention_period parameter to the database
creation API for InfluxDB 3 Core.

closes #6610
2025-12-15 13:20:44 -06:00
Scott Anderson 6b1905c1d5
fix: updates write reponses, suggests exponential backoffs (#6574)
* fix: updates write reponses, suggests exponential backoffs, closes influxdata/DAR#557

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Fix cURL example to use $max_delay variable instead of hardcoded value (#6575)

* Initial plan

* Fix: use $max_delay variable instead of hardcoded 30 in cURL example

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-12-02 11:40:56 -08:00
Jason Stirnaman 2330308a0f
feat(api): add missing endpoints for InfluxDB 3.7 API (#6569)
- Add DELETE /api/v3/configure/database/retention_period
- Add DELETE /api/v3/configure/token
- Add POST /api/v3/configure/token/named_admin
- Add PUT /api/v3/plugins/files (requires admin token)
- Add PUT /api/v3/plugins/directory (requires admin token)

Apply to both influxdb3/core/v3 and influxdb3/enterprise/v3 specs.

chore(api): Add RemoveInternalOperations decorator to document Redocly's built-in behavior, hiding endpoints that have `x-internal: true`

chore(api): Add yarn build:api-docs

This command:
1. Changes to the api-docs directory
2. Executes the generate-api-docs.sh script to generate API
  documentation HTML from the OpenAPI specs
2025-11-25 15:01:31 -06:00
Jason Stirnaman baadaeee15
feat(influxdb3): Update API docs for 3.7 release (#6558)
* chore: 3.7 update

* fix(influxdb3): influxdb3 3.7 release:

- Avoid use of "retention policy" except for the storage engine
- User guide: specific heading, active voice
- Use SOURCE

* feat(influxdb3): update API docs for 3.7 release

- Add cluster-uuid response header to all write endpoints
- Document multi-member gzip payload support in ContentEncoding
- Update API version to 3.7.0 for both Core and Enterprise
- Extract cluster-uuid header to reusable component

Changes for InfluxDB 3.7 release include:
- cluster-uuid header now included in all HTTP responses
- Multi-member gzip support per RFC 1952 for write endpoints
- Compatible with v1 and v2 write endpoints

* fix(influxdb3): remove precision bug note - fixed in 3.7

Removed outdated bug note about abbreviated precision values not working
with /api/v3/write_lp endpoint. Testing confirms all abbreviated values
(ns, ms, us, s) now work correctly in InfluxDB 3.7.

Tested precision values:
- ns (nanoseconds) 
- ms (milliseconds) 
- us (microseconds) 
- s (seconds) 

* docs(influxdb3): add precision bug fix to v3.6.0 release notes

Document that abbreviated precision values (ns, ms, us, s) were fixed
in v3.6.0 to work with /api/v3/write_lp endpoint.

The fix was implemented in commit 97dafa177c and included in v3.6.0 release.

---------

Co-authored-by: Peter Barnett <peter.barnett03@gmail.com>
2025-11-20 10:25:54 -06:00
dependabot[bot] 07a299dc14
chore(deps): bump js-yaml from 4.1.0 to 4.1.1 in /api-docs
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 4.1.0 to 4.1.1.
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/4.1.0...4.1.1)

---
updated-dependencies:
- dependency-name: js-yaml
  dependency-version: 4.1.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-11-14 18:17:12 +00:00
Jason Stirnaman 17558b8207
Jts 6477 fix writelp precision (#6478)
* docs(influxdb3): update write endpoint recommendations and add Telegraf guidance

- Update write endpoint recommendations for Core/Enterprise
- Add Telegraf output plugin guidance (v1.x and v2.x)
- Improve introductory content and formatting
- Change Note to Tip for write endpoint recommendations
- Add italics to v1/v2 for clarity

* docs(influxdb3): add precision parameter comparison and format details

- Add precision comparison table across v1, v2, v3 write APIs
- Document auto precision detection with exponential notation (5e9, 5e12, 5e15)
- Add tabbed code examples for different precision values
- Update OpenAPI specs with long-form precision values only (auto, nanosecond, microsecond, millisecond, second)
- Add timestamp conversion details for internal storage
- Use long-form precision values in all examples

Note: Currently /api/v3/write_lp only supports long forms despite source code indicating short form support.
Related to #6472 - precision parameter behavior may have bugs
2025-10-21 21:10:27 -05:00
Jameelah Mercer 8b402e4f32
Update api-docs/influxdb3/core/v3/ref.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-16 10:23:58 -07:00
Jameelah Mercer 4b5c6a1fe7
Update api-docs/influxdb3/enterprise/v3/ref.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-16 10:23:51 -07:00
meelahme 18a26b6a74 docs(api): add parameter descriptions for cache DELETE endpoints [Enterprise] 2025-10-16 10:22:42 -07:00
meelahme 9b66957fce docs(api): add parameter descriptions for cache DELETE endpoints [Core] 2025-10-16 10:14:28 -07:00
meelahme 7fe9ffa999 feat(enterprise): add DELETE endpoint for distinct cache 2025-10-15 12:02:52 -07:00
meelahme be7fcd94b1 feat(core): add DELETE endpoint for distinct cache 2025-10-15 11:47:30 -07:00
Jason Stirnaman 3e4864a836 Instructions files cleanup:
- Follow Copilot guidelines for naming instructions files according to the directory they apply to
- Copy instructions files as CLAUDE.md to the relevant directory.
- Update placeholder instructions
- Optimize Copilot instructions
- Remove Claude instructions and reference the Copilot instructions file instead

TODO: update the commit hook script to correctly generate and place the files.
2025-09-23 10:37:10 -05:00
Jason Stirnaman 7b43569049
Update api-docs/template.hbs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-03 21:36:40 -05:00
Jason Stirnaman 69068a64bf fix(askai): Ask AI modal position and font:Removes Ask AI modal style overrides to correct positioning in the window.
For API reference docs, decreases the trigger button size and fixes the button and modal font.
2025-09-03 17:38:03 -05:00
meelahme 144de5785c minor updates to requestBody to fix Ci build error 2025-08-14 14:58:03 -07:00
Jameelah Mercer beb7bb2261
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-07 13:13:56 -07:00
Jameelah Mercer 4f0a7181ef
Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:56:21 -07:00
Jameelah Mercer 33cae0b3e2
Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:56:05 -07:00
Jameelah Mercer 4d77cde02e
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:55:55 -07:00
Jameelah Mercer c6bd7bb726
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:55:44 -07:00
Jameelah Mercer a69fea8a00
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:55:33 -07:00
Jameelah Mercer bc890e4d6d
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:55:21 -07:00
Jameelah Mercer 89db6cdd51
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:55:09 -07:00
Jameelah Mercer ce5d9292c5
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:54:39 -07:00
Jameelah Mercer 6fb6454aa2
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-06 09:54:12 -07:00
Jameelah Mercer 9ee11d3d41
Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 14:38:30 -07:00
Jameelah Mercer 65e80cad92
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 14:38:21 -07:00
Jameelah Mercer a2157763c9
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 14:38:10 -07:00
meelahme ae96f0154e docs: updates to clous-serveless rp 2025-08-05 14:02:39 -07:00
meelahme 78ecb89000 Merge branch 'docs/5625-v1-get-query-endpoint' of github.com:influxdata/docs-v2 into docs/5625-v1-get-query-endpoint 2025-08-05 13:52:45 -07:00
meelahme 5ef4d2e1e4 docs: updating rp for cluster and serverless 2025-08-05 13:52:18 -07:00
Jameelah Mercer 7f17176865
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 13:44:08 -07:00
Jameelah Mercer 4a6cbb38dd
Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-05 13:43:53 -07:00
meelahme 3c2f475751 dox: fixing wrong indentation 2025-08-05 13:39:31 -07:00
meelahme 3b60c7f253 docs: updating swaggerVwith rp, operationID, and bucket changed to database 2025-08-05 13:21:16 -07:00
Jameelah Mercer c6a11dbb08
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-04 14:37:47 -07:00
Jameelah Mercer 7436f0fbd8
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-04 14:37:18 -07:00
Jameelah Mercer 76af7669ee
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 16:45:45 -07:00
Jameelah Mercer 3b738ec618
Update api-docs/influxdb3/clustered/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:43:29 -07:00
Jameelah Mercer 6a20bb0372
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:43:22 -07:00
Jameelah Mercer 6efb013714
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:43:13 -07:00
Jameelah Mercer 6ba77d4808
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:42:36 -07:00