Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Greenhopper class API and broken documentation

Olivier Billaud
Contributor
July 20, 2023

Hello, 

I use the following Greenhopper class in my scripts (to create some sprints using groovy and JMWE):

https://docs.atlassian.com/jira-software/6.7.7/com/atlassian/greenhopper/service/sprint/SprintManagerImpl.html

 

I know Greenhopper is very old, but I don't find any equivalent class in more recent Jira API.

In this documentation, when I click on a link (for example "Sprint" to see the Sprint class), the link is broken (goes to https://marketplace.atlassian.com/plugin/details/5129/jira-greenhopper-api/apidocs/com/atlassian/greenhopper/service/sprint/Sprint.html?is-external=true)

 

Could you please tell me:

1. If there is a new way to access rapidviews, sprints, etc. using recent Jira groovy API?

2. Why this documentation is totally broken? Is there a way to fix it?

 

Thank you very much, 
Regards, 
Olivier

2 answers

2 votes
Nic Brough -Adaptavist-
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 20, 2023

The history lesson:

  • Jira became a thing, one that allowed "plugins"
  • A company called Greenpepper wrote Greenhopper for it as a plugin
  • Atlassian bought Greenhopper (as a plugin, then an add-on, and now what we'd call an app)
  • Greenhopper got rebranded as Agile (I'm old, I can't remember if this was with Jira 4, 5 or 6)
  • Agile got moved from app to application, and rebranded as "Jira Software" with Jira 7

During these development cycles, Atlassian has been adding REST API calls for it (heck, when they acquired Greenhopper, the only remote API was SOAP, not REST), but since the second  rebrand, not developed anything on the Greenhopper API (and not done much since the first)

They have not refactored GH completely - some of the APIs are still there, but you need to consider them as "deprecated" - do not expect them to work accurately, and expect them to disappear. without notice.

TLDR: what @Sunny Ape said - look to the supported APIs - https://developer.atlassian.com/cloud/jira/software/rest/intro/#introduction

Sunny Ape
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 20, 2023

Yep. And the old Java based APIs had their time in the Sun ( :P ) too, but it's time to move on.

Olivier Billaud
Contributor
July 21, 2023

Thank you for the history lesson, that's interesting!

@Sunny Ape , @Nic Brough -Adaptavist- , I answer to your 2 messages, thank you for explainations. 

David, I smiled when reading your example of Valiant Regal service manual. Yeah I know i'm using very old classes... We are on Jira Data Center so it's not (I think?) the end of our development lifecycle. I hope so!

For example, i have a script to add programmatically a specific quickfilter to all my boards. I think it is not possible with rest api. Idem to create swimlanes. Etc.

I understand the only way is to whine and ask for a new endpoint to do so, but I know Atlassian rythme is not the same as our's :D

But ok, I understand i have to modernize my methods, thank you very much to help me to leave my denial life. :D

I will have a look on how call properly the endpoints in my groovy scripts.

Thank you and have a nice day!

Olivier

Like Sunny Ape likes this
Sunny Ape
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 21, 2023

No problems.

For Jira Software CLOUD there are REST API endpoints to get all quick filters and get a get a single quick filter, but you currently can't add, edit move or delete quick filters via the REST API, as per JSWCLOUD-21718.

For Jira Software SERVER / DATA CENTER there no endpoints at all related to quick filters.

2 votes
Sunny Ape
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 20, 2023

Hello @Olivier Billaud 

"If there is a new way to access rapidviews, sprints, etc. using recent Jira groovy API?"

Switch to using the REST API endpoints. Given that Jira Software Server is at the end of its development lifecycle, there either was or wasn't an equivalent endpoint that provided what you want, and you just have to live with that.

"Why this documentation is totally broken? Is there a way to fix it?"

You're talking about ancient documentation for a discontinued access method for a soon to be unsupported product. No offence intended, but you may as well be asking how fix the missing description of the drum brakes on page 10 of the 1973 Valiant Regal service manual :)

PS. If you want to see the old feature request for a REST API endpoint for Jira Software Server to replicate the old Greenhopper sprintReport endpoint, look at JSWSERVER-12877. There are plenty of other requests related to the old Greenhopper endpoints in there that you're welcome to browse, for historical reference.

Suggest an answer

Log in or Sign up to answer