* 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>
Partial writes are the only mode of operation on serverless clusters.
This means that any requests where all points are outside the retention
policy of a bucket receive a 400 bad request.
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.
- 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.
* 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
* 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
* 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>
* nest reference docs menu in v2 and cloud
* move migrate data into write data
* nest notebooks under tools
* nest templates under tools
* nest telegraf configs under tools
* cleanup weights and titles of tools sections
* reorg org and bucket management under admin
* add backup/restore to admin, clean up related links
* restructure security sections under admin
* Apply suggestions from code review
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
* updated serverless cli docs to address pr feedback
* Update content/influxdb/cloud/admin/organizations/delete-org.md
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
* port v2 install changes to new structure
* address pr feedback and ported missing content to serverless
---------
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
* 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>
* 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>
* 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)
* 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>
* fix(cloud-iox): typo.
* fix(cloud-iox): typo
* fix(iox): revise DATE_BIN example and link to reference.
* feat(iox): execute queries and visualize data with SQL in IOx.
* feat(cloud-iox): execute queries with Data Explorer (#4806).
- Publish steps for Execute Queries with Data Explorer.
- Remove pages not ready for IOx.
- Fix links in Get Started.
- Fix tags.
* feat(iox): Add API to IOx Reference, consolidate Cloud and OSS pages (#4788).
* fix(cloud-iox): IOx Data Explorer and Flux links.
* fix(cloud-iox): 1.x API menu.
* fix(cloud-iox): remove visualization types until we've verified links, etc.
* fix(cloud-iox): delete additional 1.x reference docs for now, revise Data Explorer.
* fix(api): replace cloud with cloud-iox in URLs, remove errant externalDocs link.
* feat(cloud-iox): add admin/accounts with data-usage and limits pages.
* fix(cloud): revise and remove outdated info from account management.
* fix(iox): punctuation.
* fix(cloud-iox): update link paths.
* fix(cloud-iox): update link paths for cloud-iox.
* patch(cloud-iox): quick fix for v1compat link paths
* feature(cloud-iox): add cloud-iox API reference content.
* feature(api): revise tagging, add cloud-iox API:
- Closes#4788.
- Generates cloud-iox/api.
- Changes handling of tags and x-tagGroups.
- Configures custom All Endpoints list for cloud-iox.
- Simplifies the nav with other grouping tags.
Any custom x-tagGroups configured in
[platform]/content/tag-groups.yml take precedence over
those already defined in the spec.
If you assign a list of tags to 'All endpoints' x-tagGroup,
the decorator
will use that list and remove Operations not tagged with
those tags.
If you assign an empty array([]) to the 'All endpoints' x-tagGroup,
the decorator will list all resource-like tags.
TODO: document in CONTRIBUTING.
TODO: unset x-tagGroups from openapi.
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* fix(api): unintended deletion of API operations
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feature(cloud-iox): add cloud-iox API reference content.
* feature(api): revise tagging, add cloud-iox API:
- Closes#4788.
- Generates cloud-iox/api.
- Changes handling of tags and x-tagGroups.
- Configures custom All Endpoints list for cloud-iox.
- Simplifies the nav with other grouping tags.
Any custom x-tagGroups configured in
[platform]/content/tag-groups.yml take precedence over
those already defined in the spec.
If you assign a list of tags to 'All endpoints' x-tagGroup,
the decorator
will use that list and remove Operations not tagged with
those tags.
If you assign an empty array([]) to the 'All endpoints' x-tagGroup,
the decorator will list all resource-like tags.
TODO: document in CONTRIBUTING.
TODO: unset x-tagGroups from openapi.
* Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
---------
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* chore: remove unused and deprecated properties:
- Remove unused apis key.
- Remove deprecated styleguide property, replace with root-level plugins and extends.
* chore: pass api-docs path to the custom plugin:
- Pass pwd of the calling script as process.env.API_DOCS_ROOT_PATH to plugins to help resolve custom content files.
- Remove lint execution because the exit code always results in execution of the next elif condition.
* chore: simplify api-docs custom content:
- move content overrides from api-docs/openapi/content to api-docs/[version]/content.
- fix version and version numbers in links.
- update cloud and v2.6 from openapi repo.
- move content.js module to docs-content.js and docs-plugin.js.
- revert decorator functions back to taking content as a data argument.
- remove unused servers.yml definition.
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* created 2.6 docs set
* fixed config.toml file
* fixed taxonomies
* fixed 2.6 file strucure
* added CLI 2.6 release notes (#4668)
* New influxd inspect commands (#4670)
* added new influxd inspect commands
* updated the index page with new commands
* Apply suggestions from code review
* added examples for influxd inspect report-db
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
* OSS 2.6 release notes (#4669)
* WIp release notes
* WIP release notes
* added links
* added detail
* Update content/influxdb/v2.6/reference/release-notes/influxdb.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* Update content/influxdb/v2.6/reference/release-notes/influxdb.md
Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>
* minor updates to release notes
* minor updates to previous release notes
* more minor updates to release notes
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
* fixed typos
* add 2.6 openapi spec (#4671)
* fix all 2.6 links in 2.5
Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Jeffrey Smith II <jeffreyssmith2nd@gmail.com>
- authorizations docs
- update Authorizations tag to Authorizations (API tokens)
- update link in influxdb/content/v2.5 to match
- replace /latest/ with /v2.4/ in latest.
Scott Anderson
Jason Stirnaman
Ben Tasker
Fraser Savage
Fraser Savage
Jacob Marble
Dustin Eaton
Abdullah Sabaa Allil
Jacob Marble
Andreas Deininger
Scott Anderson
Jason Stirnaman