Connect API: Breaking change to list folder items API

Announcements
,
1

We are making a change to one of our preview API’s the list folder items API.

Whats changing?

  1. The ‘asset’ folder item type in the ‘item_types’ query parameter will be renamed to ‘image’.
  2. The ‘asset’ type in the response will be changed to ‘image’ along with an ‘image’ property.

Response after the update will look like the following:

"{
  ""items"": [
    {
      ""type"": ""image"",
      ""image"": {
        ""id"": ""MADimwLUdao"",
        ""name"": ""Grayscale Photography of Man in suit"",
        ""tags"": [
          ""black and white"",
          ""child"",
          ""suit"",
          ""people"",
          ""street"",
          ""unhappy"",
          ""wear"",
        ],
        ""created_at"": 1565674833,
        ""updated_at"": 1708749201,
        ""thumbnail"": {
          ""width"": 200,
          ""height"": 133,
          ""url"": ""https://media-public.example.com/MADimhhshs/1/thumbnail.jpg""
        }
      }
    }
  ]
}"

How to upgrade:

Note the following temporary behaviour when using the ‘item_types’ filter:

  1. If the ‘item_types’ filter includes ‘image’, then the response returns ‘image’ object types instead of ‘asset’ object types.
  2. If the ‘item_types’ filter doesn’t include ‘image’, then the response returns ‘asset’ object types.

During the transition, we recommend that you support both the ‘asset’ and ‘image’ object types when parsing responses from this API. Alternatively, you can use ‘item_types’ query filter to receive responses that contain only the new ‘image’ object type.

When do I need to make the change by?

The change will go live Monday: 26/08/2024

Connect API: created_at and updated_at now returned in more APIs