Repository navigation
Conversation
The API spec marks description as required on each listed pull request, so typed SDKs failed to parse list responses that omitted it. Closes #9760
UdiBen
added
the
include-changelog
Listing pull requests needs only pr:ListPullRequests, while a description needs pr:ReadPullRequest. The list must not leak descriptions to callers who can only list. Make description optional on PullRequest in the spec instead, so typed SDKs accept list responses without it. Regenerate the SDKs.
github-actions
Bot
added
area/API
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #9760
Change Description
Bug Fix
Background
Descriptions stay out of the list on purpose. Listing pull requests needs only
pr:ListPullRequests, while reading one needspr:ReadPullRequest. A user who can only list must not see descriptions. Both permissions apply to a whole repository.We rejected returning the description in the list. That would show descriptions to users who can only list.
The same fix for lakeFS Enterprise is treeverse/lakeFS-Enterprise#4397.
Testing Details
The list pull requests controller test now checks that listed pull requests have no description.
Breaking Change?
SDK types only.
descriptionbecomes optional in Python and nullable in Java. In Rust it becomesOption<String>, andPullRequest::newno longer takes a description. Callers who need the description fetch the single pull request.