Commit Graph

20 Commits (v3/inspect-partitions)

Author SHA1 Message Date
Fraser Savage 57eb8c6aa4
refactor(write-api): Use proper product terms for Dedicated
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-08-09 16:17:43 +01:00
Fraser Savage c83339029c
fix(write-api): Update Cloud Serverless outside-retention failure to HTTP 422 2024-08-09 15:45:38 +01:00
Jacob Marble ef61afc6ec fix(write-api): Serverless write 201 response codes
Helps https://github.com/influxdata/idpe/issues/18710

InfluxDB v3 Serverless will soon return 201 or 204, in cases where it
currently returns 204.
2024-08-07 12:57:04 -07:00
Jason Stirnaman 8acbb22312 fix: add missing partial and schema descriptions for InfluxQL JSON response
- Closes #5364
- part of https://github.com/influxdata/DAR/issues/424
- depends on https://github.com/influxdata/openapi/pull/651
2024-05-16 12:48:55 -05:00
Jason Stirnaman 3d08263f38 fix(api): Update HTTP API landing page in Dedicated
- Adds a custom short title field in OpenAPI info.
- Uses the new field for nav menu item names.
- Adds identifiers to avoid duplicate name warnings.
- Cleans up variation in frontmatter.
2024-04-16 16:29:27 -05:00
Jason Stirnaman ac4b1c53c8
feat(v3): Restructure API docs for v3 (#5408)
* v3 management API
Fixes #5397

- Adds an API reference doc for the  HTTP management API openapi spec (https://github.com/influxdata/granite/blob/main/openapi.yaml) (Cloud Dedicated only)
- Doesn't fetch changes for any specs except for the Management spec.
- Adds summaries and fixes descriptions in spec overrides.
- Removes versions in spec overrides.
- Adds configuration for generating API reference docs, Hugo frontmatter, setting the default API (for the [product]/api/ URL)
- Restructures `/api-docs` to better allow for multiple APIs (and customizations) per product
- Adds `[product]/api/v2/` docs URL for cloud products (currently set as the "default" API, `[product]/api`)
- Refactors `generate-api-docs` to remove specific conditions and use the new directory structure.
- Redocly update fixes some theme formatting issues

- Tested the following URLs:

   - http://localhost:1313/influxdb/v2/api/
   - http://localhost:1313/influxdb/v2/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud/api/
   - http://localhost:1313/influxdb/cloud/api/v2/
   - http://localhost:1313/influxdb/cloud-dedicated/api/
   - http://localhost:1313/influxdb/cloud-dedicated/api/v2/
   - http://localhost:1313/influxdb/cloud/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud-dedicated/api/v1-compatibility/
   - http://localhost:1313/influxdb/cloud-serverless/
   - http://localhost:1313/influxdb/cloud-serverless/api/v2/
   - http://localhost:1313/influxdb/cloud-serverless/api/v1-compatibility/
   - http://localhost:1313/influxdb/clustered/api/
   - http://localhost:1313/influxdb/clustered/api/v2/
   - http://localhost:1313/influxdb/clustered/api/v1-compatibility/

* fix(v3): Remove Management API from menu

* Update api-docs/cloud-dedicated/v2/content/info.yml

* show management api in nav, update nav names

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
2024-04-09 17:02:12 -06:00
Jason Stirnaman 7479ceabf2
Revert "Revert "feature(v3): Write: partial writes write good lines and reject bad li… (#5169)" (#5280)" (#5304)
This reverts commit 624eb0205b.
2024-01-17 13:20:25 -06:00
Jason Stirnaman d61107a3d3
feature(v3): Cloud Dedicated write API: partial writes write good lines and reject bad li… (#5273)
* feature(v3): Write: partial writes write good lines and reject bad lines #5160

- Documents the proposed partial writes feature for Serverless and Dedicated.
- Updates Troubleshoot writes and API docs.

* chore(v3): update write status codes (#5160)

* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md

* chore(v3): cleanup partial write descriptions in API ref and troubleshooting guide
2023-12-18 12:43:44 -06:00
Jason Stirnaman 624eb0205b
Revert "feature(v3): Write: partial writes write good lines and reject bad li… (#5169)" (#5280)
This reverts commit 90948e67dc.
2023-12-15 09:27:57 -06:00
Jason Stirnaman af4b0cd970
Revert "chore: add note about partial write failures (#5275)" (#5279)
This reverts commit 4416294c5c.
2023-12-15 09:26:08 -06:00
Jacob Marble 4416294c5c
chore: add note about partial write failures (#5275)
* chore: add note about partial write failures

Helps https://github.com/influxdata/influxdb_iox/issues/5226

* chore: integrate feedback

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-12-14 12:29:50 -06:00
Jason Stirnaman 90948e67dc
feature(v3): Write: partial writes write good lines and reject bad li… (#5169)
* feature(v3): Serverless write API: writes good lines, rejects bad lines #5160

- Documents the proposed partial writes feature for Serverless and Dedicated.
- If some points are written, returns 201 status code.
- Updates Troubleshoot writes and API docs.

* feature(v3): Serverless write API: writes good lines, rejects bad lines #5160

- Documents the proposed partial writes feature for Serverless and Dedicated.
- If some points are written, returns 201 status code.
- Updates Troubleshoot writes and API docs.

* fix: Serverless cleanup

* fix: Serverless write API: restore 204 and explain 201 and 400 status codes.

* Apply suggestions from code review

* fix: Serverless write API: 201 superseded by 204 to maintain v2 compat.

- Documents https://github.com/influxdata/idpe/pull/18398.

* fix: Serverless write API: 201 superseded by 204 to maintain v2 compat.

- Documents https://github.com/influxdata/idpe/pull/18398.

* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md

* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md

* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md
2023-12-13 16:20:51 -06:00
Jason Stirnaman de0f526bdf
Reorganize Serverless DBRP for v1 queries and writes, explain DBRP and auto bucket defaults (#5257)
* chore(v3): DBRP: Update Serverless API ref (#5234)

* chore(ci): Tests: substitute placeholders in JSON body parameters

* chore(v3): DBRP: copy page from influxql to admin/dbrps.

* chore(ci): Trying to prevent "a Influx..."

* chore(ci): Allow autogen

* chore(serverless): DBRP glossary entry

* chore(v2): add default DBRP note

* chore(v3): use product-name shortcode

* chore(v3): use product-name shortcode, clarify retention period and mapping

* chore(serverless): Create Bucket:

- add missing example for Data Explorer
- move Retention Period syntax and define retentionRules syntax
- setup for tests

* chore(serverless): Create Bucket:

- add missing example for Data Explorer
- move Retention Period syntax and define retentionRules syntax
- setup for tests

* chore(serverless): Update bucket: alias to match other products

* chore(v3): Serverless for prototyping: update with DBRP behavior

* Serverless auto-generated buckets have 3-day default retention period
Fixes #5234

- v1-compat guide:
  - passes tests
  - explains DBRPs (default, automatic, and management)
  - migrate DBRP content from query-data/influxql/dbrp
- v2-compat guide:
  - fix TOC
  - add list code example
- rename influxdb-v1-api to api/v1-http, migrate params from v1-compat guide, and explain DBRP in context
- add write-data/api/v1-http and migrate content from v1-compat guide
- move optimize and troubleshooting up to /query-data
- add Related items support for paths containing http
- substitute placeholders in tests

* chore(test): update configuration in README

* fix(serverless): Optimize queries parent

* fix(serverless): create-bucket cleanup

* fix: cleanup

* fix: close tag

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): permission to create dbrp-mapped bucket

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-12-05 16:48:25 -06:00
Andreas Deininger c9488e3465
Fixing typos (#5242)
* Fixing typos

* Update content/enterprise_influxdb/v1/flux/guides/rate.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-27 09:32:55 -07:00
Jason Stirnaman fa9bba758e
chore(api): add API compatibility overview to API ref (#5192)
* chore(api): add API compatibility overview to API ref

- add API compatibility trait tag
- add getswagger -B option to reuse existing contract and prevent fetching
- add /write description

* Update api-docs/cloud-dedicated/ref.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/cloud-dedicated/ref.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/clustered/ref.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/clustered/ref.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-10-25 11:35:38 -05:00
Jason Stirnaman e0bafcd9a1
fix: fix v3 write descriptions, Add v3 Troubleshoot writing data #5135 (#5140)
* fix: fix v3 write descriptions, Add v3 Troubleshoot writing data #5135

* Update content/influxdb/cloud-dedicated/write-data/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/write-data/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/clustered/write-data/troubleshoot.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-09-18 13:03:47 -05:00
Jason Stirnaman 1f64b24893
Fix api related links (#4956)
* wip: fix serverless api related links.

* fix(serverless): remove, replace, alias broken links, and/or mark for pending content

- See the annotated link checker report.
(closes 404s for links in Cloud Serverless API reference #4955)
2023-05-25 16:36:05 -05:00
Jason Stirnaman 6e01923a81
chore(api-ref): update API ref scripts for v3: (#4949)
* chore(api-ref): update API ref scripts for v3:

- Replace cloud-iox with cloud-serverless and cloud-dedicated in getswagger.sh
- Add cloud-dedicated API ref (handcrafted) with query, write, and ping paths.
- Remove separate v1-compat docs for Serverless and Dedicated.
The v1 paths are included in contracts/ref.
- Add Bearer Auth scheme.
- Remove separate v1 docs buttons from api/_index.md

* Update api-docs/cloud-dedicated/ref.yml

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update api-docs/cloud-dedicated/ref.yml

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-05-23 13:52:45 -05:00
Jason Stirnaman 3999b37e40
Fix cleanup api (#4922)
* fix(serverless): remove 'delete' mentions from '/write'.

* fix(serverless): replace bucket-name metadata key with database

* fix(dedicated): update API and client library links

* fix(dedicated): replace iox-namespace-name metadata key with database
2023-05-08 08:46:59 -05:00
Scott Anderson f08a1b19ac hotfix: updated api docs from cloud-iox to cloud-serverless 2023-04-26 08:10:32 -06:00