Skip to content

API: use restricted serializer for related projects #11820

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 6 commits into from
Jan 13, 2025

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Dec 3, 2024

@stsewd stsewd requested a review from a team as a code owner December 3, 2024 21:55
@stsewd stsewd requested a review from humitos December 3, 2024 21:55
model = Project
fields = [
"id",
"name",
Copy link
Member Author

Choose a reason for hiding this comment

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

I wonder if we should exclude the name from restricted objects as well (restricted organization is the other serializer like this)

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

I'm confused about what we talked in our meeting and what we are implementing here. I understood we were going in another direction. Can you explain more your thoughts here and what are the next steps based on the context I've shared?

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This approach seems good to me. I'm not in love with doing a bunch of nested values in API responses, and I think in general folks can re-query the API for the returned project if they need the data.

Not sure if we need a note in the API docs/blog about this, or if we're just guessing folks aren't currently using this data?

@stsewd stsewd requested a review from a team as a code owner January 13, 2025 15:40
@stsewd stsewd requested a review from agjohnson January 13, 2025 15:40
@stsewd
Copy link
Member Author

stsewd commented Jan 13, 2025

Not sure if we need a note in the API docs/blog about this, or if we're just guessing folks aren't currently using this data?

Putted a note in the docs

@stsewd stsewd merged commit 1ab641a into main Jan 13, 2025
8 checks passed
@stsewd stsewd deleted the use-restricted-serializer-for-related-projects branch January 13, 2025 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants