docs(api): Update get team projects api to use drf/openapi #50676
Conversation
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
github-actions
bot
added
the
Scope: Backend
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #50676 +/- ##
=======================================
Coverage 81.17% 81.17%
=======================================
Files 4860 4861 +1
Lines 204027 204037 +10
Branches 11159 11159
=======================================
+ Hits 165618 165629 +11
+ Misses 38163 38162 -1
Partials 246 246
|
schew2381
force-pushed
the
seiji/fix/update-get-team-projects-api
branch
from
356a349 to
060f76f
Compare
schew2381
force-pushed
the
seiji/fix/update-get-team-projects-api
branch
from
060f76f to
a68dc59
Compare
schew2381
commented
Jun 9, 2023
Comment on lines
-96
to
-98
| "/api/0/teams/{organization_slug}/{team_slug}/projects/": { | ||
| "$ref": "paths/teams/projects.json" | ||
| }, |
There was a problem hiding this comment.
Delete path so both POST and GET can use drf-spectacular
schew2381
commented
Jun 9, 2023
There was a problem hiding this comment.
Tested the GET but can be safely deleted b/c type checking is done through drf-spectacular
schew2381
commented
Jun 9, 2023
| @@ -231,6 +231,7 @@ class ProjectSerializerBaseResponse(_ProjectSerializerOptionalBaseResponse): | |||
| firstTransactionEvent: bool | |||
| access: List[str] | |||
| hasAccess: bool | |||
| hasMinifiedStackTrace: bool | |||
There was a problem hiding this comment.
Project model typed dict was missing this field
schew2381
commented
Jun 9, 2023
| @@ -37,11 +37,14 @@ class OrganizationExamples: | |||
| "hasSessions": True, | |||
| "hasProfiles": True, | |||
| "hasReplays": True, | |||
| "hasMinifiedStackTrace": False, | |||
There was a problem hiding this comment.
This had to be added to this OpenApiExample to comply with adding the field to the Project Model typed dict
JoshFerge
approved these changes
Jun 10, 2023
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.
Update GET team projects to use drf-spectacular. All that's changed is the example 200 response and permission scopes. The new response can be seen in this github gist
Before:
After:
