Skip to content

Add 8.18 documentation URLs to schema and OpenAPI #4638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 20, 2025

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Jun 20, 2025

Fixes #4369

The table.csv file now has a third column with the 8.18 documentation URL, if available. The mapping that was used comes from this spreadsheet.

These 8.18 docs URLs are imported in the new extLegacyDocUrl field of the schema. The OpenAPI generator then uses it to generate a x-legacyUrl extension inside the Documentation object. The name x-legacyUrl is made up by me, we can change it if there is a better suggestion, and in general, if there is a better word than legacy to use for this information let me know and I'll replace it.

@miguelgrinberg miguelgrinberg marked this pull request as ready for review June 20, 2025 14:40
@miguelgrinberg miguelgrinberg requested a review from a team as a code owner June 20, 2025 14:40
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Output and table.csv LGTM

Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

LGTM. Left a nitpick.

@miguelgrinberg miguelgrinberg merged commit 6f0fe00 into main Jun 20, 2025
10 checks passed
@miguelgrinberg miguelgrinberg deleted the add-legacy-doc-urls branch June 20, 2025 17:53
Copy link
Contributor

The backport to 9.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-4638-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6f0fe001aa90f0f79da7eac081c62ceffee99e7b
# Push it to GitHub
git push --set-upstream origin backport-4638-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0

Then, create a pull request where the base branch is 9.0 and the compare/head branch is backport-4638-to-9.0.

miguelgrinberg added a commit that referenced this pull request Jun 20, 2025
* Add 8.18 documentation URLs to schema and OpenAPI

* generated files

* rename legacy -> previous_version
miguelgrinberg added a commit that referenced this pull request Jun 20, 2025
* Add 8.18 documentation URLs to schema and OpenAPI

* generated files

* rename legacy -> previous_version
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add mapping to old docs
3 participants