Breaking change: Type change for ID arguments and fields
July 10th, 2023
In API version 2023-10
, many of the ID arguments and fields that were integers have become ID
type. This includes, but is not limited to, board_id
, item_id
, parent_item_id
, parent_id
, team_id
, id
, update_id
, workspace_id
, user_id
, ids
, and doc_folder_id
.
The type ID
is alphanumeric and accepts both strings and integers as valid inputs, but it will only return strings. Though it accepts both, we advise against treating them as integers and storing them in your database as text.
Let's take the docs
object for example. The tables below show the impacted arguments and fields, what type they were before the update, and what they look like after the update.
Fields that are changing from Int
to ID
Impacted arguments
Before | After |
---|---|
ids [Int] | ids [ID!] |
object_ids [Int] | object_ids [ID!] |
workspace_ids [Int] | workspace_ids [ID] |