Skip to content

Add description to OpenAPI schemas (Fixes #4473) #4539

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 1 commit into from
Jun 13, 2025

Conversation

miguelgrinberg
Copy link
Contributor

The schema description wasn't being included in the OpenAPI export.

@miguelgrinberg miguelgrinberg requested a review from a team as a code owner June 12, 2025 13:05
@miguelgrinberg miguelgrinberg requested review from lcawl and a team and removed request for a team June 12, 2025 13:06
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.

Yay, great to see all these additional details in the OpenAPI files!

@miguelgrinberg miguelgrinberg force-pushed the add-descriptions-to-schemas branch from d845fc7 to c94b428 Compare June 13, 2025 09:29
@miguelgrinberg miguelgrinberg merged commit 2eeacf8 into main Jun 13, 2025
8 checks passed
@miguelgrinberg miguelgrinberg deleted the add-descriptions-to-schemas branch June 13, 2025 09:35
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-4539-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2eeacf8fdf4be332aa886ac20559706435c178dc
# Push it to GitHub
git push --set-upstream origin backport-4539-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-4539-to-9.0.

Copy link
Contributor

The backport to 8.19 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-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-4539-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2eeacf8fdf4be332aa886ac20559706435c178dc
# Push it to GitHub
git push --set-upstream origin backport-4539-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

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

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.

3 participants