Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 367462 - make sure API documentation is clear on task key / task ID difference
Summary: make sure API documentation is clear on task key / task ID difference
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 7
: P4 trivial (vote)
Target Milestone: 3.9   Edit
Assignee: Steffen Pingel CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-12-22 16:49 EST by Thomas Ehrnhoefer CLA
Modified: 2013-05-12 09:23 EDT (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Ehrnhoefer CLA 2011-12-22 16:49:54 EST 
It appears some connectors are not always returning taskID when asked for (e.g. JIRA in connector.getTaskIdFromUrl, returning key).
The documentation of the API should clearly indicate what the difference is, so connectors return the correct value.

While in Mylyn, returning key for this method might (most of the time, always?) work, other systems relying on that API might not be so forgiving, so the framework should do it's best to help connector implementations do the right thing.
Comment 1 Steffen Pingel CLA 2011-12-22 17:14:15 EST 
Can you specify which API documentation in particular should be updated?
Comment 2 Thomas Ehrnhoefer CLA 2011-12-22 18:22:47 EST 
As far as I know, the getTaskIdFromTaskUrl in AbstractRepositoryConnector is the one returning the taskKey for JIRA
Comment 3 Jacek Kisyński CLA 2011-12-22 19:26:26 EST 
(In reply to comment #2)
> As far as I know, the getTaskIdFromTaskUrl in AbstractRepositoryConnector is
> the one returning the taskKey for JIRA

Yes.
Comment 4 Steffen Pingel CLA 2013-05-12 09:23:07 EDT 
Submitted https://git.eclipse.org/r/#/c/12734/ which adds documentation to various methods in AbstractRepositoryConnector.