Difference between revisions of "Mylyn/JIRA Connector"

From Eclipsepedia

Jump to: navigation, search
(Priority JIRA web service API needs)
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Mylar]]
+
[[Category:Mylyn]]  
__TOC__
+
== Info ==
+
* [[Mylar FAQ#JIRA_Connector | JIRA Connector FAQ]]
+
* [https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Technology&product=Mylar&component=Jira&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&cmdtype=doit  Open task in Bugzilla]
+
  
== Priority JIRA web service API needs ==
+
The [http://wiki.eclipse.org/index.php/Mylyn_FAQ#What_happened_to_the_Mylyn_JIRA_Connector.3F Mylyn JIRA Connector has moved to Atlassian].
  
* Custom fields should be available on the Issue object.  Need to be able to retrieve list of custom fields needed to create a new issue.  Also need basic information about field types.
+
== Information for Integrators ==
  
* Retrieving available workflow actions and operations (based on issue type, status, current user etc)
+
The Atlassian update site distributes a feature and plug-in that with the same bundle ids as the Mylyn JIRA Connector (org.eclipse.mylyn.jira_feature) but with a higher version (3.4.0) than the latest available release of the Mylyn JIRA Connector. The stubs do not contain classes or extension points and effectively disable the Mylyn JIRA Connector.
  
* Retrieving available actions for each comment (edit, delete, change visibility etc) and required metadata (i.e. list of values for selecting who can see comment)
+
Extensions that integrate with the Mylyn JIRA Connector need to specifiy the following version constraints in the manifest:
** Attachment names/ids/etc should be present on the Issue object
+
  
* Retrieving, adding and removing dependencies, links and subtasks trough the SOAP/XML-RPC API
+
Require-Bundle:  org.eclipse.mylyn.jira.core;bundle-version="[3.3.2,3.4.0)",
** Links, etc should be present on the Issue object
+
  org.eclipse.mylyn.jira.ui;bundle-version="[3.3.2,3.4.0)"
  
* Update time tracking info trough SOAP/XML-RPC API
+
Features should specify an equivalent version match:
  
* Retrieving and adding votes trough SOAP API
+
<import feature="org.eclipse.mylyn_feature" version="3.3.2" match="equivalent"/>
** Number of votes and whether or not the current user has voted should be present on the issue object
+
  
* Watch/CC status of the issue given the current user (should be present on the issue)
+
The latest release of the Mylyn JIRA Connector is available from this archive update site: download.eclipse.org/tools/mylyn/update-archive/3.3.2/v20100222-0100/extras
 
+
* Watch/unwatch an issue during an update by setting/unsetting the watched flag on the issue (allows us to reassign an issue, but continue to watch it with one call)
+
 
+
* Retrieve issue history trough SOAP/XML-RPC API
+
 
+
* Retrieving, adding and removing attachments for given issue trough the SOAP/XML-RPC API
+
 
+
== Other JIRA web service API needs ==
+
 
+
* Service to get wiki macro details (for rich text editing and autocompletion)
+
** Is it a block macro
+
** Does it have parameters, if so, what values are possible
+
 
+
* Service to get RPC api version (need to call this before calling anything else) - could be added to the existing getServerInfo service
+
** We actually need to support RPC plugin versions, not Jira versions.  Currently we just guess the rpc version based on the Jira version
+
 
+
* Retrieving screen layouts given issue type, project and action (for editing custom fields on workflow transition)
+
 
+
* Submitting query/filter and only getting keys back (not issues+comments).
+
 
+
* Service to get issue summaries (everything but the comments) given a set of issue keys (for populating search results page at a time)
+
 
+
* Service to get all server configuration at once (Projects/Components/Versions)
+
 
+
* Service to get server "customization" settings (is voting enabled, attachments allowed, etc...) - currently admin only
+
** This is needed to disable operations that are not enabled on the server
+
 
+
* Service to get all 'meta' information at once (issue types, issue statuses, ProjectCategory, etc) - any configurable objects that apply across projects
+
 
+
* Project object should say what category it belongs to (if any)
+
 
+
* Service to search for issues - model this after the core services search method? ie. object based query
+
 
+
** Allow searching by voting and watch status (I don't think these are currently stored in the GenericValue object, so aren't indexed by Lucene)
+
** Allow searches to be saved as named queries
+
 
+
* Service to search for users - like the issue search, just return IDs and let the caller get the details
+
* Service to search for groups
+
 
+
* Provide all services in wrapped doc/literal format to be WS-I compliant.  Some toolkits such as XFire only support Doc/Literal web services
+

Latest revision as of 08:34, 26 February 2010


The Mylyn JIRA Connector has moved to Atlassian.

[edit] Information for Integrators

The Atlassian update site distributes a feature and plug-in that with the same bundle ids as the Mylyn JIRA Connector (org.eclipse.mylyn.jira_feature) but with a higher version (3.4.0) than the latest available release of the Mylyn JIRA Connector. The stubs do not contain classes or extension points and effectively disable the Mylyn JIRA Connector.

Extensions that integrate with the Mylyn JIRA Connector need to specifiy the following version constraints in the manifest:

Require-Bundle:  org.eclipse.mylyn.jira.core;bundle-version="[3.3.2,3.4.0)",
 org.eclipse.mylyn.jira.ui;bundle-version="[3.3.2,3.4.0)"

Features should specify an equivalent version match:

<import feature="org.eclipse.mylyn_feature" version="3.3.2" match="equivalent"/>

The latest release of the Mylyn JIRA Connector is available from this archive update site: download.eclipse.org/tools/mylyn/update-archive/3.3.2/v20100222-0100/extras