Where is Jira API documentation?

[Siavosh Kasravi]

It is really strange but is there any reference anywhere on Jira API, the one we use in Adaptavist ScriptRunner on the we or anywhere else?

[edit]

Suppose I want to read a custom user property via ScriptRunner. What reference of guide should I look for?

[Daniel Ebers]

Hi Siavosh,

there is indeed documentation for Jira REST API (https://developer.atlassian.com/server/jira/platform/rest-apis/).

I am not sure what you mean by your question to REST API in connection with ScriptRunner. Did you refer to Script REST Endpoints?
Documentation on this you can find here:
https://scriptrunner.adaptavist.com/5.4.47/jira/rest-endpoints.html

Cheers,
Daniel

[Siavosh Kasravi]

Hi Daniel

I don't mean the REST API. I mean the Java API. I mean this. But it looks like a bot generated listing. Not a useful practical usable reference.

[Nic Brough -Adaptavist-]

The javadoc is not supposed to be a developer's guide, it's a practical usable reference doc.

If you want development guides, check the Atlassian plugin writers docs.

[Siavosh Kasravi]

Thanks for your response. I have used many technical references and I can tell you the link I shared merely lists the classes and methods with the least description possible. It is more likely to be used by the API developers as I believe that is what you meant. This is the entry point for that reference. You may compare it to MS MFC, Qt or Python references which all provide deep and detailed explanation of the design and use of their subject. One other link I found is this page which provides some examples. Even the final reference links provided in that page lead to the javadoc we talked about.

Would you be kind and provide me a link to the Atlassian plugin writers docs you mentioned if it is different from the links I provided?

[Siavosh Kasravi]

Where are Atlassian plugin writers docs?

[Nic Brough -Adaptavist-]

As @Daniel Ebers pointed to - https://developer.atlassian.com

The javadoc is minimal because there is no need for it to be complex.  I've always struggled with some of the links you've mentioned because the docs are trying to talk at every level and hence there's vast amounts of useless (to me) verbiage in there.  Docs should do one thing well, not try to be all things.