Remove all RapiDoc-specific code from styles and JavaScript:
- Delete rapi-doc::part() CSS selectors from _api-layout.scss
- Delete dead auth modal styles from _api-security-schemes.scss
- Delete api-auth-input.ts component (RapiDoc "Try it" integration)
- Delete static/css/rapidoc-custom.css (unused)
- Remove setupRapiDocNavigation() from api-toc.ts
- Update comments to remove RapiDoc references
Rename _api-hugo-native.scss to _api-operations.scss since
Hugo-native is now the standard (not a POC).
Complete Tasks 1-5 of the Hugo-native API migration:
- Promote Hugo-native templates from POC to production location
- Remove RapiDoc templates (rapidoc.html, rapidoc-tag.html, rapidoc-mini.html)
- Remove RapiDoc JS components (api-rapidoc.ts, rapidoc-mini.ts)
- Clean up generation scripts (~200 lines of dead code removed)
- Rewrite Cypress tests for standard HTML (no shadow DOM)
Templates moved from layouts/partials/api/hugo-native/ to parent.
All verifications pass (Hugo build, TypeScript compilation).
- Replace #operation/OperationId links with page-based URLs
(e.g., #operation/GetLegacyQuery → /influxdb3/clustered/api/query-data/)
- Fix Quick start menu ordering by sorting nav items by weight
- Add default weight (100) to all articles for consistent sorting
- Quick start gets weight 1 to appear first in navigation
- Add x-influxdatadocs-related support in TypeScript for tags and operations
- Remove inline "Related guides" sections from OpenAPI descriptions
- Move related links to structured x-influxdatadocs-related arrays
- Add weight support for Quick start pages (weight: 1) to appear first in nav
- Update clustered and cloud-dedicated v2/ref.yml specs
- Replace /api/management/ links with appropriate alternatives
- Link to Database tokens API for token creation
- Use "Management operations" text instead of broken links
- Update Quick start to link to Databases API
- Update Authentication tag to cover both token types (management + database)
- Update Quick start to cover complete workflow (setup → write → query)
- Add dual download buttons on API landing pages
- Add context-aware download buttons on tag pages
- Remove old v2 HTML pages and duplicate auth directories
- Clean up management API specs (remove duplicate auth tags)
Part of API reference migration from Redoc to RapiDoc.
Update the Quick start section in Clustered and Cloud Dedicated Data API
specs to cover the full getting started flow including:
- Creating a management token via influxctl
- Creating a database via Management API
- Creating a database token via Management API
- Writing data via Data API
- Querying data via Flight or HTTP API
Add comprehensive authentication documentation that explains:
- Token types table (Management token vs Database token)
- Authentication schemes table with token type, endpoints, and header format
- Links to Management API authentication for management token usage
Updated in both Clustered and Cloud Dedicated Data API specs.
Add Redocly overlay pattern for InfluxDB v1 OSS and Enterprise APIs,
making them consistent with other products in the repository.
Changes:
- Create .config.yml and content overlays (info.yml, servers.yml) for
both influxdb/v1 and enterprise_influxdb/v1
- Add updateOSSV1() and updateEnterpriseV1() functions to getswagger.sh
- Remove set-tag-groups decorator and all tag-groups.yml files
The tag-groups feature was a Redoc-specific workaround for navigation
grouping that is no longer needed with the Hugo/RapiDoc architecture.
- Add data/article_data/ to .gitignore
- Integrate generate-openapi-articles into generate-api-docs.sh
- Remove tracked article_data files (now generated at build time)
This avoids large data file diffs in PRs and ensures article data
stays in sync with OpenAPI specs.
- Add tag-based article generation with operation grouping
- Support x-influxdata-related field for related content links
- Improve spec transformation with documentation link handling
- Add JSON output alongside YAML for article data
- Enhance path and tag spec generation for per-operation pages
- Add get-started/migrate-from-influxdb-v1-v2.md pages for Core and Enterprise
- Move migration link from info description to x-influxdata-related field
- Remove all Redoc-style links (#operation/, #section/) from spec descriptions
- Rename x-influxdata-guides to x-influxdata-related throughout
- Update Core info description to match Enterprise format
- Regenerate article data for both products
- Add brief summary sentences to OpenAPI tag descriptions for better
display in children lists (API compatibility, Authentication,
Common parameters, Quick start)
- Rename Management API "Authentication" to "Admin authentication
(management operations)" to distinguish from data API authentication
- Standardize "Quick start" tag naming (was "Quickstart" in some specs)
- Regenerate article data for cloud-dedicated, clustered, cloud-serverless
Fixes:
- Remove stray </li> tag in api-menu-items.html causing invalid HTML
- Reformat minified sidebar template for maintainability
- Rebuild compiled JS to sync generatePathPages disabled state
- Update all-endpoints links to use tag page URLs with hash anchors
(e.g., /api/cache-data/#post-/api/v3/configure/distinct_cache)
instead of now-removed path pages
Groups operations by API path instead of creating one page per method.
Each path page shows all HTTP methods using RapiDoc with match-type='includes'.
- Renamed generateOperationPages to generatePathPages
- Changed type from 'api-operation' to 'api-path'
- Changed layout from 'operation' to 'path'
- Groups multiple HTTP methods under same path into single page
- Sorts operations by method order: GET, POST, PUT, PATCH, DELETE
- Collects related links from all operations on the path
- Updates identify-version guide and Core/Ent3 API specs
- Use GET. HEAD `/ping` responds with `404`
- Specify default auth requirement for Enterprise
- Tested with Core and Ent v3.8.0
- Add "All endpoints" page showing all operations grouped by API version
- Generate all-endpoints page automatically via TypeScript generation script
- Make "All endpoints" nav item a clickable link instead of just a toggle
- Fix duplicate menu entry warnings for cloud-v2 and oss-v2 products
by adding skipParentMenu: true to their configs
- Fix 404 errors for paths with curly braces (e.g., {request_path})
by removing braces in normalize-path.html partial
- Add Cypress tests for API section structure and all-endpoints page
- Update v2 product article data with tag-based generation
- Fix apiPathToSlug() to strip curly braces from path parameters
(e.g., {db} → db) to avoid URL encoding issues in Hugo
- Update Quick start tag description to include intro sentence:
"Authenticate, write, and query with the API:"
- Remove {{< children >}} shortcode from API section _index.md files
(layout's section-children.html partial already handles tag listing)
- Delete old cloud-serverless API pages with curly braces in paths
- Regenerate article data for all products
Add useTagBasedGeneration: true to clustered config to properly
generate tag-based API documentation pages for the management API,
consistent with cloud-dedicated and cloud-serverless configurations.
- Fix specFile path from non-existent management/openapi.yml to v2/ref.yml
- Enable useTagBasedGeneration for consistency with other InfluxDB 3 products
- Update comments to clarify that Cloud Serverless uses standard v2 API
(not management API like Cloud Dedicated and Clustered)
Cloud Serverless API docs now generate 29 tag-based pages and 125 operation
pages from the v2 API spec.
Cloud Dedicated's management API uses paths like /accounts/{accountId}/...
which can't be used directly as Hugo URLs (curly braces get stripped).
Enable useTagBasedGeneration to group operations by OpenAPI tags instead
(Authentication, Databases, Database tokens, etc.) matching the pattern
used by influxdb3-core and influxdb3-enterprise.
- Add normalize-path.html partial for consistent path normalization
- Strip /api prefix and add v1/ for paths without version
- Update generate-openapi-articles.ts with same normalization logic
- Update list.html and sidebar menu to use normalized paths
- Document AWS credentials in deploy-staging.sh
* fix(api): refine .IsSection check to prevent breaking endpoint pages
The previous commit added an .IsSection check that correctly fixed
section index pages but inadvertently broke endpoint pages that Hugo
classifies as sections.
This commit refines the conditional to check for the absence of the
staticFilePath parameter, which distinguishes true section index pages
from endpoint pages that need the RapiDoc renderer:
- Section pages (no staticFilePath): Show children listing
- Endpoint pages (with staticFilePath): Use RapiDoc renderer
Fixes the regression introduced in commit 59daf17.
* chore: update Scalar references to RapiDoc in comments
Update code comments and documentation to accurately reflect that
the API documentation uses RapiDoc, not Scalar:
- api-docs/scripts/generate-openapi-articles.ts: Update JSDoc comments
- api-docs/scripts/dist/generate-openapi-articles.js: Update compiled version
- assets/js/components/api-toc.ts: Update implementation comment
- .claude/agents/ts-component-dev.md: Update component reference
- .claude/skills/hugo-template-dev/SKILL.md: Update component reference
The implementation uses RapiDoc throughout, so these comments needed
to be corrected for accuracy.
---------
Co-authored-by: Claude <noreply@anthropic.com>
Fixed two issues causing Hugo warnings about duplicate menu entries:
1. Path generation bug: apiPathToSlug returns 'api/v3/...' for paths
starting with '/api/', but the generator always prepended 'api/',
creating 'api/api/v3/...' paths.
Fix: Only add 'api/' prefix if path doesn't already start with it.
2. Config inconsistency: cloud-dedicated, cloud-serverless, and clustered
had '/api' in pagesDir while core/enterprise didn't. The function
always adds '/api', causing double prefixes for some products.
Fix: Removed '/api' from pagesDir for affected products to match
core/enterprise pattern.
Auth credentials:
- Switch from in-memory to sessionStorage for credentials
- Credentials persist across page navigations within browser tab
- Auto-clear when tab closes (no long-term storage)
- Pre-fill form fields with saved credentials on page load
- Update status text and button based on credential state
Styling fixes:
- Add right padding to code blocks so Copy button doesn't overlap content
- Make long URLs wrap instead of requiring horizontal scroll
- Hide TOC sidebar when no headings exist (e.g., quick-start page)
- Remove "Use RapiDoc's navigation..." message from TOC
API docs:
- Remove x-codeSamples from write_lp endpoints (Core and Enterprise)
- Add schema descriptions for line protocol request body
Add showSecuritySchemes field handling to generate-openapi-articles.ts
to ensure the flag is written to content frontmatter. Regenerate API
docs for cloud-dedicated and clustered products.
Add showSecuritySchemes field to Article interface and automatically
set it to true for Authentication tag pages. This ensures the Security
Schemes section renders on authentication pages after API docs are
regenerated.
Transform /influxdb/version/ placeholders in OpenAPI spec description
and summary fields to product-specific paths at build time.
- Add deriveProductPath() to extract product path from spec location
- Add transformDocLinks() to recursively transform markdown links
- Add validateDocLinks() with --validate-links CLI flag for checking
- Integrate transformation into processProduct() workflow
- Add placeholder links to Authorization header descriptions
The product path is derived from the spec file location, so
api-docs/influxdb3/core/v3/ref.yml produces /influxdb3/core paths.
- Convert collapsible auth panel to popover UI triggered by
"Set credentials" button positioned above RapiDoc
- Filter auth schemes based on API path:
- /api/v3/* endpoints: Bearer only
- /api/v2/* endpoints: Bearer + Token
- /write, /query (v1): All 4 schemes
- Fix "Authentication Not Required" bug by adding global security
field to path-specific OpenAPI specs
- Change RapiDoc --blue CSS variable to green so status text and
type links don't look like clickable links
- Add explicit button styling for Apply/Clear in popover
- Hide RapiDoc's built-in auth section (use custom popover instead)
- Set global security to BearerAuthentication only (best practice)
- Add per-operation security to v1 endpoints (all 4 auth schemes)
- Add per-operation security to v2 endpoint (Bearer + Token)
- Add no-auth option for initial token creation endpoint
- Fix TOC sidebar to include security scheme headings (move id to h3)
- Update Authentication tag table to accurately describe endpoint support
- Update api_nav_groups.yml to use "Auth token" instead of "Token"
- Remove x-tagGroups from Core and Enterprise specs (Redoc-specific, not needed for RapiDoc)
- Add migration notes to plan document for future product migrations
- Restore original RapiDoc match-paths format (method /path) for proper filtering
- Restrict operation tags to primary tag in tag-specific specs to prevent duplicates
- Rename Token tag to Auth token for clarity in Core and Enterprise specs
- Remove Table tag from cache operations (distinct_cache, last_cache)
- Add build script combining API docs, Hugo, and Markdown generation
- Skip summary rendering for conceptual pages
- Add isConceptual check to hide operations in nav for conceptual pages
Jason Stirnaman