fix: Update OpenAPI type to Array from string #465
Conversation
| @extend_schema( | ||
| summary="Repository list", | ||
| parameters=[ | ||
| OpenApiParameter( |
There was a problem hiding this comment.
Inspiration from this thread: tfranzel/drf-spectacular#267
| OpenApiParameter( | ||
| name="names", | ||
| type={"type": "array", "items": "string"}, | ||
| explode=True, |
There was a problem hiding this comment.
Added explode after reading about it here: https://swagger.io/docs/specification/describing-parameters/
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #465 +/- ##
=======================================
Coverage 96.05% 96.05%
=======================================
Files 643 643
Lines 17127 17127
=======================================
Hits 16451 16451
Misses 676 676
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ Coverage Diff @@
## main #465 +/- ##
=======================================
Coverage 96.05% 96.05%
=======================================
Files 643 643
Lines 17127 17127
=======================================
Hits 16451 16451
Misses 676 676
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #465 +/- ##
=======================================
- Coverage 95.78 95.77 -0.01
=======================================
Files 765 765
Lines 17706 17694 -12
=======================================
- Hits 16958 16946 -12
Misses 748 748
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Purpose/Motivation
Update openAPI type from string to array for better clarity on the docs here: https://docs.codecov.com/reference/repos_list
Links to relevant tickets
closes codecov/feedback#284
What does this PR do?
Screenshots
Notes to Reviewer
Anything to note to the team? Any tips on how to review, or where to start?
Legal Boilerplate
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.