Commit Graph

121 Commits (9e276df19438bc1379d466925557dfa003b9a59c)

Author SHA1 Message Date
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
Scott Anderson 636f5ada45
V2 nav reorg (#5213)
* 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>
2023-11-06 15:53:12 -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
Scott Anderson 35ad46c4c2
Version restructure (#5133)
* mass changes for version restructure

* fixed latest-patch and flux version generator

* updated hugo configs

* fixed flux frontmatter injector

* fixed flux frontmatter injector

* WIP api generator updates for version restructure (#5128)

* fixed telegraf plugin list

* removed latest shortcode

* fixed current-version

* fixed product dropdown crosslinking

* fixed alt links

* WIP fixing links

* fixed broken links

* updated api doc generation

* fixed additional resources

* added version redirects to edge.js

* fixed search placeholder

* fixed paged titles
2023-09-12 23:33:31 -06: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
Scott Anderson 1871c4e62b
InfluxDB 2.7.0 API docs (#4858) 2023-04-11 09:56:00 -06:00
Jason Stirnaman e4e4878a3d
4806 document different ways to execute queries against iox (#4822)
* hotfix(cloud-iox): update buckets docs URLs

* fix(ui): update menu item name

* fix: buckets: update cloud-iox URL, add Update using API
2023-03-22 11:20:39 -05:00
Jason Stirnaman 6aad82f4d1
4806 document different ways to execute queries against iox (#4820)
* 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
2023-03-21 16:34:13 -05:00
Jason Stirnaman 8129c5b4c5
fix for reverted 4788 build the http api reference for iox relevant endpoints (#4803)
* 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>
2023-03-15 11:36:17 -05:00
Jason Stirnaman 63b524bf0b
Revert "4788 build the http api reference for iox relevant endpoints (#4801)" (#4802)
This reverts commit da6c2e467d.
2023-03-15 10:36:14 -05:00
Jason Stirnaman da6c2e467d
4788 build the http api reference for iox relevant endpoints (#4801)
* 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>
2023-03-15 10:20:56 -05:00
Jason Stirnaman f431862a4a
Fix api version (#4697)
* 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>
2023-01-11 13:03:21 -07:00
Scott Anderson 0775371951
InfluxDB v2.6.0 (#4672)
* 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>
2022-12-15 16:43:27 -07:00
Jason Stirnaman fff1693ed3
chore(api): update to latest openapi: (#4624)
- 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.
2022-11-08 15:36:18 -06:00
Jason Stirnaman 7030280056
chore(api): add OSS v2.5 API docs, use plugin to set info.license, up… (#4618)
* chore(api): add OSS v2.5 API docs, use plugin to set info.license, update docs with latest changes.

* fix(api): fix OSS version in links.
2022-11-04 17:37:04 -05:00
Jason Stirnaman 149c98b415
hotfix: fix bad link path (#4547)
- Create a bucket with an explicit schema
2022-10-07 16:55:01 -05:00
Jason Stirnaman eae9000521
chore: Update API ref docs from openapi Cloud and OSS (#4546) 2022-10-07 16:20:14 -05:00
Jason Stirnaman eeaab0f240
chore(api): Updates API specs for users and auths. Fixes whitespace, punctuation, grammar, links, and other style issues. (#4469) 2022-09-21 09:22:49 -05:00
Jason Stirnaman 260ed64b3b
fix(api): Check all nodes for a description field (#4458)
- Replace named nodes in decorator with the any key.
- If the node description field is a string, replace URLs.
2022-09-15 11:44:08 -05:00
sunbryely-influxdata 1ba9d6fa1d
Update api-docs/v2.4/ref.yml
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-09 10:09:43 -07:00
sunbryely-influxdata 6b7aba0029
Update api-docs/cloud/ref.yml
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-09 10:09:23 -07:00
sunbryely-influxdata df953e01e8
Update api-docs/cloud/ref.yml
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-09 10:09:07 -07:00
sunbryely-influxdata b15e37b144
Update api-docs/cloud/ref.yml
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-09 10:09:00 -07:00
Sunbrye Ly ceed42b669 feat: release api docs updates 2022-09-08 12:36:19 -07:00
Jason Stirnaman 31f18dd373
Chore/update api docs (#4411)
* feat: add MIT license to api content

* chore: whitespace

* chore(api): update to openapi Cloud and OSS to master HEAD.

Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
2022-09-06 08:58:31 -05:00
sunbryely-influxdata 03f9183ba6
feat: add MIT license to api content (#4401)
* feat: add MIT license to api content

* chore: whitespace

Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-09-01 17:15:51 -05:00
Jason Stirnaman 272b19b259
hotfix(api): add info content for v2.4 API (#4391)
* hotfix(api): add info content for v2.4 API

* Update api-docs/openapi/content/v2.4/v1compat/info.yml

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-08-29 15:15:02 -05:00
Scott Anderson 20a409294f
InfluxDB OSS 2.4 (#4361)
* created OSS 2.4

* port nav-item shortcode fixes to 2.4

* update set() example in influxdb faq

* port schema exploration updates to 2.4

* replace indexDB with InfluxDB

* OSS and Enterprise FAQ update (#4310)

* add info about relative time ranges and task retries, closes influxdata/EAR#3415

* add delete faqs, closes influxdata/EAR#3412

* restructure enterprise faq, add entropy faq, closes influxdata/EAR#3364

* add faq about total query time, closes influxdata/EAR#3509

* port MQTT changes into influxdb 2.4

* Influx CLI 2.4 (#4340)

* feat: added CLI scripts documentation (#4223)

* feat: added CLI scripts documentation

* chore: address feedback

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

* chore: more feedback

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

* moved scripts cli docs into 2.4

* Add users to an org as an owner and other fixes (#4258)

* document adding users to an org as an owner and other fixes, closes #4171

* update content around owners

* InfluxQL shell documentation (#4263)

* added influx v1 shell command docs, closes #4173

* add influxql shell process docs, closes #4172

* add links to influxql shell process docs

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* feat: documented invokable scripts within tasks functionality in the CLI (#4295)

* feat: documented invokable scripts within tasks functionality in the CLI

* chore: added updated_in frontmatter

* add information about cli configs with username/password (#4328)

Co-authored-by: Andrew Depke <andrewdepke@gmail.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* influx CLI 2.4 release notes (#4267)

* feat: added CLI scripts documentation (#4223)

* feat: added CLI scripts documentation

* chore: address feedback

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

* chore: more feedback

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

* moved scripts cli docs into 2.4

* influx CLI 2.4 release notes

* Update content/influxdb/v2.4/reference/release-notes/influx-cli.md

* update release notes with cli username/password support

Co-authored-by: Andrew Depke <andrewdepke@gmail.com>

* 2.4 Virtual DBRPs (#4342)

* WIP auto-add dbrp

* add dbrp management docs

* Update replication docs for InfluxDB 2.4 (#4343)

* update replication docs

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* port postman install update to 2.4

* port influx stacks init fix to all influxdb versions

* API docs for 2.4 (#4357)

* api docs for 2.4

* updated to latest swaggerV1Compat.yml

* update edge.js

* Oss 2.4 release notes (#4352)

* added initial notes

* added updates

* updated the release notes

* made a few updates, changed TBD

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: Sam Dillard <sam@influxdata.com>

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

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

* Update content/influxdb/v2.4/reference/release-notes/influxdb.md

Co-authored-by: Sam Dillard <sam@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* added date to influx-cli 2.4.0 release

Co-authored-by: lwandzura <51929958+lwandzura@users.noreply.github.com>
Co-authored-by: Andrew Depke <andrewdepke@gmail.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Sam Dillard <sam@influxdata.com>
2022-08-19 10:27:54 -05:00
Scott Anderson 00d767a683
fix api-docs tagging command (#4358)
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2022-08-19 09:57:53 -05:00
Jason Stirnaman 1051145790
chore: update file path in README 2022-08-15 13:18:08 -05:00
Jason Stirnaman 7d120aae35
Update README with alias for local openapi testing
Add an example alias `gsd` that generates the local contracts, validates them with OATS, bundles and lints them with openapi-cli, and then generates the HTML with redoc-cli.
2022-08-15 13:06:33 -05:00
Jason Stirnaman e64a59b4d0
Chore/lint api defs (#4334)
* chore: update property names in redocly config.

* chore(api): lint the bundle output for openapi spec errors, set Cloud version, rename variable.

- Runs openapi-cli lint after generating the bundle output. This detects errors before pushing to openapi repo only to have the CI OATS validation fail. Only report the first 2 errors so we're not inundated with non-critical warnings.
- Renames INFLUXDB_VERSION to INFLUXDB_PLATFORM for clarity.
- Add a Cloud version to make the spec legal.
2022-08-12 11:48:21 -05:00
Jason Stirnaman 5470549e3d
chore: update property names in redocly config. (#4329) 2022-08-12 10:31:21 -05:00
Jason Stirnaman 22b0fe769b
chore(api): update Cloud and v2.3 API specs with latest openapi updates. (#4265)
Cloud: 0cb1ba2
OSS: 95559e3737b24f40bd0d90ea49f0dfbf84eea371
2022-07-28 16:21:09 -05:00
Jason Stirnaman b5fdb24d41
Feat/api helpers (#4243)
* feat: add ast to glossary

* adding to 2.2

* hotfix(tasks): update duplicate-oss tag to fix broken icon render.

* chore: make API ref shortcode regex non-greedy.

- Make regex used to replace INFLUXDB_DOCS_URL shortcode in the API spec lazy so that it only matches each instance of the shortcode when more than appear in a description.

* fix(glossary): simplify AST and fix agent.

* feat(glossary): add RFC3339Nano entry to use with API docs.

Co-authored-by: Sunbrye Ly <sunbryely@Sunbryes-MacBook-Pro.local>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-07-22 16:53:00 -05:00
Sunbrye Ly 01cec20b96 hotfix:400-error 2022-07-21 12:52:37 -07:00
Jason Stirnaman b15f2fdfdc
Api/update specs (#4226)
* chore(api): update specs

- tasks with scripts for cloud
- improve task endpoint docs

* chore: update cloud and oss api specs for cloud tasks-with-scripts.

- Tasks can be used with invokable scripts.
- Reset docs-release/oss branch to head of master due to changes for
  tasks. Doesn't appear to be anything new in OSS that would break.
2022-07-19 14:58:35 -05:00
Jason Stirnaman 064d9d0a25
chore/api-tags flatten tags (#4191)
* chore(api):

- Replace some x-tagGroups with tags to flatten the navigation and redundant headings.
- Remove unnecessary x-tagGroups from 1.x compat docs.

* chore: remove unused tag-group files.

* chore: update api-docs README

- Document the generate -c flag.
- Cleanup.

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-07-12 12:21:35 -05:00
Jason Stirnaman 91a8b7c826
Chore/improve api docs generation (#4196)
* chore: getswagger quality-of-life

- Exit on invalid options.
- Show curl output, e.g. if the filepath is incorrect.
- Replace $_ with $outFile for readability.
- Replace context with platform, the common jargon.

* chore(api): generate.sh quality-of-life

- Only regenerate HTML for a spec version if the current file differs from master.
- Refactor to remove code repetition.

* chore: generate.sh generates all versions by default

- Add a -c flag that only generates changed files (for development).
- More refactoring.
2022-07-08 16:30:02 -05:00
Jason Stirnaman e76dfb1ff4
Revert "Chore/improve api docs generation (#4190)" (#4194)
This reverts commit ee7239189c.
Got 404s for API docs pages after deploy.
2022-07-08 10:48:41 -05:00