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

Nobody has claimed this yet.

Assessment

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

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.

Description

documentation

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

Dominant language
Shell
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from influxdata/openapi

All issues in influxdata/openapi

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.