Skip to content

Conversation

nielsvanvelzen
Copy link
Member

Changes

This PR backports #13821 and part of #13277 to use the "Unknown" enum member as default value for all non-nullable properties in the API using an enum that has an Unknown member.

This is specifically needed in a 10.10 backport so a client build with the 10.10.7 API can still read responses from a 10.11 server now with the breaking API changes from #13277.

Issues

gnattu and others added 2 commits April 3, 2025 18:14
…3821)

Enums in response model with no nullability or default value will make the API very fragile as each extension to the enum will break the API for some clients, but a lot of enums actually do have an unknown value which should be used as a default. This set all model properties that are non-nullable using an enum that has an Unknown member in 10.10, except MediaStream.VideoRangeType which is refactored in jellyfin#13277

(cherry picked from commit 4a4fef8)
@nielsvanvelzen
Copy link
Member Author

Do not apply stable backport label to this PR. These changes are already in master!

Copy link

github-actions bot commented Apr 3, 2025

Changes in OpenAPI specification found. Expand to see details.

What's Changed


GET /Artists/{name}
Return Type:

Changed response : 200 OK

Artist returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Genres/{genreName}
Return Type:

Changed response : 200 OK

Genres returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Items/{itemId}
Return Type:

Changed response : 200 OK

Item returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

POST /Items/{itemId}
Request:

Changed content type : application/json

Updated BaseItemDto :

  • Changed property MediaType (string)

    Gets or sets the type of the media.

  • Changed property People (array)

    Gets or sets the people.

    Changed items (object):
    > This is used by the api to get information about a Person within a BaseItem.

    • Changed property Type (string)

      Gets or sets the type.

Changed content type : text/json

Updated BaseItemDto :

  • Changed property MediaType (string)

    Gets or sets the type of the media.

  • Changed property People (array)

    Gets or sets the people.

    Changed items (object):
    > This is used by the api to get information about a Person within a BaseItem.

    • Changed property Type (string)

      Gets or sets the type.

Changed content type : application/*+json

Updated BaseItemDto :

  • Changed property MediaType (string)

    Gets or sets the type of the media.

  • Changed property People (array)

    Gets or sets the people.

    Changed items (object):
    > This is used by the api to get information about a Person within a BaseItem.

    • Changed property Type (string)

      Gets or sets the type.

GET /Items/{itemId}/Ancestors
Return Type:

Changed response : 200 OK

Item parents returned.

  • Changed content type : application/json

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /LiveTv/Channels/{channelId}
Return Type:

Changed response : 200 OK

Live tv channel returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /LiveTv/Programs/{programId}
Return Type:

Changed response : 200 OK

Program returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /LiveTv/Recordings/{recordingId}
Return Type:

Changed response : 200 OK

Recording returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /MediaSegments/{itemId}
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > Api model for MediaSegment's.

      • Changed property Type (string)

        Gets or sets the type of content this segment defines.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > Api model for MediaSegment's.

      • Changed property Type (string)

        Gets or sets the type of content this segment defines.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > Api model for MediaSegment's.

      • Changed property Type (string)

        Gets or sets the type of content this segment defines.

GET /MusicGenres/{genreName}
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Persons/{name}
Return Type:

Changed response : 200 OK

Person returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Search/Hints
Return Type:

Changed response : 200 OK

Search hint returned.

  • Changed content type : application/json

    • Changed property SearchHints (array)

      Gets the search hints.

      Changed items (object):
      > Class SearchHintResult.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

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

    • Changed property SearchHints (array)

      Gets the search hints.

      Changed items (object):
      > Class SearchHintResult.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

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

    • Changed property SearchHints (array)

      Gets the search hints.

      Changed items (object):
      > Class SearchHintResult.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

GET /Studios/{name}
Return Type:

Changed response : 200 OK

Studio returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Items/{itemId}/LocalTrailers
Return Type:

Changed response : 200 OK

An Microsoft.AspNetCore.Mvc.OkResult containing the item's local trailers.

  • Changed content type : application/json

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Items/{itemId}/SpecialFeatures
Return Type:

Changed response : 200 OK

Special features returned.

  • Changed content type : application/json

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Items/Latest
Return Type:

Changed response : 200 OK

Latest media returned.

  • Changed content type : application/json

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    Changed items (object):
    > This is strictly used as a data transfer object from the api layer.
    > This holds information about a BaseItem in a format that is convenient for the client.

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Items/Root
Return Type:

Changed response : 200 OK

Root folder returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Years/{year}
Return Type:

Changed response : 200 OK

Year returned.

  • Changed content type : application/json

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

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

    • Changed property MediaType (string)

      Gets or sets the type of the media.

    • Changed property People (array)

      Gets or sets the people.

      Changed items (object):
      > This is used by the api to get information about a Person within a BaseItem.

      • Changed property Type (string)

        Gets or sets the type.

    • Changed property MediaStreams (array)

      Gets or sets the media streams.

      Changed items (object):
      > Class MediaStream.

      • Changed property VideoRange (string)

        Gets the video range.

      • Changed property VideoRangeType (string)

        Gets the video range type.

GET /Artists
Return Type:

Changed response : 200 OK

Artists returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Artists/AlbumArtists
Return Type:

Changed response : 200 OK

Album artists returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Channels
Return Type:

Changed response : 200 OK

Channels returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Channels/{channelId}/Items
Return Type:

Changed response : 200 OK

Channel items returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Channels/Items/Latest
Return Type:

Changed response : 200 OK

Latest channel items returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Genres
Return Type:

Changed response : 200 OK

Genres returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

GET /Albums/{itemId}/InstantMix
Return Type:

Changed response : 200 OK

Instant playlist returned.

  • Changed content type : application/json

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api to get information about a Person within a BaseItem.

        • Changed property Type (string)

          Gets or sets the type.

      • Changed property MediaStreams (array)

        Gets or sets the media streams.

        Changed items (object):
        > Class MediaStream.

        • Changed property VideoRange (string)

          Gets the video range.

        • Changed property VideoRangeType (string)

          Gets the video range type.

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

    • Changed property Items (array)

      Gets or sets the items.

      Changed items (object):
      > This is strictly used as a data transfer object from the api layer.
      > This holds information about a BaseItem in a format that is convenient for the client.

      • Changed property MediaType (string)

        Gets or sets the type of the media.

      • Changed property People (array)

        Gets or sets the people.

        Changed items (object):
        > This is used by the api...[Comment body truncated]

@joshuaboniface joshuaboniface merged commit 3ee7194 into jellyfin:release-10.10.z Apr 3, 2025
13 checks passed
@nielsvanvelzen nielsvanvelzen deleted the 10-10-api-backports branch April 3, 2025 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants