Release 296 - November 2024

:tada: Exciting news - Release 296 is here!

The Tulip team has rolled out some fresh updates across multiple features, along with some bug fixes. Check out the release notes and dive into what’s new.

Share your thoughts and questions below :arrow_down: :slightly_smiling_face:

1 Like

image

We cannot do “Try it out” any more ?
image

With the current API Docs page in the product, we can see that we use /api/v3 before /appGoups .

However, with the public API documentation, I do not see what comes between our domain name and the /appGroups.
https://support.tulip.co/apidocs/list-tulip-app-groups-and-the-apps-they-contain

This page [Introduction] does say something about it, but it is unclear what the “Previous version of the Tulip API” is, and it is also unclear whether we should use /api/v2 or api/v3 .

image

If you are deprecating the API Docs page in the product, please make the public API documentation page better.

2 Likes

I agree, I also find this a bit confusing and unclear.

However… with Next-Gen (with name space) the orange circled section is meant and with previous (no namespace) the blue circled section is meant:


I also struggled with the Workspace.
It says:

Note that the first workspace in any Tulip instance has the ID DEFAULT .

In my case no other Workspace ID than 1 worked.
And

Most Tulip API endpoints require a workspace context

I was not able to find the information if this context is needed in the doc of the API …

Also the Older API’s are missing the current Version information. Aren’t they?

2 Likes

Hey guys, I agree there are some nuances between the two APIs that can be confusing. We tried to highlight the nuances between the different versions’ naming conventions and the necessity of the workspace context across those APIs in the Introduction section of the documentation. I’ll sync with the team to brainstorm creative ideas to make this more clear.

On the “Try it out” feature, I can also see what we can do. We might be able to add this feature back in. Thanks for helping us make our API documentation better!

1 Like

https://support.tulip.co/apidocs/introduction
In case you missed this part, you do not need to provide workspace context if you are using a workspace-scoped API token.

Thank you. The most unclear part is this.

I agree with most of the comments above. Without the “Try it out” option, we’re now required to create a connector function for each Tulip API, which is both time-consuming and challenging. I created one this afternoon with the help of my Tulip Success Engineer, and the process was not only time-intensive but also confusing.

Would it be possible to provide a template connector function that includes all the Tulip APIs? This would help streamline the process and significantly reduce the effort needed to create individual APIs.

Additionally, could you clarify why the API documentation was decommissioned? The decision feels sudden, and I need to quickly create frequently used Tulip APIs to ensure I can continue using them once our instance is upgraded to r296.

As @ta-aoki pointed out, this change increases the difficulty for users to run Tulip APIs. It also raises accessibility concerns when running these connector functions within applications. This is particularly problematic because app editors can easily add a connector function to an application, potentially causing issues even when proper controls or governance are in place.

1 Like

Hi everyone, I want to drop a note saying that we’ve discussed this internally and we’re going to undo the change we made of pointing our old documentation suite towards our new one. We’ll maintain two documentation suites until the new suite has the same feature set as the old one.

I apologize for the frustration - our mistake here was assuming people didn’t use the “try it out” feature as much as they do! We’ll improve our internal interfaces by highlighting the voice of customer (or, in this case, the voice of developer) so that we can improve change socialization earlier in the future.

As before, thank you all for helping us have the best possible API documentation.

8 Likes

@joshuarichard Thank you for the consideration.
While we wait for the undo release to come, please could you add /api/v2 or api/v3 in this red part?

The “old” API Docs is no long found at the following address–> Introduction. Where is the “old” API dosumentaion with “Try it out” now located? Thanks