Skip to content
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

Remove SessionInfo.FullNowPlayingItem from API responses #11268

Merged

Conversation

nielsvanvelzen
Copy link
Member

I guess this is regression from when we moved over to ASP.NET. Seems to be available starting from our first OpenAPI schema.

There are two properties in SessionInfo:

  • NowPlayingItem (BaseItemDto)
  • FullNowPlayingItem (BaseItem)

The second one is the only place in the API that "exposes" BaseItem (the non-dto one). All other places use BaseItemDto. Fortunately, the property is nullable and an org-wide search shows none of our clients use FullNowPlayingItem. So removing it should not have any impact.

Changes

  • Remove SessionInfo.FullNowPlayingItem from API responses

Issues

Partial fix for #11244, other exposed types like ClientCapabilities need a proper SessionInfoDto.

Copy link

Changes in OpenAPI specification found. Expand to see details.

What's Changed


GET /Sessions
Return Type:

Changed response : 200 OK

List of sessions returned.

  • Changed content type : application/json

Changed items (object):

Class SessionInfo.

openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="CamelCase"

Changed items (object):

Class SessionInfo.

openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="PascalCase"

Changed items (object):

Class SessionInfo.

openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

POST /Users/AuthenticateByName
Return Type:

Changed response : 200 OK

User authenticated.

  • Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

POST /Users/AuthenticateWithQuickConnect
Return Type:

Changed response : 200 OK

User authenticated.

  • Changed content type : application/json

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="CamelCase"

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

  • Changed content type : application/json; profile="PascalCase"

openapi-base openapi-changes.md openapi-head Changed property SessionInfo (object)

Class SessionInfo.

Updated SessionInfo :
openapi-base openapi-changes.md openapi-head Deleted property FullNowPlayingItem (object)

Class BaseItem.

@nielsvanvelzen nielsvanvelzen added the bug Something isn't working label Mar 31, 2024
@crobibero crobibero merged commit 904c387 into jellyfin:master Mar 31, 2024
14 checks passed
@nielsvanvelzen nielsvanvelzen deleted the api-session-info-no-full-item branch March 31, 2024 20:49
SourSulfur pushed a commit to SourSulfur/jellyfin that referenced this pull request Apr 19, 2024
SourSulfur pushed a commit to SourSulfur/jellyfin that referenced this pull request Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants