Uploaded image for project: 'Image Archives'
  1. Image Archives
  2. IMG-15

CAA API documentation needs an update

XMLWordPrintable

    • Icon: Improvement Improvement
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None

      The coverart API documentation has a couple of errors:

      1. The response to a request for /release/mbid is always a redirect, not a direct 200

      2. The JSON example doesn't include image IDs (which are present in the actual response)

          [IMG-15] CAA API documentation needs an update

          chaban made changes -
          Assignee Original: Karam Jameel Moore [ KingKaram ]
          Karam Jameel Moore made changes -
          Assignee New: Karam Jameel Moore [ KingKaram ]

          Freso added a comment -

          1. The response to /release/mbid is only a 307 temp. redirect if the MBID is a valid and exists, otherwise coverartarchive.org is not left. I assume it's the same for the other 40x and 50x responses. Also, a good /release/mbid will eventually result in a HTTP 200 even if the immediate response is a 307. I'm seeing getting 307 to archive.org which gives a 302 to their file server which then gives a 200, and I'm just not sure how to note this in the API document.

          2. I updated the last JSON example on the API page. Doesn't seem like it's in our transclusion table, so it should show up by itself, though it may have been cached as I'm not seeing it myself.

          You're also welcome to edit https://wiki.musicbrainz.org/Cover_Art_Archive/API to improve it yourself.

          Freso added a comment - 1. The response to /release/mbid is only a 307 temp. redirect if the MBID is a valid and exists, otherwise coverartarchive.org is not left. I assume it's the same for the other 40x and 50x responses. Also, a good /release/mbid will eventually result in a HTTP 200 even if the immediate response is a 307. I'm seeing getting 307 to archive.org which gives a 302 to their file server which then gives a 200, and I'm just not sure how to note this in the API document. 2. I updated the last JSON example on the API page. Doesn't seem like it's in our transclusion table, so it should show up by itself, though it may have been cached as I'm not seeing it myself. You're also welcome to edit https://wiki.musicbrainz.org/Cover_Art_Archive/API to improve it yourself.
          Kuno Woudt made changes -
          Assignee Original: Kuno Woudt [ warp ]
          Kuno Woudt made changes -
          Workflow Original: jira [ 15636 ] New: MusicBrainz [ 16089 ]
          Andy Hawkins made changes -
          Description Original: In libcoverart, I envisaged having a method like:

          CoverArt.FetchImage("1234-5678-9abc","1234567",eSize_250);

          (where the parameters are release ID, image ID and optional size respectively)

          However, the JSON response for a release only includes the full URL for each image, meaning I'd have to parse this to pick out the individual IDs. I was hoping to avoid the client of libcoverart having to specify full URLs if at all possible.

          Can this be added? I doubt it's too difficult.           		New: The coverart API documentation has a couple of errors:

          1. The response to a request for /release/mbid is always a redirect, not a direct 200

          2. The JSON example doesn't include image IDs (which are present in the actual response)
          Summary Original: JSON response should include ID for each image New: CAA API documentation needs an update
          Andy Hawkins created issue -

            Unassigned Unassigned
            adhawkins Andy Hawkins
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:

                Version Package