URI | GitRDoneBot

This class is used to construct GitLab API endpoints using unique incoming event values. Each instance of this class will belong to a unique instance.

Hierarchy

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new URI(baseUri: string, projectIdAsNumber: number, mergeReqIdAsNumber: number): URI

- Defined in src/gitlab/uri.ts:7
Constructor transforms number params to string type and returns an instance of URI that will construct API endpoints using unique values of incoming webhook events.

Parameters
- baseUri: string
  
  base URI string for GitLab API retrieved from environment variable
- projectIdAsNumber: number
  
  project ID number extracted from incoming GitLab webhook event
- mergeReqIdAsNumber: number
  
  merge request ID number extracted from incoming GitLab webhook event
Returns URI

instance of the URI class containing project & Merge Request IDs unique to the incoming GitLab event

Properties

Readonly baseUri

baseUri: string

base URI string for GitLab API retrieved from environment variable

Readonly mergeReqId

mergeReqId: string

Readonly mergeReqIdAsNumber

mergeReqIdAsNumber: number

merge request ID number extracted from incoming GitLab webhook event

Readonly projectId

projectId: string

Readonly projectIdAsNumber

projectIdAsNumber: number

project ID number extracted from incoming GitLab webhook event

Methods

forEmojis

forEmojis(): string

- Defined in src/gitlab/uri.ts:36
remarks
1. POST: https://docs.gitlab.com/ee/api/award_emoji.html#award-a-new-emoji
2. GET: https://docs.gitlab.com/ee/api/award_emoji.html#list-an-awardables-award-emoji
Returns string

api endpoint string used to POST new Emoji or GET all Emojis on a MR

forMRApprovals

forMRApprovals(): string

- Defined in src/gitlab/uri.ts:103
1. GET: https://docs.gitlab.com/ee/api/merge_request_approvals.html#get-configuration-1
Returns string

forMRChanges

forMRChanges(): string

- Defined in src/gitlab/uri.ts:110
1. GET: https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr-changes
Returns string

forMRsFilterByAssigneeId

forMRsFilterByAssigneeId(assigneeId: number, threshold: number): string

- Defined in src/gitlab/uri.ts:94
1. GET: https://docs.gitlab.com/ee/api/merge_requests.html#list-merge-requests
Parameters
- assigneeId: number
- threshold: number
Returns string

forNotes

forNotes(): string

- Defined in src/gitlab/uri.ts:61
remarks
1. POST: https://docs.gitlab.com/ee/api/notes.html#create-new-merge-request-note
2. CAUTION: Only use this for POST, as default GET behavior only retrieves the first 20 Notes. If you need to GET all Notes, use parameterized forNotesFilterByPage method
Returns string

api endpoint string used to POST new Note on a MR

forNotesFilterByPage

forNotesFilterByPage(page: number): string

- Defined in src/gitlab/uri.ts:71
remarks

GET: https://docs.gitlab.com/ee/api/notes.html#list-all-merge-request-notes

Parameters
- page: number
  
  number of page to return paginated results from
Returns string

api endpoint string to return a page of 100 Notes in ascending order, oldest to newest.

forSingleEmoji

forSingleEmoji(awardId: number): string

- Defined in src/gitlab/uri.ts:46
remarks

DELETE: https://docs.gitlab.com/ee/api/award_emoji.html#delete-an-award-emoji

Parameters
- awardId: number
  
  id of Emoji to be deleted
Returns string

api endpoint string used to DELETE Emoji on a MR

forSingleMR

forSingleMR(): string

- Defined in src/gitlab/uri.ts:117
1. GET: https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr
Returns string

forSingleMRCommits

forSingleMRCommits(): string

- Defined in src/gitlab/uri.ts:129
1. GET: https://docs.gitlab.com/ee/api/merge_requests.html#get-single-mr-commits
remarks

If GRDBot user is not a member of target project, this call will return: { "message": "404 Project Not Found" }. If GRDBot user is a member of project, but doesn't have Reporter+ permission, this call returns: { "message": "403 Forbidden" }.
Returns string

forSingleNote

forSingleNote(noteId: number): string

- Defined in src/gitlab/uri.ts:83
Parameters
- noteId: number
  
  id of Note to update or delete
Returns string

api endpoint string to UPDATE or DELETE an existing Note on a MR 0. PUT: https://docs.gitlab.com/ee/api/notes.html#modify-existing-merge-request-note
1. DELETE: https://docs.gitlab.com/ee/api/notes.html#delete-a-merge-request-note

forSingleProjectRepoRawConfigFile

forSingleProjectRepoRawConfigFile(): string

- Defined in src/gitlab/uri.ts:138
1. GET: https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository
Returns string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseUri: string

projectIdAsNumber: number

mergeReqIdAsNumber: number

Returns URI

Properties

Readonly baseUri

Readonly mergeReqId

Readonly mergeReqIdAsNumber

Readonly projectId

Readonly projectIdAsNumber

Methods

forEmojis

Returns string

forMRApprovals

Returns string

forMRChanges

Returns string

forMRsFilterByAssigneeId

Parameters

assigneeId: number

threshold: number

Returns string

forNotes

Returns string

forNotesFilterByPage

Parameters

page: number

Returns string

forSingleEmoji

Parameters

awardId: number

Returns string

forSingleMR

Returns string

forSingleMRCommits

Returns string

forSingleNote

Parameters

noteId: number

Returns string

forSingleProjectRepoRawConfigFile

Returns string