Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
7,494 Commits
194 Branches
0 Tags
201 MiB
Commit Graph

20 Commits (js-code-placeholders)

Author SHA1 Message Date
Jason Stirnaman 92b115b1b4 fix(api): Fix Cloud Dedicated /ping descriptions 
- Cloud Dedicated /ping only reports querier, not ingester, health
- Update v1 docs API and client library recommendations.

Closes 5610
 2024-09-25 16:31:55 -05:00
Ben Tasker bae9b0e1b0
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 <fraser@savage.engineer>

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

Co-authored-by: Fraser Savage <fraser@savage.engineer>

* Apply suggestions from code review

Co-authored-by: Fraser Savage <fraser@savage.engineer>

---------

Co-authored-by: Fraser Savage <fraser@savage.engineer>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
 2024-09-03 14:17:07 -06:00
Fraser Savage 9f0c7c6283
refactor(write-api): Punctuation and wording changes from code review 
This makes the changes more consistent with wider writing style.

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
 2024-09-03 15:37:02 +01:00
Fraser Savage 5d74f97926
fix(write-api): Partial writes now return a 400 response code in dedicated 
This updates some of the other wording around the troubleshooting table
to reflect the product's current state more closely.
 2024-09-02 17:52:40 +01:00
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 749c59b525
fix(write-api): Update Cloud Dedicated outside-retention failure to HTTP 422 2024-08-09 15:51:18 +01:00
Scott Anderson 5c7d3407ad
Update the placeholder URL for dedicated (#5527) 
* update the placeholder URL for dedicated

* added dedicated URL migration
 2024-07-22 16:55:00 -06:00
Dustin Eaton a0ea0fcb41 fix: use int64 for retention period in API spec 
This updates the Cloud Dedicated Management API spec to use the `int64`
format for the `ClusterDatabaseRetentionPeriod` schema, which matches
the corresponding type in IOx's namespace API.
 2024-06-04 16:16:02 -05:00
Jason Stirnaman df3d9cad38 Merge remote-tracking branch 'origin/master' into jstirnaman/issue5463 2024-05-16 12:50:53 -05: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 dbcb5dcac2
Apply suggestions from code review 
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
 2024-05-10 15:21:30 -05:00
Jason Stirnaman e16405282d chore(v3): increase suggested wait for token activation 
- part of https://github.com/influxdata/DAR/issues/425
- Tokens currently can take minutes to sync
- Add Notable behaviors to guides and references
 2024-05-10 14:38:35 -05:00
Jason Stirnaman 0de7e563a3 feat(v3): Add influxctl cluster list and get task-based, and use them to find account ID and cluster ID for the HTTP API. Closes #5433 2024-04-19 11:58:17 -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
Abdullah Sabaa Allil 248c9c0b39
fix broken curl post commands (#5423) 
* fix broken curl post commands

* fix broken curl post commands

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
 2024-04-15 15:20:24 -06: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 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 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 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