Commit Graph

19 Commits (feat-api-uplift)

Author SHA1 Message Date
Jason Stirnaman 32b64f3d7d task(plans): organize 2026-03-09 21:47:45 -05:00
Jason Stirnaman df9c9977cf feat(api): add inline curl examples and Ask AI links to API operations
Generate curl examples at Hugo template time from OpenAPI specs, with
server URL variable resolution, $ref handling, and JSON body generation
from schema properties. Add "Ask AI about this example" links using
existing Kapa integration. Add client library related link to all
InfluxDB 3 API tag pages. Improve visual separation between operations
with distinct badge colors and response body indentation.
2026-03-07 23:00:22 -06:00
Claude 0e1b8003c0
docs(plan): add API code samples, Ask AI, and client library integration design
Covers 4 phases: inline curl examples from OpenAPI specs, response body
schema rendering, Ask AI on code blocks, and client library integration
with tabbed language samples for write/query operations.

https://claude.ai/code/session_01P1FJ4g1aQmSmQAH9BCmKZr
2026-03-07 23:13:34 +00:00
Jason Stirnaman 3c580d33dd docs(plan): add Hugo-native API migration plan with workflow fixes 2026-02-13 11:49:42 -06:00
Jason Stirnaman f1b9ea5bc4 feat(api): unified API structure for Clustered and Cloud Dedicated
- 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.
2026-02-06 11:17:53 -06:00
Jason Stirnaman b835d15baf docs(api): add design for Clustered/Cloud Dedicated API structure
Unified API documentation with:
- Single nav combining Data API and Management API tags
- Dual download buttons on landing page
- Unified Authentication page covering both token types
- Cleanup of old v2 HTML pages and duplicate auth directories
2026-02-06 10:51:00 -06:00
Jason Stirnaman 5bb78e9c52 docs(api): add API link migration implementation plan 2026-02-04 11:19:08 -06:00
Jason Stirnaman c47db43e50 docs(api): add API link migration design for RapiDoc anchors 2026-02-04 11:14:14 -06:00
Jason Stirnaman 727a9befb7 feat(api): consolidate API docs to tag pages with inline operations
Migrate API documentation from individual operation pages to tag pages
where all operations for a tag are rendered inline using RapiDoc.

Key changes:
- Remove operation links from left sidebar (tags only, no children)
- Generate server-side TOC from frontmatter operations array
- Show method badge + human-readable summary in TOC (not paths)
- Support hash-based navigation (#post-/api/v3/configure/distinct_cache)
- RapiDoc scrollToPath() handles TOC clicks to shadow DOM elements
- goto-path attribute initializes to operation from URL hash
- update-route attribute updates URL hash as user navigates

Files created:
- layouts/partials/api/rapidoc-tag.html

Files removed:
- layouts/api-path/path.html (path page layout)
- layouts/partials/api/rapidoc-path.html (path page partial)
- Old design documents superseded by 2026-01-21 version

Files modified:
- layouts/api/list.html (embed RapiDoc, server-side TOC)
- layouts/api/section.html (simplified section layout)
- layouts/_default/api.html (fallback layout cleanup)
- layouts/partials/sidebar/api-menu-items.html (remove op children)
- assets/js/components/rapidoc-mini.ts (tag page support)
- assets/js/components/api-toc.ts (RapiDoc navigation)
- api-docs/scripts/generate-openapi-articles.ts (disable path pages)
2026-01-29 23:46:09 -06:00
Jason Stirnaman 40406e1574 docs: add API tag pages design document 2026-01-21 10:32:32 -06:00
Jason Stirnaman 68d0a1e4cb docs: add API path pages implementation plan
Detailed step-by-step plan for replacing operation-level pages
with path-level pages that show all HTTP methods per endpoint.
2026-01-20 12:41:20 -06:00
Jason Stirnaman 76579d9d13 docs: add API path pages design document
Design for generating path-level API pages instead of operation-level pages.
Key changes:
- URLs like /api/v3/configure/token/admin/ show all HTTP methods
- Uses RapiDoc match-type=includes for path filtering
- Improves SEO, UX, and reduces nav clutter
2026-01-16 17:15:09 -06:00
Jason Stirnaman ed65fb4bee chore: remove design files 2026-01-02 16:42:30 -06:00
Jason Stirnaman 31d9bfc452 chore: remove openapi-link-processing design doc from tracking 2026-01-02 16:42:29 -06:00
Jason Stirnaman 4369a86d29 docs(api): add OpenAPI link processing design
Design for transforming /influxdb/version/ placeholders in OpenAPI
spec descriptions to product-specific paths at build time.
2026-01-02 16:42:29 -06:00
Jason Stirnaman e2939dc715 refactor(api): Remove Scalar renderer and related code
Remove unused Scalar API documentation renderer:
- Delete layouts/partials/api/scalar.html
- Delete assets/js/components/api-scalar.ts
- Simplify renderer.html to only use RapiDoc
- Remove ApiScalar from main.js component registry
- Remove apiRenderer config option from hugo.yml
2026-01-02 16:42:28 -06:00
Jason Stirnaman 5610b7bdf3 fix(api): Complete Auth token rename and remove Redoc x-tagGroups
- 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
2026-01-02 16:42:27 -06:00
Jason Stirnaman 2fa00a36d2 fix(api): Fix RapiDoc operation filtering and improve API reference quality
- 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
2026-01-02 16:42:27 -06:00
Jason Stirnaman fb2f1867de
feat(claude): add docs-cli-workflow skill and update hugo-template-dev (#6614)
* chore(claude): Add claude skill for Hugo development/testing workflow. Split ui-dev subagent into hugo-, ts-, and testing-specific agents.

* chore(claude): Update ui-testing agent and hugo-template-dev skill

* docs(plans): add docs-cli-workflow skill design

Design for a Claude Code skill that guides when to use
docs create/edit CLI tools versus direct file editing.

* feat(claude): add docs-cli-workflow skill

Guides Claude to suggest docs create/edit CLI tools when appropriate:
- Keyword-triggered activation (new page, edit URL, etc.)
- Decision matrix for create vs edit vs direct editing
- Suggestion templates with user confirmation
- Edge case handling

Addresses under-utilization of CLI scaffolding tools.

* chore(claude): add console error testing pattern to hugo-template-dev skill

Add Cypress pattern for catching JavaScript console errors during
component testing - useful for runtime errors, JSON parsing failures,
and template data binding issues.
2025-12-10 16:36:08 -06:00