Commit Graph

2 Commits (api-docs-uplift)

Author SHA1 Message Date
Jason Stirnaman 9a385c6927 fix(api-docs): scope Cloud Serverless spec to supported endpoints, absolutify download links
- Rewrite info.yml description to list supported endpoints (write, query,
  authorizations, buckets, orgs) and disclaim unsupported Cloud (TSM) endpoints
- Comment out unsupported Cloud (TSM) paths in spec, keeping 29 supported paths
- Convert orphaned Cloud (TSM) tags to x-traitTag with disclaimer
- Strip all Redoc-specific anchor links (#operation/, #tag/, #section/) from
  spec descriptions and tags.yml — these break in the Hugo-native layout
- Fix product name: "InfluxDB 3 Serverless" → "InfluxDB Cloud Serverless"
- Add absolutifyLinks() to generate-openapi-articles.ts so static/openapi
  downloads contain full URLs (https://docs.influxdata.com/...) while Hugo
  pages keep relative paths
2026-03-16 15:05:39 -05:00
Jason Stirnaman aa863012a5 feat(api-docs): add tag post-processor and per-product tags.yml configs
Add apply-tag-config.ts that reads colocated tags.yml files and patches
OpenAPI spec tags in place (descriptions, x-related links, renames).
Runs between getswagger.sh and generate-openapi-articles.ts in the
build pipeline.

Create tags.yml for all 11 product specs:
- Core, Enterprise: extracted from existing spec tag metadata
- v2-compat, v2, v1: new descriptions and x-related links

Include test suite (16 assertions) covering description setting, tag
rename propagation, x-related links, stale/uncovered tag warnings,
silent skip when no config, and malformed YAML failure.
2026-03-10 14:23:37 -05:00