Will v2 be able to include references as v1

API
1

Some of the systems we use lack caches. With v1 we got most of our data in one request but with v2 it seems we often will need to ask more subqueries to get all data we need.

Are there any plans to have say an include field in the query to “expand” the “include”-references?

Common scenario. Everyone at our place have their own board (so they can add more stages). However the first stage will always be the entry. In v1 we had “stage_order_nr” to easily identify if it was the first. In v2 we will need to query the stage id to know this and it would be so much nicer to be able to say include=stage than to rely on (if available) a cache that might be out of sync (albeit the webhook would probably keep it synced). Ie, to make sure that the responses hold the data needed rather than just being a bunch of references. I rather await a delayed answer than having to do a lot of extra queries to get the data I want…

Specifically for the webhooks…

2

If the data we are currently retrieving in batches (e.g. page size of 100) will now be missing certain elements that were there in v1, now we will have to issue 100 or more API calls for each page of 100 records to get complete information. Going from a single v1 API call to having to make 101, 201 or 301 API calls will have drastic performance implications.

While it is laudable to prevent fetching unnecessary data, a better design would have been to at least include a way to specify to include the “unnecessary data” because for some of us the data is indeed quite necessary. A v2 of an API should always be an improvement over v1 and in this case it seems like this could be taking a step backwards.