-
Notifications
You must be signed in to change notification settings - Fork 30
🐛 Fix webserver storage OpenAPI schema #4426
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
🐛 Fix webserver storage OpenAPI schema #4426
Conversation
Code Climate has analyzed commit ebbc7e5 and detected 0 issues on this pull request. View more on Code Climate. |
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## master #4426 +/- ##
=========================================
- Coverage 85.9% 84.8% -1.2%
=========================================
Files 952 395 -557
Lines 41702 20791 -20911
Branches 1004 173 -831
=========================================
- Hits 35849 17641 -18208
+ Misses 5619 3101 -2518
+ Partials 234 49 -185
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
# slashes, and when applying validation via `StorageFileID` | ||
# it raises an error. Before `StorageFileID`, `str` was the | ||
# type used in the OpenAPI specs. | ||
StorageFileIDStr: TypeAlias = str |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I understand that StorageFileID
(which is itself a str
) is too restrictive, right?
- Why do we define this id?
- If this is not the ID I want for the API, shouldn't you call it
AnyFileIDStr
instead ofStorageFileIDStr
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you look at the tests, the incoming string is very closely related to this StorageFileID
type. Though, the one incoming has the character "/" url encoded twice.
So I wanted to give an idea that the type should be something related to the original StorageFileID
. Also I did not want to break how everything is working at the moment, since this double encoded slash url is generated by the backend, there must be a reason for it.
What do these changes do?
Related issue/s
How to test
DevOps Checklist