64 KiB
\IssueApi
All URIs are relative to /api/v1
| Method | HTTP request | Description |
|---|---|---|
| issue_add_label | POST /repos/{owner}/{repo}/issues/{index}/labels | Add a label to an issue |
| issue_add_subscription | PUT /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Subscribe user to issue |
| issue_add_time | POST /repos/{owner}/{repo}/issues/{index}/times | Add tracked time to a issue |
| issue_check_subscription | GET /repos/{owner}/{repo}/issues/{index}/subscriptions/check | Check if user is subscribed to an issue |
| issue_clear_labels | DELETE /repos/{owner}/{repo}/issues/{index}/labels | Remove all labels from an issue |
| issue_create_comment | POST /repos/{owner}/{repo}/issues/{index}/comments | Add a comment to an issue |
| issue_create_issue | POST /repos/{owner}/{repo}/issues | Create an issue. If using deadline only the date will be taken into account, and time of day ignored. |
| issue_create_label | POST /repos/{owner}/{repo}/labels | Create a label |
| issue_create_milestone | POST /repos/{owner}/{repo}/milestones | Create a milestone |
| issue_delete | DELETE /repos/{owner}/{repo}/issues/{index} | Delete an issue |
| issue_delete_comment | DELETE /repos/{owner}/{repo}/issues/comments/{id} | Delete a comment |
| issue_delete_comment_deprecated | DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id} | Delete a comment |
| issue_delete_comment_reaction | DELETE /repos/{owner}/{repo}/issues/comments/{id}/reactions | Remove a reaction from a comment of an issue |
| issue_delete_issue_reaction | DELETE /repos/{owner}/{repo}/issues/{index}/reactions | Remove a reaction from an issue |
| issue_delete_label | DELETE /repos/{owner}/{repo}/labels/{id} | Delete a label |
| issue_delete_milestone | DELETE /repos/{owner}/{repo}/milestones/{id} | Delete a milestone |
| issue_delete_stop_watch | DELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/delete | Delete an issue's existing stopwatch. |
| issue_delete_subscription | DELETE /repos/{owner}/{repo}/issues/{index}/subscriptions/{user} | Unsubscribe user from issue |
| issue_delete_time | DELETE /repos/{owner}/{repo}/issues/{index}/times/{id} | Delete specific tracked time |
| issue_edit_comment | PATCH /repos/{owner}/{repo}/issues/comments/{id} | Edit a comment |
| issue_edit_comment_deprecated | PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id} | Edit a comment |
| issue_edit_issue | PATCH /repos/{owner}/{repo}/issues/{index} | Edit an issue. If using deadline only the date will be taken into account, and time of day ignored. |
| issue_edit_issue_deadline | POST /repos/{owner}/{repo}/issues/{index}/deadline | Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored. |
| issue_edit_label | PATCH /repos/{owner}/{repo}/labels/{id} | Update a label |
| issue_edit_milestone | PATCH /repos/{owner}/{repo}/milestones/{id} | Update a milestone |
| issue_get_comment | GET /repos/{owner}/{repo}/issues/comments/{id} | Get a comment |
| issue_get_comment_reactions | GET /repos/{owner}/{repo}/issues/comments/{id}/reactions | Get a list of reactions from a comment of an issue |
| issue_get_comments | GET /repos/{owner}/{repo}/issues/{index}/comments | List all comments on an issue |
| issue_get_comments_and_timeline | GET /repos/{owner}/{repo}/issues/{index}/timeline | List all comments and events on an issue |
| issue_get_issue | GET /repos/{owner}/{repo}/issues/{index} | Get an issue |
| issue_get_issue_reactions | GET /repos/{owner}/{repo}/issues/{index}/reactions | Get a list reactions of an issue |
| issue_get_label | GET /repos/{owner}/{repo}/labels/{id} | Get a single label |
| issue_get_labels | GET /repos/{owner}/{repo}/issues/{index}/labels | Get an issue's labels |
| issue_get_milestone | GET /repos/{owner}/{repo}/milestones/{id} | Get a milestone |
| issue_get_milestones_list | GET /repos/{owner}/{repo}/milestones | Get all of a repository's opened milestones |
| issue_get_repo_comments | GET /repos/{owner}/{repo}/issues/comments | List all comments in a repository |
| issue_list_issues | GET /repos/{owner}/{repo}/issues | List a repository's issues |
| issue_list_labels | GET /repos/{owner}/{repo}/labels | Get all of a repository's labels |
| issue_post_comment_reaction | POST /repos/{owner}/{repo}/issues/comments/{id}/reactions | Add a reaction to a comment of an issue |
| issue_post_issue_reaction | POST /repos/{owner}/{repo}/issues/{index}/reactions | Add a reaction to an issue |
| issue_remove_label | DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id} | Remove a label from an issue |
| issue_replace_labels | PUT /repos/{owner}/{repo}/issues/{index}/labels | Replace an issue's labels |
| issue_reset_time | DELETE /repos/{owner}/{repo}/issues/{index}/times | Reset a tracked time of an issue |
| issue_search_issues | GET /repos/issues/search | Search for issues across the repositories that the user has access to |
| issue_start_stop_watch | POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start | Start stopwatch on an issue. |
| issue_stop_stop_watch | POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop | Stop an issue's existing stopwatch. |
| issue_subscriptions | GET /repos/{owner}/{repo}/issues/{index}/subscriptions | Get users who subscribed on an issue. |
| issue_tracked_times | GET /repos/{owner}/{repo}/issues/{index}/times | List an issue's tracked times |
issue_add_label
Veccrate::models::Label issue_add_label(owner, repo, index, body) Add a label to an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| body | Option<IssueLabelsOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_add_subscription
issue_add_subscription(owner, repo, index, user) Subscribe user to issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| user | String | user to subscribe | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_add_time
crate::models::TrackedTime issue_add_time(owner, repo, index, body) Add tracked time to a issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| body | Option<AddTimeOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_check_subscription
crate::models::WatchInfo issue_check_subscription(owner, repo, index) Check if user is subscribed to an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_clear_labels
issue_clear_labels(owner, repo, index) Remove all labels from an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_create_comment
crate::models::Comment issue_create_comment(owner, repo, index, body) Add a comment to an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| body | Option<CreateIssueCommentOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_create_issue
crate::models::Issue issue_create_issue(owner, repo, body) Create an issue. If using deadline only the date will be taken into account, and time of day ignored.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| body | Option<CreateIssueOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_create_label
crate::models::Label issue_create_label(owner, repo, body) Create a label
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| body | Option<CreateLabelOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_create_milestone
crate::models::Milestone issue_create_milestone(owner, repo, body) Create a milestone
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| body | Option<CreateMilestoneOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete
issue_delete(owner, repo, index) Delete an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of issue to delete | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_comment
issue_delete_comment(owner, repo, id) Delete a comment
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of comment to delete | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_comment_deprecated
issue_delete_comment_deprecated(owner, repo, index, id) Delete a comment
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i32 | this parameter is ignored | [required] | |
| id | i64 | id of comment to delete | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_comment_reaction
issue_delete_comment_reaction(owner, repo, id, content) Remove a reaction from a comment of an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the comment to edit | [required] | |
| content | Option<EditReactionOption> |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_issue_reaction
issue_delete_issue_reaction(owner, repo, index, content) Remove a reaction from an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| content | Option<EditReactionOption> |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_label
issue_delete_label(owner, repo, id) Delete a label
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the label to delete | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_milestone
issue_delete_milestone(owner, repo, id) Delete a milestone
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | String | the milestone to delete, identified by ID and if not available by name | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_stop_watch
issue_delete_stop_watch(owner, repo, index) Delete an issue's existing stopwatch.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to stop the stopwatch on | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_subscription
issue_delete_subscription(owner, repo, index, user) Unsubscribe user from issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| user | String | user witch unsubscribe | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_delete_time
issue_delete_time(owner, repo, index, id) Delete specific tracked time
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| id | i64 | id of time to delete | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_comment
crate::models::Comment issue_edit_comment(owner, repo, id, body) Edit a comment
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the comment to edit | [required] | |
| body | Option<EditIssueCommentOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_comment_deprecated
crate::models::Comment issue_edit_comment_deprecated(owner, repo, index, id, body) Edit a comment
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i32 | this parameter is ignored | [required] | |
| id | i64 | id of the comment to edit | [required] | |
| body | Option<EditIssueCommentOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_issue
crate::models::Issue issue_edit_issue(owner, repo, index, body) Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to edit | [required] | |
| body | Option<EditIssueOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_issue_deadline
crate::models::IssueDeadline issue_edit_issue_deadline(owner, repo, index, body) Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to create or update a deadline on | [required] | |
| body | Option<EditDeadlineOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_label
crate::models::Label issue_edit_label(owner, repo, id, body) Update a label
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the label to edit | [required] | |
| body | Option<EditLabelOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_edit_milestone
crate::models::Milestone issue_edit_milestone(owner, repo, id, body) Update a milestone
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | String | the milestone to edit, identified by ID and if not available by name | [required] | |
| body | Option<EditMilestoneOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_comment
crate::models::Comment issue_get_comment(owner, repo, id) Get a comment
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the comment | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_comment_reactions
Veccrate::models::Reaction issue_get_comment_reactions(owner, repo, id) Get a list of reactions from a comment of an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the comment to edit | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_comments
Veccrate::models::Comment issue_get_comments(owner, repo, index, since, before) List all comments on an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| since | Option<String> | if provided, only comments updated since the specified time are returned. | ||
| before | Option<String> | if provided, only comments updated before the provided time are returned. |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_comments_and_timeline
Veccrate::models::TimelineComment issue_get_comments_and_timeline(owner, repo, index, since, page, limit, before) List all comments and events on an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| since | Option<String> | if provided, only comments updated since the specified time are returned. | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results | ||
| before | Option<String> | if provided, only comments updated before the provided time are returned. |
Return type
Veccrate::models::TimelineComment
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_issue
crate::models::Issue issue_get_issue(owner, repo, index) Get an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to get | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_issue_reactions
Veccrate::models::Reaction issue_get_issue_reactions(owner, repo, index, page, limit) Get a list reactions of an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_label
crate::models::Label issue_get_label(owner, repo, id) Get a single label
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the label to get | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_labels
Veccrate::models::Label issue_get_labels(owner, repo, index) Get an issue's labels
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_milestone
crate::models::Milestone issue_get_milestone(owner, repo, id) Get a milestone
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | String | the milestone to get, identified by ID and if not available by name | [required] |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_milestones_list
Veccrate::models::Milestone issue_get_milestones_list(owner, repo, state, name, page, limit) Get all of a repository's opened milestones
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| state | Option<String> | Milestone state, Recognized values are open, closed and all. Defaults to "open" | ||
| name | Option<String> | filter by milestone name | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_get_repo_comments
Veccrate::models::Comment issue_get_repo_comments(owner, repo, since, before, page, limit) List all comments in a repository
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| since | Option<String> | if provided, only comments updated since the provided time are returned. | ||
| before | Option<String> | if provided, only comments updated before the provided time are returned. | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_list_issues
Veccrate::models::Issue issue_list_issues(owner, repo, state, labels, q, r#type, milestones, since, before, created_by, assigned_by, mentioned_by, page, limit) List a repository's issues
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| state | Option<String> | whether issue is open or closed | ||
| labels | Option<String> | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded | ||
| q | Option<String> | search string | ||
| r#type | Option<String> | filter by type (issues / pulls) if set | ||
| milestones | Option<String> | comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded | ||
| since | Option<String> | Only show items updated after the given time. This is a timestamp in RFC 3339 format | ||
| before | Option<String> | Only show items updated before the given time. This is a timestamp in RFC 3339 format | ||
| created_by | Option<String> | Only show items which were created by the the given user | ||
| assigned_by | Option<String> | Only show items for which the given user is assigned | ||
| mentioned_by | Option<String> | Only show items in which the given user was mentioned | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_list_labels
Veccrate::models::Label issue_list_labels(owner, repo, page, limit) Get all of a repository's labels
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_post_comment_reaction
crate::models::Reaction issue_post_comment_reaction(owner, repo, id, content) Add a reaction to a comment of an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| id | i64 | id of the comment to edit | [required] | |
| content | Option<EditReactionOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_post_issue_reaction
crate::models::Reaction issue_post_issue_reaction(owner, repo, index, content) Add a reaction to an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| content | Option<EditReactionOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_remove_label
issue_remove_label(owner, repo, index, id) Remove a label from an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| id | i64 | id of the label to remove | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_replace_labels
Veccrate::models::Label issue_replace_labels(owner, repo, index, body) Replace an issue's labels
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| body | Option<IssueLabelsOption> |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_reset_time
issue_reset_time(owner, repo, index) Reset a tracked time of an issue
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to add tracked time to | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_search_issues
Veccrate::models::Issue issue_search_issues(state, labels, milestones, q, priority_repo_id, r#type, since, before, assigned, created, mentioned, review_requested, owner, team, page, limit) Search for issues across the repositories that the user has access to
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| state | Option<String> | whether issue is open or closed | ||
| labels | Option<String> | comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded | ||
| milestones | Option<String> | comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded | ||
| q | Option<String> | search string | ||
| priority_repo_id | Option<i64> | repository to prioritize in the results | ||
| r#type | Option<String> | filter by type (issues / pulls) if set | ||
| since | Option<String> | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | ||
| before | Option<String> | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | ||
| assigned | Option<bool> | filter (issues / pulls) assigned to you, default is false | ||
| created | Option<bool> | filter (issues / pulls) created by you, default is false | ||
| mentioned | Option<bool> | filter (issues / pulls) mentioning you, default is false | ||
| review_requested | Option<bool> | filter pulls requesting your review, default is false | ||
| owner | Option<String> | filter by owner | ||
| team | Option<String> | filter by team (requires organization owner parameter to be provided) | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_start_stop_watch
issue_start_stop_watch(owner, repo, index) Start stopwatch on an issue.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to create the stopwatch on | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_stop_stop_watch
issue_stop_stop_watch(owner, repo, index) Stop an issue's existing stopwatch.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue to stop the stopwatch on | [required] |
Return type
(empty response body)
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_subscriptions
Veccrate::models::User issue_subscriptions(owner, repo, index, page, limit) Get users who subscribed on an issue.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
issue_tracked_times
Veccrate::models::TrackedTime issue_tracked_times(owner, repo, index, user, since, before, page, limit) List an issue's tracked times
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| owner | String | owner of the repo | [required] | |
| repo | String | name of the repo | [required] | |
| index | i64 | index of the issue | [required] | |
| user | Option<String> | optional filter by user (available for issue managers) | ||
| since | Option<String> | Only show times updated after the given time. This is a timestamp in RFC 3339 format | ||
| before | Option<String> | Only show times updated before the given time. This is a timestamp in RFC 3339 format | ||
| page | Option<i32> | page number of results to return (1-based) | ||
| limit | Option<i32> | page size of results |
Return type
Authorization
AccessToken, AuthorizationHeaderToken, BasicAuth, SudoHeader, SudoParam, TOTPHeader, Token
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]