Move userId in API from route to optional query parameter #11071
Conversation
Changes in OpenAPI specification found. Expand to see details.What's New
|
nielsvanvelzen
force-pushed
the
api-userid-optional3
branch
from
ccf150e
to
de5ae35
Compare
| [FromRoute, Required] Guid userId, | ||
| [FromQuery] bool? includeExternalContent, | ||
| [FromQuery, ModelBinder(typeof(CommaDelimitedArrayModelBinder))] CollectionType?[] presetViews, | ||
| [FromQuery] bool includeHidden = false) => GetUserViews(userId, includeExternalContent, presetViews, includeHidden); |
There was a problem hiding this comment.
| [FromQuery] bool includeHidden = false) => GetUserViews(userId, includeExternalContent, presetViews, includeHidden); | |
| [FromQuery] bool includeHidden = false) | |
| => GetUserViews(userId, includeExternalContent, presetViews, includeHidden); |
The only suggestion I have is to place the expression body on the next line- when I first read through this I thought it was magic
There was a problem hiding this comment.
The server is full of crazy linters that complain about all my formatting, so I auto-formatted using Rider.
There was a problem hiding this comment.
Like really, I don't want to start another tabs vs spaces like war but this is the only sane way to format it and somehow we decided to not do this.
There was a problem hiding this comment.
don't bring your kotlin into this 🥇
jellyfin-bot
added
the
merge conflict
|
This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged. |
This is a proof of concept, looking for feedback to see if this is the right way to fix this problem or if there are better methods.
Right now it changes 2 operations: GetUserViews and GetGroupingOptions, both part of UserViewsController. There are 37 more operations that will need a similar change. I've tested this with the unstable version of jellyfin-web and the old endpoints still work so this is not a breaking API change.
Changes
Move userId in API from route to optional query parameter by adding new endpoints (with new routes!!) that move the userId to a query parameter. The old endpoints are kept but made obsolete and hidden from the OpenAPI specification.
With this change it is no longer required to provide a user id in the API, together with #11024 and #11028. This makes is a lot easier to use our API/SDK's and develop clients, as you no longer need to keep track of the current user id to use the API.
Issues