Performance improvements for REST API documentation

Announcements
,
1

Hey Developer Community!

Today we have some exciting news to share. We’ve just rolled out performance improvements to the REST API documentation pages on developer.atlassian.com.

We’ve split out the documentation pages by groups of operations instead of having them all show on a single page. This greatly reduces the amount of content (DOM elements) on the pages, leading to faster load and interaction times. We’d love you to give it a try!

Jira Cloud REST API
Confluence Cloud REST API

Got some feedback? Let us know in the thread below.

Cheers,
The Ecosystem Platform team.

14 Likes
2

Splitting the pages looks like a huge improvement, and all existing links work too!

No issues spotted so far. Glad to see the docs are getting some love.

4 Likes
3

Do you plan to switch to OAuth 2.0 for the REST API in the near future?

4

Hi @RaulPopadineti,

Which API are you asking about in particular? We do have OAuth support across a lot of the Jira and Confluence REST APIs. :slight_smile:

5

I’m such a numb nut. Sorry. I’m asking about the Jira Cloud REST API.

6

Oh my goodness, thank you so much! This makes me disproportionately happy.

2 Likes
7

Are you going to show the same love for the non-Cloud edition REST APIs?

At the moment, I go to https://developer.atlassian.com/, click on “Check out the APIs”… and I’m taken to a Cloud-exclusive page (https://developer.atlassian.com/cloud/) :frowning:

8

Please don’t do this for the Server API docs. We’ve all got plenty of bandwidth so splitting them up makes no sense performance-wise. One page is fine and it makes it easier to CTRL-F terms. If it ain’t broke, don’t fix it please.

9

I don’t know if it’s a result of this change or not, but like many, many other doc links scattered throughout the Atlassian ecosystem, some Cloud-REST-API-born errors point to REST API docs but no longer work. For example:

 ›   Error: com.atlassian.confluence.api.service.exceptions.ConflictException: Cannot create new content property, see
 ›   https://docs.atlassian.com/confluence/REST/latest/#content/{id}/property-create for usage. Property :
 ›   JsonContentProperty{id='JsonContentPropertyId{id=472743939}', key='editor',
 ›   content=CollapsedReference{idProperties={version=CollapsedReference{idProperties={number=0}, referentClass=class
 ›   com.atlassian.confluence.api.model.content.Version}, id=ContentId{id=472743937}, status=current}, referentClass=class
 ›   com.atlassian.confluence.api.model.content.Content}, version=Version{by=null, when=2020-08-02T20:00:19.432Z, message='', number=3, syncRev='null',
 ›   syncRevSource='null', confRev='null', content=EmptyReference{referentClass=class com.atlassian.confluence.api.model.content.Content}}}

Specifically in this case, this link doesn’t land anywhere useful any more: https://docs.atlassian.com/confluence/REST/latest/#content/{id}/property-create

2 Likes
10

Hello Bob,
Thanks for sharing this issue. It seems that this kind of URL wasn’t supported in the previous version as well. As for the new version of the REST API page, we’ve provided a fallback solution. Now once you go by the link above you should be redirected to the root part of Confluence Cloud REST API docs https://developer.atlassian.com/cloud/confluence/rest/intro/.
BTW can you provide more details about the tool that generates this kind of URL? So we could try to fix it.
Thanks

11

Yes, I do get the redirect to the root, but that’s more or less useless – I already know how to find the documentation root when looking for REST API errors :slight_smile: Since it’s attempting to point to a very specific part of the documentation, it’s confusing to get redirected to the root to find a page that has nothing to do with the problem. It takes a closer look to realize that the page you land on is the result of a redirect that doesn’t map to the specificity of the original URL. This is a bad experience.

This is an error generated from various corner cases when trying to create or update certain content properties using different endpoints in the Confluence Cloud REST API.

Since Atlassian has a history of regularly changing documentation URLs, a quality fix to this seems like products should point to a URL redirection service instead of hardcoding documentation URLs in the future. Then when problems like this are discovered, the redirect mappings could be updated without requiring a re-release of the product.

3 Likes