feat(api): Allow fetching team details without projects #13935
Merged
Conversation
This file contains 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
This allows you to fetch team details that do not include projects, which improves performance.
billyvg
force-pushed
the
feat/api/add-project-less-team-details
branch
from
4405a5c to
71f52d2
Compare
| @@ -81,6 +81,7 @@ def get(self, request, organization): | |||
|
|
|||
| :pparam string organization_slug: the slug of the organization for | |||
| which the teams should be listed. | |||
| :param string detailed: Specify "0" to return team details that do not include projects | |||
There was a problem hiding this comment.
Would a better name be sparse? And then it can do the inverse here.
There was a problem hiding this comment.
We use detailed elsewhere, and I think that makes sense in terms of how we'd like our API to behave. Ideally our default behaviour becomes not detailed, and people have to explicitly ask for detailed, and so pass detailed=1
There was a problem hiding this comment.
See this thread #13925 (comment)
wedamija
approved these changes
Jul 30, 2019
| @@ -81,6 +81,7 @@ def get(self, request, organization): | |||
|
|
|||
| :pparam string organization_slug: the slug of the organization for | |||
| which the teams should be listed. | |||
| :param string detailed: Specify "0" to return team details that do not include projects | |||
There was a problem hiding this comment.
We use detailed elsewhere, and I think that makes sense in terms of how we'd like our API to behave. Ideally our default behaviour becomes not detailed, and people have to explicitly ask for detailed, and so pass detailed=1
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This allows you to fetch team details that do not include projects, which
improves performance.