influxdata / openapi

An OpenAPI specification for influx (cloud/oss) apis.
MIT License
17 stars 10 forks source link

chore: use /latest alias for OSS URL substitutions. #603

Closed jstirnaman closed 1 year ago

jstirnaman commented 1 year ago

Approved. Just one question. Will these links persist through to the rendered documentation or are we replacing them with redoc? If they are persisting, this will likely lead to unintended version switches if a user is looking at an older version of the docs and clicks on one of these links. It will switch them to the newest version and they may not realize it.

At first, I was hesitant to use /latest for that reason. But now, I think it might be better that we don't have to update the version in openapi. In docs-v2, we can rollback (find-and-replace) to the v[OldVersion] in the old docs-v2 contracts as needed when updating. Still too fiddly, though - gotta fix that.