No longer uses Hugo /data.
Removes dependency on the Hugo-data-to-pages script.
For each product endpoint, generate a page with the endpoint spec inside the frontmatter.
Writes endpoint specs into each page's frontmatter.
Assign a `type` property for API reference (OpenAPI) paths. For example, if the page structure is `content/influxdb/v2/api/v2/[OpenAPI path]`, then add `type: api_path` to the frontmatter and, if necessary, specify a layout: `layout: api_path`.
Renders the spec param JSON using Rapidoc.
TODO:
- Cleanup
- Create additional templates that process page data for nav, filtering, links, code samples, etc.
- Fix circular reference issues in specs that prevent generating a dereferenced JSON bundle (which could also help us our own custom UI...should we choose).
- Replaces hugo-data-to-pages with forked repo that accepts a config object and uses a more recent version of js-yaml.
- Uses async to wait for scripts to complete.
* 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>
Jason Stirnaman
Scott Anderson
Ben Tasker
Fraser Savage
Fraser Savage
Jacob Marble
Dustin Eaton
Abdullah Sabaa Allil
Jacob Marble
Andreas Deininger
Scott Anderson