Skip to content

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

Merged
jstirnaman merged 2 commits intomasterfrom
chore/update-generate-docs-version
Nov 8, 2022
Merged

chore: use /latest alias for OSS URL substitutions.#603
jstirnaman merged 2 commits intomasterfrom
chore/update-generate-docs-version

Conversation

@jstirnaman
Copy link
Copy Markdown
Contributor

@jstirnaman jstirnaman commented Nov 4, 2022

No description provided.

@jstirnaman jstirnaman requested a review from a team as a code owner November 4, 2022 22:10
@jstirnaman jstirnaman force-pushed the chore/update-generate-docs-version branch from 7dfe045 to 108faea Compare November 4, 2022 22:12
sanderson
sanderson approved these changes Nov 4, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@sanderson sanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jstirnaman
Copy link
Copy Markdown
Contributor Author

jstirnaman commented Nov 4, 2022

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.

glinton
glinton approved these changes Nov 7, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@glinton glinton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't feel like I have enough meaningful understanding to say whether this will make a negative impact or not, but the swagger is valid.

@jstirnaman jstirnaman merged commit c7fbace into master Nov 8, 2022
@jstirnaman jstirnaman deleted the chore/update-generate-docs-version branch November 8, 2022 16:40
jstirnaman added a commit that referenced this pull request Nov 8, 2022
@jstirnaman
Merge branch 'master' of github.com:influxdata/openapi into docs/auths
e9066ae 
* 'master' of github.com:influxdata/openapi:
  chore: use /latest alias for OSS URL substitutions. (#603)
  fix(bucket schemas): `requestBody` for `createMeasurementSchema` and `updateMeasurementSchema` should be required (#607)
  fix(tasks): `orgID` should not be required for GetTasks (#606)
  chore(aim): Add Operator Entitlements Endpoints (#595)
  chore(aim): Add 403 to Org Creation Endpoints (#597)
  chore(invocable-scripts): add /api/v2/scripts/SCRIPT_ID/params (#593)
  Chore/api reference scripts delete (#444)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sanderson sanderson sanderson approved these changes

+2 more reviewers

@glinton glinton glinton approved these changes

@sunbryely-influxdata sunbryely-influxdata sunbryely-influxdata approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jstirnaman @sanderson @glinton @sunbryely-influxdata