diff --git a/docs/schema.md b/docs/schema.md index 0ee2f32..b9c8f3e 100644 --- a/docs/schema.md +++ b/docs/schema.md @@ -584,6 +584,62 @@ type Coordinates { longitude: Degrees } +# An individual piece of album artwork from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). +type CoverArtImage { + # The Internet Archive’s internal file ID for the image. + fileID: String! + + # The URL at which the image can be found. + image: URLString! + + # A set of thumbnails for the image. + thumbnails: CoverArtImageThumbnails + + # Whether this image depicts the “main front” of the release. + front: Boolean! + + # Whether this image depicts the “main back” of the release. + back: Boolean! + + # A list of [image types](https://musicbrainz.org/doc/Cover_Art/Types) + # describing what part(s) of the release the image includes. + types: [String] + + # The MusicBrainz edit ID. + edit: Int + + # Whether the image was approved by the MusicBrainz edit system. + approved: Boolean + + # A free-text comment left for the image. + comment: String +} + +# The image sizes that may be requested at the [Cover Art +# Archive](https://musicbrainz.org/doc/Cover_Art_Archive). +enum CoverArtImageSize { + # A maximum dimension of 250px. + SMALL + + # A maximum dimension of 500px. + LARGE + + # The image’s original dimensions, with no maximum. + FULL +} + +# URLs for thumbnails of different sizes for a particular piece of +# cover art. +type CoverArtImageThumbnails { + # The URL of a small version of the cover art, where the + # maximum dimension is 250px. + small: URLString + + # The URL of a large version of the cover art, where the + # maximum dimension is 500px. + large: URLString +} + # Year, month (optional), and day (optional) in YYYY-MM-DD format. scalar Date @@ -1611,6 +1667,10 @@ type Release implements Node, Entity { # [EANs](https://en.wikipedia.org/wiki/International_Article_Number). barcode: String + # A list and summary of the cover art images that are present + # for this release from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). + coverArt: ReleaseCoverArt! + # The status describes how “official” a release is. status: ReleaseStatus @@ -1675,6 +1735,57 @@ type ReleaseConnection { totalCount: Int } +# An object containing a list of the cover art images for a +# release obtained from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive), +# as well as a summary of what artwork is available. +type ReleaseCoverArt { + # The URL of an image depicting the album cover or “main + # front” of the release, i.e. the front of the packaging of the audio recording + # (or in the case of a digital release, the image associated with it in a digital + # media store). + # + # In the MusicBrainz schema, this field is a Boolean value indicating the presence + # of a front image, whereas here the value is the URL for the image itself if one + # exists. You can check for null if you just want to determine the presence of an + # image. + front( + # The size of the image to retrieve. By default, the returned + # image will have its full original dimensions, but certain thumbnail sizes may be + # retrieved as well. + size: CoverArtImageSize = null + ): URLString + + # The URL of an image depicting the “main back” of the + # release, i.e. the back of the packaging of the audio recording. + # + # In the MusicBrainz schema, this field is a Boolean value indicating the presence + # of a back image, whereas here the value is the URL for the image itself. You can + # check for null if you just want to determine the presence of an image. + back( + # The size of the image to retrieve. By default, the returned + # image will have its full original dimensions, but certain thumbnail sizes may be + # retrieved as well. + size: CoverArtImageSize = null + ): URLString + + # A list of images depicting the different sides and surfaces + # of a release’s media and packaging. + images: [CoverArtImage] + + # Whether there is artwork present for this release. + artwork: Boolean! + + # Whether the Cover Art Archive has received a take-down + # request for this release’s artwork, disallowing new uploads. + darkened: Boolean! + + # The number of artwork images present for this release. + count: Int! + + # The particular release shown in the returned cover art. + release: Release! +} + # An edge in a connection. type ReleaseEdge { # The item at the end of the edge @@ -1747,6 +1858,10 @@ type ReleaseGroup implements Node, Entity { # field. secondaryTypeIDs: [MBID] + # The cover art for a release group, obtained from the [Cover + # Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). + coverArt: ReleaseGroupCoverArt + # A list of artists linked to this entity. artists(after: String, first: Int): ArtistConnection @@ -1787,6 +1902,34 @@ type ReleaseGroupConnection { totalCount: Int } +# An object containing the cover art for a release group obtained +# from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). For +# release groups, just the front cover of particular release will be selected. +type ReleaseGroupCoverArt { + # The URL of an image depicting the album cover or “main + # front” of a release in the release group, i.e. the front of the packaging of the + # audio recording (or in the case of a digital release, the image associated with + # it in a digital media store). + front( + # The size of the image to retrieve. By default, the returned + # image will have its full original dimensions, but certain thumbnail sizes may be + # retrieved as well. + size: CoverArtImageSize = null + ): URLString + + # A list of images returned by the [Cover Art + # Archive](https://musicbrainz.org/doc/Cover_Art_Archive) for a release group. A + # particular release’s front image will be included in the list, and likely no + # others, even if other images are available. + images: [CoverArtImage] + + # Whether there is artwork present for this release group. + artwork: Boolean! + + # The particular release shown in the returned cover art. + release: Release! +} + # An edge in a connection. type ReleaseGroupEdge { # The item at the end of the edge diff --git a/docs/types.md b/docs/types.md index 0d542f5..3af7917 100644 --- a/docs/types.md +++ b/docs/types.md @@ -18,6 +18,8 @@ You may also be interested in reading the [schema in GraphQL syntax](schema.md).
  • [CollectionConnection](#collectionconnection)
  • [CollectionEdge](#collectionedge)
  • [Coordinates](#coordinates)
    • +
  • [CoverArtImage](#coverartimage)
    • +
  • [CoverArtImageThumbnails](#coverartimagethumbnails)
  • [Disc](#disc)
  • [Event](#event)
  • [EventConnection](#eventconnection)
    • @@ -45,10 +47,12 @@ You may also be interested in reading the [schema in GraphQL syntax](schema.md).
  • [Relationships](#relationships)
  • [Release](#release)
  • [ReleaseConnection](#releaseconnection)
    • +
  • [ReleaseCoverArt](#releasecoverart)
  • [ReleaseEdge](#releaseedge)
  • [ReleaseEvent](#releaseevent)
  • [ReleaseGroup](#releasegroup)
  • [ReleaseGroupConnection](#releasegroupconnection)
    • +
  • [ReleaseGroupCoverArt](#releasegroupcoverart)
  • [ReleaseGroupEdge](#releasegroupedge)
  • [SearchQuery](#searchquery)
  • [Series](#series)
    • @@ -63,6 +67,7 @@ You may also be interested in reading the [schema in GraphQL syntax](schema.md).
  • [WorkEdge](#workedge)
  • [Enums](#enums)
    • @@ -1657,6 +1662,113 @@ Geographic coordinates described with latitude and longitude. +### CoverArtImage + +An individual piece of album artwork from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field / ArgumentTypeDescription
    fileID String! + The Internet Archive’s internal file ID for the image. +
    image URLString! + The URL at which the image can be found. +
    thumbnails CoverArtImageThumbnails + A set of thumbnails for the image. +
    front Boolean! + Whether this image depicts the “main front” of the release. +
    back Boolean! + Whether this image depicts the “main back” of the release. +
    types [String] + A list of image types +describing what part(s) of the release the image includes. +
    edit Int + The MusicBrainz edit ID. +
    approved Boolean + Whether the image was approved by the MusicBrainz edit system. +
    comment String + A free-text comment left for the image. +
    + +### CoverArtImageThumbnails + +URLs for thumbnails of different sizes for a particular piece of +cover art. + + + + + + + + + + + + + + + + + + +
    Field / ArgumentTypeDescription
    small URLString + The URL of a small version of the cover art, where the +maximum dimension is 250px. +
    large URLString + The URL of a large version of the cover art, where the +maximum dimension is 500px. +
    + ### Disc Information about the physical CD and releases associated with a @@ -4038,6 +4150,14 @@ release has one. The most common types found on releases are 12-digit EANs. + + coverArt + ReleaseCoverArt! + + A list and summary of the cover art images that are present +for this release from the Cover Art Archive. + + status ReleaseStatus @@ -4237,6 +4357,95 @@ ignoring pagination. +### ReleaseCoverArt + +An object containing a list of the cover art images for a +release obtained from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive), +as well as a summary of what artwork is available. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field / ArgumentTypeDescription
    front URLString + The URL of an image depicting the album cover or “main +front” of the release, i.e. the front of the packaging of the audio recording +(or in the case of a digital release, the image associated with it in a digital +media store).

    In the MusicBrainz schema, this field is a Boolean value indicating the presence +of a front image, whereas here the value is the URL for the image itself if one +exists. You can check for null if you just want to determine the presence of an +image. +
    sizeCoverArtImageSizeThe size of the image to retrieve. By default, the returned +image will have its full original dimensions, but certain thumbnail sizes may be +retrieved as well.
    back URLString + The URL of an image depicting the “main back” of the +release, i.e. the back of the packaging of the audio recording.

    In the MusicBrainz schema, this field is a Boolean value indicating the presence +of a back image, whereas here the value is the URL for the image itself. You can +check for null if you just want to determine the presence of an image. +
    sizeCoverArtImageSizeThe size of the image to retrieve. By default, the returned +image will have its full original dimensions, but certain thumbnail sizes may be +retrieved as well.
    images [CoverArtImage] + A list of images depicting the different sides and surfaces +of a release’s media and packaging. +
    artwork Boolean! + Whether there is artwork present for this release. +
    darkened Boolean! + Whether the Cover Art Archive has received a take-down +request for this release’s artwork, disallowing new uploads. +
    count Int! + The number of artwork images present for this release. +
    release Release! + The particular release shown in the returned cover art. +
    + ### ReleaseEdge An edge in a connection. @@ -4415,6 +4624,14 @@ that apply to this release group. field. + + coverArt + ReleaseGroupCoverArt + + The cover art for a release group, obtained from the Cover +Art Archive. + + artists ArtistConnection @@ -4544,6 +4761,62 @@ ignoring pagination. +### ReleaseGroupCoverArt + +An object containing the cover art for a release group obtained +from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). For +release groups, just the front cover of particular release will be selected. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Field / ArgumentTypeDescription
    front URLString + The URL of an image depicting the album cover or “main +front” of a release in the release group, i.e. the front of the packaging of the +audio recording (or in the case of a digital release, the image associated with +it in a digital media store). +
    sizeCoverArtImageSizeThe size of the image to retrieve. By default, the returned +image will have its full original dimensions, but certain thumbnail sizes may be +retrieved as well.
    images [CoverArtImage] + A list of images returned by the Cover Art +Archive for a release group. A +particular release’s front image will be included in the list, and likely no +others, even if other images are available. +
    artwork Boolean! + Whether there is artwork present for this release group. +
    release Release! + The particular release shown in the returned cover art. +
    + ### ReleaseGroupEdge An edge in a connection. @@ -5375,6 +5648,35 @@ these results were found through a search. ## Enums +### CoverArtImageSize + +The image sizes that may be requested at the [Cover Art +Archive](https://musicbrainz.org/doc/Cover_Art_Archive). + + + + + + + + + + + + + + + + + +
    ValueDescription
    SMALL + A maximum dimension of 250px. +
    LARGE + A maximum dimension of 500px. +
    FULL + The image’s original dimensions, with no maximum. +
    + ### ReleaseGroupType A type used to describe release groups, e.g. album, single, EP, diff --git a/schema.json b/schema.json index ad75d46..ed3d9fe 100644 --- a/schema.json +++ b/schema.json @@ -2907,6 +2907,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "coverArt", + "description": "A list and summary of the cover art images that are present\nfor this release from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReleaseCoverArt", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "status", "description": "The status describes how “official” a release is.", @@ -3269,6 +3285,356 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ReleaseCoverArt", + "description": "An object containing a list of the cover art images for a\nrelease obtained from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive),\nas well as a summary of what artwork is available.", + "fields": [ + { + "name": "front", + "description": "The URL of an image depicting the album cover or “main\nfront” of the release, i.e. the front of the packaging of the audio recording\n(or in the case of a digital release, the image associated with it in a digital\nmedia store).\n\nIn the MusicBrainz schema, this field is a Boolean value indicating the presence\nof a front image, whereas here the value is the URL for the image itself if one\nexists. You can check for null if you just want to determine the presence of an\nimage.", + "args": [ + { + "name": "size", + "description": "The size of the image to retrieve. By default, the returned\nimage will have its full original dimensions, but certain thumbnail sizes may be\nretrieved as well.", + "type": { + "kind": "ENUM", + "name": "CoverArtImageSize", + "ofType": null + }, + "defaultValue": "null" + } + ], + "type": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "back", + "description": "The URL of an image depicting the “main back” of the\nrelease, i.e. the back of the packaging of the audio recording.\n\nIn the MusicBrainz schema, this field is a Boolean value indicating the presence\nof a back image, whereas here the value is the URL for the image itself. You can\ncheck for null if you just want to determine the presence of an image.", + "args": [ + { + "name": "size", + "description": "The size of the image to retrieve. By default, the returned\nimage will have its full original dimensions, but certain thumbnail sizes may be\nretrieved as well.", + "type": { + "kind": "ENUM", + "name": "CoverArtImageSize", + "ofType": null + }, + "defaultValue": "null" + } + ], + "type": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "A list of images depicting the different sides and surfaces\nof a release’s media and packaging.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CoverArtImage", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "artwork", + "description": "Whether there is artwork present for this release.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "darkened", + "description": "Whether the Cover Art Archive has received a take-down\nrequest for this release’s artwork, disallowing new uploads.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "count", + "description": "The number of artwork images present for this release.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "release", + "description": "The particular release shown in the returned cover art.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Release", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CoverArtImageSize", + "description": "The image sizes that may be requested at the [Cover Art\nArchive](https://musicbrainz.org/doc/Cover_Art_Archive).", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SMALL", + "description": "A maximum dimension of 250px.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LARGE", + "description": "A maximum dimension of 500px.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULL", + "description": "The image’s original dimensions, with no maximum.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "URLString", + "description": "A web address.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CoverArtImage", + "description": "An individual piece of album artwork from the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive).", + "fields": [ + { + "name": "fileID", + "description": "The Internet Archive’s internal file ID for the image.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The URL at which the image can be found.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thumbnails", + "description": "A set of thumbnails for the image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CoverArtImageThumbnails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "front", + "description": "Whether this image depicts the “main front” of the release.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "back", + "description": "Whether this image depicts the “main back” of the release.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "A list of [image types](https://musicbrainz.org/doc/Cover_Art/Types)\ndescribing what part(s) of the release the image includes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "edit", + "description": "The MusicBrainz edit ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "approved", + "description": "Whether the image was approved by the MusicBrainz edit system.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comment", + "description": "A free-text comment left for the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CoverArtImageThumbnails", + "description": "URLs for thumbnails of different sizes for a particular piece of\ncover art.", + "fields": [ + { + "name": "small", + "description": "The URL of a small version of the cover art, where the\nmaximum dimension is 250px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "large", + "description": "The URL of a large version of the cover art, where the\nmaximum dimension is 500px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "Medium", @@ -7539,6 +7905,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "coverArt", + "description": "The cover art for a release group, obtained from the [Cover\nArt Archive](https://musicbrainz.org/doc/Cover_Art_Archive).", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReleaseGroupCoverArt", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "artists", "description": "A list of artists linked to this entity.", @@ -7740,6 +8118,88 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ReleaseGroupCoverArt", + "description": "An object containing the cover art for a release group obtained\nfrom the [Cover Art Archive](https://musicbrainz.org/doc/Cover_Art_Archive). For\nrelease groups, just the front cover of particular release will be selected.", + "fields": [ + { + "name": "front", + "description": "The URL of an image depicting the album cover or “main\nfront” of a release in the release group, i.e. the front of the packaging of the\naudio recording (or in the case of a digital release, the image associated with\nit in a digital media store).", + "args": [ + { + "name": "size", + "description": "The size of the image to retrieve. By default, the returned\nimage will have its full original dimensions, but certain thumbnail sizes may be\nretrieved as well.", + "type": { + "kind": "ENUM", + "name": "CoverArtImageSize", + "ofType": null + }, + "defaultValue": "null" + } + ], + "type": { + "kind": "SCALAR", + "name": "URLString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "A list of images returned by the [Cover Art\nArchive](https://musicbrainz.org/doc/Cover_Art_Archive) for a release group. A\nparticular release’s front image will be included in the list, and likely no\nothers, even if other images are available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CoverArtImage", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "artwork", + "description": "Whether there is artwork present for this release group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "release", + "description": "The particular release shown in the returned cover art.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Release", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "SeriesConnection", @@ -8401,16 +8861,6 @@ "enumValues": null, "possibleTypes": null }, - { - "kind": "SCALAR", - "name": "URLString", - "description": "A web address.", - "fields": null, - "inputFields": null, - "interfaces": null, - "enumValues": null, - "possibleTypes": null - }, { "kind": "OBJECT", "name": "URL",