go/go-jira
1
0
Fork 0
mirror of https://github.com/interviewstreet/go-jira.git synced 2025-04-11 11:32:00 +02:00
Code Issues Releases Activity

Updated JIRA API doc links

Browse Source
This commit is contained in:
Andy Grunwald 2016-03-27 14:24:48 +02:00
parent dc74b972d4
commit 36ff795367
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
authentication.go
View File

@ -33,7 +33,7 @@ type Session struct {
// Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. // Note that it is generally preferrable to use HTTP BASIC authentication with the REST API.
// However, this resource may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user). // However, this resource may be used to mimic the behaviour of JIRA's log-in page (e.g. to display log-in errors to a user).
// //
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#d2e459 // JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#auth/1/session
func (s *AuthenticationService) AcquireSessionCookie(username, password string) (bool, error) { func (s *AuthenticationService) AcquireSessionCookie(username, password string) (bool, error) {
apiEndpoint := "rest/auth/1/session" apiEndpoint := "rest/auth/1/session"
body := struct { body := struct {
@ -61,6 +61,6 @@ func (s *AuthenticationService) AcquireSessionCookie(username, password string)
} }
// TODO Missing API Call GET (Returns information about the currently authenticated user's session) // TODO Missing API Call GET (Returns information about the currently authenticated user's session)
// See https://docs.atlassian.com/jira/REST/latest/#d2e456 // See https://docs.atlassian.com/jira/REST/latest/#auth/1/session
// TODO Missing API Call DELETE (Logs the current user out of JIRA, destroying the existing session, if any.) // TODO Missing API Call DELETE (Logs the current user out of JIRA, destroying the existing session, if any.)
// https://docs.atlassian.com/jira/REST/latest/#d2e456 // See https://docs.atlassian.com/jira/REST/latest/#auth/1/session

6
issue.go
View File

@ -12,7 +12,7 @@ const (
// IssueService handles Issues for the JIRA instance / API. // IssueService handles Issues for the JIRA instance / API.
// //
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#d2e2279 // JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue
type IssueService struct { type IssueService struct {
client *Client client *Client
} }
@ -220,7 +220,7 @@ type CommentVisibility struct {
// This can be an issue id, or an issue key. // This can be an issue id, or an issue key.
// If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved. // If the issue cannot be found via an exact match, JIRA will also look for the issue in a case-insensitive way, or by looking to see if the issue was moved.
// //
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#d2e2609 // JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-getIssue
func (s *IssueService) Get(issueID string) (*Issue, *http.Response, error) { func (s *IssueService) Get(issueID string) (*Issue, *http.Response, error) {
apiEndpoint := fmt.Sprintf("rest/api/2/issue/%s", issueID) apiEndpoint := fmt.Sprintf("rest/api/2/issue/%s", issueID)
req, err := s.client.NewRequest("GET", apiEndpoint, nil) req, err := s.client.NewRequest("GET", apiEndpoint, nil)
@ -241,7 +241,7 @@ func (s *IssueService) Get(issueID string) (*Issue, *http.Response, error) {
// Creating a sub-task is similar to creating a regular issue, with two important differences: // Creating a sub-task is similar to creating a regular issue, with two important differences:
// The issueType field must correspond to a sub-task issue type and you must provide a parent field in the issue create request containing the id or key of the parent issue. // The issueType field must correspond to a sub-task issue type and you must provide a parent field in the issue create request containing the id or key of the parent issue.
// //
// JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#d2e2280 // JIRA API docs: https://docs.atlassian.com/jira/REST/latest/#api/2/issue-createIssues
func (s *IssueService) Create(issue *Issue) (*Issue, *http.Response, error) { func (s *IssueService) Create(issue *Issue) (*Issue, *http.Response, error) {
apiEndpoint := "rest/api/2/issue/" apiEndpoint := "rest/api/2/issue/"
req, err := s.client.NewRequest("POST", apiEndpoint, issue) req, err := s.client.NewRequest("POST", apiEndpoint, issue)