Jason Stirnaman
6d7983e469
fix(influxdb3): add required fields to TriggerSettings schema
...
Both run_async and error_behavior are required by the API.
Verified via testing against Core and Enterprise containers.
2025-12-11 15:45:40 -06:00
Jason Stirnaman
763c780d2e
fix(influxdb3): add missing API parameters for Core and Enterprise
...
Add undocumented parameters identified in API audit:
Core:
- retention_period for database creation
- trigger_settings (required) for processing engine triggers
- TriggerSettings schema
Enterprise:
- show_deleted query param for listing databases
- force description for trigger deletion
- trigger_settings (required) for processing engine triggers
- node_spec for cache and trigger creation (cluster targeting)
- TriggerSettings, ApiNodeSpec schemas
- Request bodies for plugin test/update endpoints
Also updates all trigger creation examples to include required
trigger_settings field.
closes #6610
2025-12-11 15:45:39 -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
Jameelah Mercer
7cc0c38df6
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:42:28 -07:00
Jameelah Mercer
36085a80ea
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2025-08-01 13:42:13 -07:00
Jameelah Mercer
33ace56632
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-31 23:22:06 -07:00
Jameelah Mercer
e7723172a5
Update api-docs/influxdb3/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-31 23:21:58 -07:00
Jameelah Mercer
e9bbdf1823
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-31 23:21:50 -07:00
Jameelah Mercer
aa766edd70
Update api-docs/influxdb3/cloud-serverless/v1-compatibility/swaggerV1Compat.yml
...
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-07-31 23:21:38 -07:00