69429a9ebe
WIP: API and JavaScript revamp
2025-03-04 17:07:02 -06:00
e014f744a0
chore(api-ref): Uplift API reference docs:
...
- Adapts code from @jstirnaman's demo site to generate Hugo pages from OpenAPI paths in the InfluxDB spec files.
- Uses Rapidoc to render the OpenAPI path in a page--effectively treating each endpoint as a standalone API for faster loading.
- Run yarn install and then Executing: api-docs/getswagger.sh cloud-v2 -B
No URL was provided. I'll rebuild from the existing spec /Users/ja/Documents/github/docs-v2/api-docs/cloud/v2/ref.yml
10.8.2
Generating OpenAPI path files in static/openapi/influxdb-cloud-v2/paths....
Generating OpenAPI article data in data/article-data/influxdb/cloud-v2...
Executing: HUGO_DATAPAGES_DATA_PATH=data/article-data/influxdb/cloud-v2 HUGO_DATAPAGES_ELEMENT=articles HUGO_DATAPAGES_TYPE=api HUGO_DATAPAGES_CONTENT_PATH=content/influxdb/cloud/api/v2 node hugo-data-to-pages/hugo.js clean --force
Removing data-generated files...
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-authorizations
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-buckets
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-checks
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-dashboards
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-dbrps
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-delete
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-flags
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-labels
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-maps
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-me
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-notificationEndpoints
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-notificationRules
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-orgs
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-query
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-resources
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-scripts
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-setup
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-signin
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-signout
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-stacks
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-tasks
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-telegraf
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-telegrafs
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-templates
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-users
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-variables
Removed folder: ./content/influxdb/cloud/api/v2/api-v2-write
Removed folder: ./content/influxdb/cloud/api/v2/api-v2
Removed folder: ./content/influxdb/cloud/api/v2/legacy-authorizations
Removed folder: ./content/influxdb/cloud/api/v2/ping
Removed folder: ./content/influxdb/cloud/api/v2/query
Removed folder: ./content/influxdb/cloud/api/v2/write
Done!
Executing: HUGO_DATAPAGES_DATA_PATH=data/article-data/influxdb/cloud-v2 HUGO_DATAPAGES_ELEMENT=articles HUGO_DATAPAGES_TYPE=api HUGO_DATAPAGES_CONTENT_PATH=content/influxdb/cloud/api/v2 node hugo-data-to-pages/hugo.js generate
Building data-generated files...
Created file: ./content/influxdb/cloud/api/v2/api-v2-authorizations/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-buckets/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-checks/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-dashboards/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-dbrps/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-delete/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-flags/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-labels/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-maps/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-me/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-notificationEndpoints/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-notificationRules/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-orgs/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-query/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-resources/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-scripts/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-setup/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-signin/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-signout/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-stacks/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-tasks/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-telegraf/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-telegrafs/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-templates/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-users/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-variables/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2-write/index.md
Created file: ./content/influxdb/cloud/api/v2/api-v2/index.md
Created file: ./content/influxdb/cloud/api/v2/legacy-authorizations/index.md
Created file: ./content/influxdb/cloud/api/v2/ping/index.md
Created file: ./content/influxdb/cloud/api/v2/query/index.md
Created file: ./content/influxdb/cloud/api/v2/write/index.md
Done!
Executing: api-docs/getswagger.sh oss-v2 -B
No URL was provided. I'll rebuild from the existing spec /Users/ja/Documents/github/docs-v2/api-docs/v2/ref.yml
10.8.2
Generating OpenAPI path files in static/openapi/influxdb-oss-v2/paths....
Generating OpenAPI article data in data/article-data/influxdb/oss-v2...
Executing: HUGO_DATAPAGES_DATA_PATH=data/article-data/influxdb/oss-v2 HUGO_DATAPAGES_ELEMENT=articles HUGO_DATAPAGES_TYPE=api HUGO_DATAPAGES_CONTENT_PATH=content/influxdb/v2/api/v2 node hugo-data-to-pages/hugo.js clean --force
Removing data-generated files...
Removed folder: ./content/influxdb/v2/api/v2/api-v2-authorizations
Removed folder: ./content/influxdb/v2/api/v2/api-v2-backup
Removed folder: ./content/influxdb/v2/api/v2/api-v2-buckets
Removed folder: ./content/influxdb/v2/api/v2/api-v2-checks
Removed folder: ./content/influxdb/v2/api/v2/api-v2-config
Removed folder: ./content/influxdb/v2/api/v2/api-v2-dashboards
Removed folder: ./content/influxdb/v2/api/v2/api-v2-dbrps
Removed folder: ./content/influxdb/v2/api/v2/api-v2-delete
Removed folder: ./content/influxdb/v2/api/v2/api-v2-flags
Removed folder: ./content/influxdb/v2/api/v2/api-v2-labels
Removed folder: ./content/influxdb/v2/api/v2/api-v2-maps
Removed folder: ./content/influxdb/v2/api/v2/api-v2-me
Removed folder: ./content/influxdb/v2/api/v2/api-v2-notificationEndpoints
Removed folder: ./content/influxdb/v2/api/v2/api-v2-notificationRules
Removed folder: ./content/influxdb/v2/api/v2/api-v2-orgs
Removed folder: ./content/influxdb/v2/api/v2/api-v2-query
Removed folder: ./content/influxdb/v2/api/v2/api-v2-remotes
Removed folder: ./content/influxdb/v2/api/v2/api-v2-replications
Removed folder: ./content/influxdb/v2/api/v2/api-v2-resources
Removed folder: ./content/influxdb/v2/api/v2/api-v2-restore
Removed folder: ./content/influxdb/v2/api/v2/api-v2-scrapers
Removed folder: ./content/influxdb/v2/api/v2/api-v2-setup
Removed folder: ./content/influxdb/v2/api/v2/api-v2-signin
Removed folder: ./content/influxdb/v2/api/v2/api-v2-signout
Removed folder: ./content/influxdb/v2/api/v2/api-v2-sources
Removed folder: ./content/influxdb/v2/api/v2/api-v2-stacks
Removed folder: ./content/influxdb/v2/api/v2/api-v2-tasks
Removed folder: ./content/influxdb/v2/api/v2/api-v2-telegraf
Removed folder: ./content/influxdb/v2/api/v2/api-v2-telegrafs
Removed folder: ./content/influxdb/v2/api/v2/api-v2-templates
Removed folder: ./content/influxdb/v2/api/v2/api-v2-users
Removed folder: ./content/influxdb/v2/api/v2/api-v2-variables
Removed folder: ./content/influxdb/v2/api/v2/api-v2-write
Removed folder: ./content/influxdb/v2/api/v2/api-v2
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-all
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-allocs
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-block
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-cmdline
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-goroutine
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-heap
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-mutex
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-profile
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-threadcreate
Removed folder: ./content/influxdb/v2/api/v2/debug-pprof-trace
Removed folder: ./content/influxdb/v2/api/v2/health
Removed folder: ./content/influxdb/v2/api/v2/legacy-authorizations
Removed folder: ./content/influxdb/v2/api/v2/metrics
Removed folder: ./content/influxdb/v2/api/v2/ping
Removed folder: ./content/influxdb/v2/api/v2/query
Removed folder: ./content/influxdb/v2/api/v2/ready
Removed folder: ./content/influxdb/v2/api/v2/write
Done!
Executing: HUGO_DATAPAGES_DATA_PATH=data/article-data/influxdb/oss-v2 HUGO_DATAPAGES_ELEMENT=articles HUGO_DATAPAGES_TYPE=api HUGO_DATAPAGES_CONTENT_PATH=content/influxdb/v2/api/v2 node hugo-data-to-pages/hugo.js generate
Building data-generated files...
Created file: ./content/influxdb/v2/api/v2/api-v2-authorizations/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-backup/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-buckets/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-checks/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-config/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-dashboards/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-dbrps/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-delete/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-flags/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-labels/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-maps/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-me/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-notificationEndpoints/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-notificationRules/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-orgs/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-query/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-remotes/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-replications/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-resources/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-restore/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-scrapers/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-setup/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-signin/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-signout/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-sources/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-stacks/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-tasks/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-telegraf/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-telegrafs/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-templates/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-users/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-variables/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2-write/index.md
Created file: ./content/influxdb/v2/api/v2/api-v2/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-all/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-allocs/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-block/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-cmdline/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-goroutine/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-heap/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-mutex/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-profile/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-threadcreate/index.md
Created file: ./content/influxdb/v2/api/v2/debug-pprof-trace/index.md
Created file: ./content/influxdb/v2/api/v2/health/index.md
Created file: ./content/influxdb/v2/api/v2/legacy-authorizations/index.md
Created file: ./content/influxdb/v2/api/v2/metrics/index.md
Created file: ./content/influxdb/v2/api/v2/ping/index.md
Created file: ./content/influxdb/v2/api/v2/query/index.md
Created file: ./content/influxdb/v2/api/v2/ready/index.md
Created file: ./content/influxdb/v2/api/v2/write/index.md
Done! to generate the paths, metadata, and pages.
2025-03-04 16:44:20 -06:00
4887aa5b66
fix(api): links and headings in local API refs.
...
- Fix broken links reported by the e2e link checker.
- Add an e2e test for checking internal and external links in API reference docs. Low effort, big win.
2025-02-26 16:20:14 -06:00
bd93174d29
fix(api): confusing nav behavior with endpoints duplicated among tag groups. Closes Remove tag groups from API ref docs that duplicate endpoints in the "All endpoints" tag group. #5868
2025-02-26 16:14:37 -06:00
4194ef5eb9
fix(api): Add shortDescription to replace summary
...
- Add a custom x-influxdata-short-description field that replaces the previous non-standard summary field used by Redocly.
- Double quote the title and description vars to preserve the entire value when passing them to the CLI
2025-02-26 16:07:28 -06:00
b3bb9c40f1
feat(api): InfluxDB3 Core API reference, API fixes, and e2e tests
...
- Adds InfluxDB 3 Core API reference
- Updates scripts
- Removes non-valid info.summary field from specs, replaces with description in metadata
- Simplifies frontmatter generation for HTML template
- Reorg of file structure to mirror the content structure.
- Moves OSS v2 into v2/v2/ref.yml to follow the same pattern as others
- Replaces isDefault API config field with specific aliases.
- Misc. fixes.
- Remove generated HTML files.
2025-02-25 17:10:09 -06:00
846d3a9e46
fix(api): Update glossary links. Remove old cloud-serverless directory
2025-02-25 17:10:09 -06:00
f15d7857a9
chore(monolith): Core HTTP API and OpenAPI .info content for Core and Enterprise
2025-02-25 17:09:03 -06:00
8509ea36d6
fix(api-ref): Update getswagger.sh destination paths to use the new directory structure when fetching spec files. Update the redocly plugin module path.
2025-01-28 12:31:47 -06:00
f1d82f4b00
fix(api-docs): Update API reference directories and generation script for influxdb3 URL paths, update links and names in reference content
2025-01-28 10:53:07 -06:00
Jason Stirnaman