Skip to content

Commit 9d30a69

Browse files
FantasyTeddyFantasyTeddy
committed
Fix documentation URLs and anchors
1 parent cf3c1dd commit 9d30a69

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+286
-286
lines changed

Diff for: ‎audit_events.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ type ListAuditEventsOptions struct {
6262
// ListInstanceAuditEvents gets a list of audit events for instance.
6363
// Authentication as Administrator is required.
6464
//
65-
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html
65+
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html#retrieve-all-instance-audit-events
6666
func (s *AuditEventsService) ListInstanceAuditEvents(opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error) {
6767
req, err := s.client.NewRequest(http.MethodGet, "audit_events", opt, options)
6868
if err != nil {
@@ -81,7 +81,7 @@ func (s *AuditEventsService) ListInstanceAuditEvents(opt *ListAuditEventsOptions
8181
// GetInstanceAuditEvent gets a specific instance audit event.
8282
// Authentication as Administrator is required.
8383
//
84-
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html
84+
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html#retrieve-single-instance-audit-event
8585
func (s *AuditEventsService) GetInstanceAuditEvent(event int, options ...RequestOptionFunc) (*AuditEvent, *Response, error) {
8686
u := fmt.Sprintf("audit_events/%d", event)
8787

@@ -102,7 +102,7 @@ func (s *AuditEventsService) GetInstanceAuditEvent(event int, options ...Request
102102
// ListGroupAuditEvents gets a list of audit events for the specified group
103103
// viewable by the authenticated user.
104104
//
105-
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html
105+
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html#retrieve-all-group-audit-events
106106
func (s *AuditEventsService) ListGroupAuditEvents(gid interface{}, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error) {
107107
group, err := parseID(gid)
108108
if err != nil {
@@ -126,7 +126,7 @@ func (s *AuditEventsService) ListGroupAuditEvents(gid interface{}, opt *ListAudi
126126

127127
// GetGroupAuditEvent gets a specific group audit event.
128128
//
129-
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html
129+
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html#retrieve-a-specific-group-audit-event
130130
func (s *AuditEventsService) GetGroupAuditEvent(gid interface{}, event int, options ...RequestOptionFunc) (*AuditEvent, *Response, error) {
131131
group, err := parseID(gid)
132132
if err != nil {
@@ -151,7 +151,7 @@ func (s *AuditEventsService) GetGroupAuditEvent(gid interface{}, event int, opti
151151
// ListProjectAuditEvents gets a list of audit events for the specified project
152152
// viewable by the authenticated user.
153153
//
154-
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html
154+
// GitLab API docs: https://docs.gitlab.com/ee/api/audit_events.html#retrieve-all-project-audit-events
155155
func (s *AuditEventsService) ListProjectAuditEvents(pid interface{}, opt *ListAuditEventsOptions, options ...RequestOptionFunc) ([]*AuditEvent, *Response, error) {
156156
project, err := parseID(pid)
157157
if err != nil {
@@ -176,7 +176,7 @@ func (s *AuditEventsService) ListProjectAuditEvents(pid interface{}, opt *ListAu
176176
// GetProjectAuditEvent gets a specific project audit event.
177177
//
178178
// GitLab API docs:
179-
// https://docs.gitlab.com/ee/api/audit_events.html
179+
// https://docs.gitlab.com/ee/api/audit_events.html#retrieve-a-specific-project-audit-event
180180
func (s *AuditEventsService) GetProjectAuditEvent(pid interface{}, event int, options ...RequestOptionFunc) (*AuditEvent, *Response, error) {
181181
project, err := parseID(pid)
182182
if err != nil {

Diff for: ‎award_emojis.go

+22-22
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,23 @@ type ListAwardEmojiOptions ListOptions
6666
// ListMergeRequestAwardEmoji gets a list of all award emoji on the merge request.
6767
//
6868
// GitLab API docs:
69-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
69+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardables-award-emojis
7070
func (s *AwardEmojiService) ListMergeRequestAwardEmoji(pid interface{}, mergeRequestIID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
7171
return s.listAwardEmoji(pid, awardMergeRequest, mergeRequestIID, opt, options...)
7272
}
7373

7474
// ListIssueAwardEmoji gets a list of all award emoji on the issue.
7575
//
7676
// GitLab API docs:
77-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
77+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardables-award-emojis
7878
func (s *AwardEmojiService) ListIssueAwardEmoji(pid interface{}, issueIID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
7979
return s.listAwardEmoji(pid, awardIssue, issueIID, opt, options...)
8080
}
8181

8282
// ListSnippetAwardEmoji gets a list of all award emoji on the snippet.
8383
//
8484
// GitLab API docs:
85-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
85+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardables-award-emojis
8686
func (s *AwardEmojiService) ListSnippetAwardEmoji(pid interface{}, snippetID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
8787
return s.listAwardEmoji(pid, awardSnippets, snippetID, opt, options...)
8888
}
@@ -115,23 +115,23 @@ func (s *AwardEmojiService) listAwardEmoji(pid interface{}, resource string, res
115115
// GetMergeRequestAwardEmoji get an award emoji from merge request.
116116
//
117117
// GitLab API docs:
118-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
118+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-single-award-emoji
119119
func (s *AwardEmojiService) GetMergeRequestAwardEmoji(pid interface{}, mergeRequestIID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
120120
return s.getAwardEmoji(pid, awardMergeRequest, mergeRequestIID, awardID, options...)
121121
}
122122

123123
// GetIssueAwardEmoji get an award emoji from issue.
124124
//
125125
// GitLab API docs:
126-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
126+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-single-award-emoji
127127
func (s *AwardEmojiService) GetIssueAwardEmoji(pid interface{}, issueIID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
128128
return s.getAwardEmoji(pid, awardIssue, issueIID, awardID, options...)
129129
}
130130

131131
// GetSnippetAwardEmoji get an award emoji from snippet.
132132
//
133133
// GitLab API docs:
134-
// https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardable-39-s-award-emoji
134+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-single-award-emoji
135135
func (s *AwardEmojiService) GetSnippetAwardEmoji(pid interface{}, snippetID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
136136
return s.getAwardEmoji(pid, awardSnippets, snippetID, awardID, options...)
137137
}
@@ -223,23 +223,23 @@ func (s *AwardEmojiService) createAwardEmoji(pid interface{}, resource string, r
223223
// DeleteIssueAwardEmoji delete award emoji on an issue.
224224
//
225225
// GitLab API docs:
226-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-note
226+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji
227227
func (s *AwardEmojiService) DeleteIssueAwardEmoji(pid interface{}, issueIID, awardID int, options ...RequestOptionFunc) (*Response, error) {
228228
return s.deleteAwardEmoji(pid, awardIssue, issueIID, awardID, options...)
229229
}
230230

231231
// DeleteMergeRequestAwardEmoji delete award emoji on a merge request.
232232
//
233233
// GitLab API docs:
234-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-note
234+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji
235235
func (s *AwardEmojiService) DeleteMergeRequestAwardEmoji(pid interface{}, mergeRequestIID, awardID int, options ...RequestOptionFunc) (*Response, error) {
236236
return s.deleteAwardEmoji(pid, awardMergeRequest, mergeRequestIID, awardID, options...)
237237
}
238238

239239
// DeleteSnippetAwardEmoji delete award emoji on a snippet.
240240
//
241241
// GitLab API docs:
242-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-note
242+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji
243243
func (s *AwardEmojiService) DeleteSnippetAwardEmoji(pid interface{}, snippetID, awardID int, options ...RequestOptionFunc) (*Response, error) {
244244
return s.deleteAwardEmoji(pid, awardSnippets, snippetID, awardID, options...)
245245
}
@@ -267,7 +267,7 @@ func (s *AwardEmojiService) deleteAwardEmoji(pid interface{}, resource string, r
267267
// issue.
268268
//
269269
// GitLab API docs:
270-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
270+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-a-comments-award-emojis
271271
func (s *AwardEmojiService) ListIssuesAwardEmojiOnNote(pid interface{}, issueID, noteID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
272272
return s.listAwardEmojiOnNote(pid, awardIssue, issueID, noteID, opt, options...)
273273
}
@@ -276,7 +276,7 @@ func (s *AwardEmojiService) ListIssuesAwardEmojiOnNote(pid interface{}, issueID,
276276
// from the merge request.
277277
//
278278
// GitLab API docs:
279-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
279+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-a-comments-award-emojis
280280
func (s *AwardEmojiService) ListMergeRequestAwardEmojiOnNote(pid interface{}, mergeRequestIID, noteID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
281281
return s.listAwardEmojiOnNote(pid, awardMergeRequest, mergeRequestIID, noteID, opt, options...)
282282
}
@@ -285,7 +285,7 @@ func (s *AwardEmojiService) ListMergeRequestAwardEmojiOnNote(pid interface{}, me
285285
// snippet.
286286
//
287287
// GitLab API docs:
288-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
288+
// https://docs.gitlab.com/ee/api/award_emoji.html#list-a-comments-award-emojis
289289
func (s *AwardEmojiService) ListSnippetAwardEmojiOnNote(pid interface{}, snippetIID, noteID int, opt *ListAwardEmojiOptions, options ...RequestOptionFunc) ([]*AwardEmoji, *Response, error) {
290290
return s.listAwardEmojiOnNote(pid, awardSnippets, snippetIID, noteID, opt, options...)
291291
}
@@ -315,7 +315,7 @@ func (s *AwardEmojiService) listAwardEmojiOnNote(pid interface{}, resources stri
315315
// GetIssuesAwardEmojiOnNote gets an award emoji on a note from an issue.
316316
//
317317
// GitLab API docs:
318-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
318+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-an-award-emoji-for-a-comment
319319
func (s *AwardEmojiService) GetIssuesAwardEmojiOnNote(pid interface{}, issueID, noteID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
320320
return s.getSingleNoteAwardEmoji(pid, awardIssue, issueID, noteID, awardID, options...)
321321
}
@@ -324,7 +324,7 @@ func (s *AwardEmojiService) GetIssuesAwardEmojiOnNote(pid interface{}, issueID,
324324
// merge request.
325325
//
326326
// GitLab API docs:
327-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
327+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-an-award-emoji-for-a-comment
328328
func (s *AwardEmojiService) GetMergeRequestAwardEmojiOnNote(pid interface{}, mergeRequestIID, noteID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
329329
return s.getSingleNoteAwardEmoji(pid, awardMergeRequest, mergeRequestIID, noteID, awardID,
330330
options...)
@@ -333,7 +333,7 @@ func (s *AwardEmojiService) GetMergeRequestAwardEmojiOnNote(pid interface{}, mer
333333
// GetSnippetAwardEmojiOnNote gets an award emoji on a note from a snippet.
334334
//
335335
// GitLab API docs:
336-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
336+
// https://docs.gitlab.com/ee/api/award_emoji.html#get-an-award-emoji-for-a-comment
337337
func (s *AwardEmojiService) GetSnippetAwardEmojiOnNote(pid interface{}, snippetIID, noteID, awardID int, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
338338
return s.getSingleNoteAwardEmoji(pid, awardSnippets, snippetIID, noteID, awardID, options...)
339339
}
@@ -368,7 +368,7 @@ func (s *AwardEmojiService) getSingleNoteAwardEmoji(pid interface{}, ressource s
368368
// CreateIssuesAwardEmojiOnNote gets an award emoji on a note from an issue.
369369
//
370370
// GitLab API docs:
371-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
371+
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-comment
372372
func (s *AwardEmojiService) CreateIssuesAwardEmojiOnNote(pid interface{}, issueID, noteID int, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
373373
return s.createAwardEmojiOnNote(pid, awardIssue, issueID, noteID, opt, options...)
374374
}
@@ -377,23 +377,23 @@ func (s *AwardEmojiService) CreateIssuesAwardEmojiOnNote(pid interface{}, issueI
377377
// merge request.
378378
//
379379
// GitLab API docs:
380-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
380+
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-comment
381381
func (s *AwardEmojiService) CreateMergeRequestAwardEmojiOnNote(pid interface{}, mergeRequestIID, noteID int, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
382382
return s.createAwardEmojiOnNote(pid, awardMergeRequest, mergeRequestIID, noteID, opt, options...)
383383
}
384384

385385
// CreateSnippetAwardEmojiOnNote gets an award emoji on a note from a snippet.
386386
//
387387
// GitLab API docs:
388-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
388+
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-comment
389389
func (s *AwardEmojiService) CreateSnippetAwardEmojiOnNote(pid interface{}, snippetIID, noteID int, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
390390
return s.createAwardEmojiOnNote(pid, awardSnippets, snippetIID, noteID, opt, options...)
391391
}
392392

393393
// CreateAwardEmojiOnNote award emoji on a note.
394394
//
395395
// GitLab API docs:
396-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-note
396+
// https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji-on-a-comment
397397
func (s *AwardEmojiService) createAwardEmojiOnNote(pid interface{}, resource string, resourceID, noteID int, opt *CreateAwardEmojiOptions, options ...RequestOptionFunc) (*AwardEmoji, *Response, error) {
398398
project, err := parseID(pid)
399399
if err != nil {
@@ -423,7 +423,7 @@ func (s *AwardEmojiService) createAwardEmojiOnNote(pid interface{}, resource str
423423
// DeleteIssuesAwardEmojiOnNote deletes an award emoji on a note from an issue.
424424
//
425425
// GitLab API docs:
426-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
426+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji-from-a-comment
427427
func (s *AwardEmojiService) DeleteIssuesAwardEmojiOnNote(pid interface{}, issueID, noteID, awardID int, options ...RequestOptionFunc) (*Response, error) {
428428
return s.deleteAwardEmojiOnNote(pid, awardIssue, issueID, noteID, awardID, options...)
429429
}
@@ -432,7 +432,7 @@ func (s *AwardEmojiService) DeleteIssuesAwardEmojiOnNote(pid interface{}, issueI
432432
// merge request.
433433
//
434434
// GitLab API docs:
435-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
435+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji-from-a-comment
436436
func (s *AwardEmojiService) DeleteMergeRequestAwardEmojiOnNote(pid interface{}, mergeRequestIID, noteID, awardID int, options ...RequestOptionFunc) (*Response, error) {
437437
return s.deleteAwardEmojiOnNote(pid, awardMergeRequest, mergeRequestIID, noteID, awardID,
438438
options...)
@@ -441,7 +441,7 @@ func (s *AwardEmojiService) DeleteMergeRequestAwardEmojiOnNote(pid interface{},
441441
// DeleteSnippetAwardEmojiOnNote deletes an award emoji on a note from a snippet.
442442
//
443443
// GitLab API docs:
444-
// https://docs.gitlab.com/ee/api/award_emoji.html#award-emoji-on-notes
444+
// https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji-from-a-comment
445445
func (s *AwardEmojiService) DeleteSnippetAwardEmojiOnNote(pid interface{}, snippetIID, noteID, awardID int, options ...RequestOptionFunc) (*Response, error) {
446446
return s.deleteAwardEmojiOnNote(pid, awardSnippets, snippetIID, noteID, awardID, options...)
447447
}

0 commit comments

Comments
 (0)