influxdata / influxdata/openapi

Replace docs-v2 `influxdb/latest` URL paths with `influxdb/v2` in generated contracts

Open Beginner friendly
#657 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

`influxdata/openapi` contracts still contain links to InfluxDB v2 as `influxdb/latest` instead of `influxdb/v2`. Generated `contracts/ref/oss.yml` affect anyone consuming that contract directly — SDK generators, other docs consumers, anyone reading the file.
However, docs-v2 is no longer a motivating case for the fix, so it's a hygiene issue in this repo.

influxdata/docs-v2 half of this is fixed by #7697** (`7bd1659`, "move OSS v2 and Cloud v2 spec decorators to build time").
That change adds `applyMirrorTransforms` in `post-process-specs.ts`, which rewrites `https://docs.influxdata.com/influxdb/latest/` and bare `/influxdb/latest/` to the product root at build time.

_Originally posted by @jstirnaman in [#7666](https://github.com/influxdata/docs-v2/issues/7666#issuecomment-5399887071)_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with generated contracts/ref/oss.yml and search for remaining `influxdb/latest` URL paths, then trace how that contract is generated to identify the source to update. Done means the generated contract uses `influxdb/v2` consistently; verify that no incorrect `influxdb/latest` paths remain in the affected contract.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, yaml
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.