Comment
Comments associated to an issue or a pull/merge request within the repository of a forge (Gitea, GitLab, etc.). |
|||
type |
object |
||
properties |
|||
|
Unique identifier of the issue or pull/merge request containing the comment. |
||
type |
number |
||
|
Unique identifier of the comment. |
||
type |
number |
||
|
Unique identifier of the user who authored the comment. |
||
type |
number |
||
|
Creation time. |
||
type |
string |
||
format |
date-time |
||
|
Last update time. |
||
type |
string |
||
format |
date-time |
||
|
Multiline content of the comment. |
||
type |
string |
||
|
List of reactions. |
||
anyOf |
type |
array |
|
items |
|||
type |
null |
||
additionalProperties |
False |
Identities
Pairs of identities mapping one forge to another. The first element is the id in the source forge, the second element is the id in the destination forge. |
|||
type |
object |
||
properties |
|||
|
type |
array |
|
items |
type |
number |
|
additionalProperties |
False |
Issue
Issues associated to a repository within a forge (Gitea, GitLab, etc.). |
||||
type |
object |
|||
properties |
||||
|
Unique identifier, relative to the repository. |
|||
type |
number |
|||
|
Unique identifier of the user who authored the issue. |
|||
type |
number |
|||
|
Short description displayed as the title. |
|||
type |
string |
|||
|
Long, multiline, description. |
|||
type |
string |
|||
|
Target branch in the repository. |
|||
type |
string |
|||
|
Name of the milestone. |
|||
type |
string |
|||
|
A ‘closed’ issue will not see any activity in the future, otherwise it is ‘open’. |
|||
enum |
closed, open |
|||
|
A locked issue can only be modified by privileged users. |
|||
type |
boolean |
|||
|
Creation time. |
|||
type |
string |
|||
format |
date-time |
|||
|
Last update time. |
|||
type |
string |
|||
format |
date-time |
|||
|
The last time ‘state’ changed to ‘closed’. |
|||
anyOf |
type |
string |
||
format |
date-time |
|||
type |
null |
|||
|
List of labels. |
|||
anyOf |
type |
array |
||
items |
type |
string |
||
type |
null |
|||
|
List of reactions. |
|||
anyOf |
type |
array |
||
items |
||||
type |
null |
|||
|
List of assignees. |
|||
anyOf |
type |
array |
||
items |
Name of a user assigned to the issue. |
|||
type |
string |
|||
type |
null |
|||
additionalProperties |
False |
Label
label.json |
||
Label associated to an issue. |
||
type |
object |
|
properties |
||
|
Unique identifier. |
|
type |
number |
|
|
Name of the label, unique within the repository. |
|
type |
string |
|
|
Color code of the label. |
|
type |
string |
|
|
Long, multiline, description. |
|
type |
string |
|
additionalProperties |
False |
Milestone
Milestone associated to a repository within a forge. |
|||
type |
object |
||
properties |
|||
|
Unique identifier. |
||
type |
number |
||
|
Short description. |
||
type |
string |
||
|
Long, multiline, description. |
||
type |
string |
||
|
Deadline after which the milestone is overdue. |
||
type |
string |
||
format |
date-time |
||
|
Creation time. |
||
type |
string |
||
format |
date-time |
||
|
Last update time. |
||
type |
string |
||
format |
date-time |
||
|
The last time ‘state’ changed to ‘closed’. |
||
anyOf |
type |
string |
|
format |
date-time |
||
type |
null |
||
|
A ‘closed’ issue will not see any activity in the future, otherwise it is ‘open’. |
||
enum |
closed, open |
||
additionalProperties |
False |
Project
A software project that resides on a forge (Gitea, GitLab, etc.). |
||
type |
object |
|
properties |
||
|
Unique identifier of the project. |
|
type |
number |
|
|
Name of the project, relative to the owner. |
|
type |
string |
|
|
Owner of the project, either a forge user or an organization. |
|
type |
string |
|
|
True if the visibility of the project is not public. |
|
type |
boolean |
|
|
True if it is a mirror of a project residing on another forge. |
|
type |
boolean |
|
|
Long, multiline, description of the project. |
|
type |
string |
|
|
URL to clone the git repository of the project. |
|
type |
string |
|
|
URL of the homepage of the project. |
|
type |
string |
|
|
Name of the default branch in the git repository. |
|
type |
string |
|
|
type |
array |
items |
||
additionalProperties |
False |
PullRequest
Pull requests associated to a repository within a forge (Gitea, GitLab, etc.). |
||||
type |
object |
|||
properties |
||||
|
Unique identifier, relative to the repository. |
|||
type |
number |
|||
|
Unique identifier of the user who authored the pull request. |
|||
type |
number |
|||
|
Short description displayed as the title. |
|||
type |
string |
|||
|
Long, multiline, description. |
|||
type |
string |
|||
|
Name of the milestone. |
|||
type |
string |
|||
|
A ‘closed’ pull request will not see any activity in the future, otherwise it is ‘open’. |
|||
enum |
closed, open |
|||
|
A locked pull request can only be modified by privileged users. |
|||
type |
boolean |
|||
|
Creation time. |
|||
type |
string |
|||
format |
date-time |
|||
|
Last update time. |
|||
type |
string |
|||
format |
date-time |
|||
|
The last time ‘state’ changed to ‘closed’. |
|||
anyOf |
type |
string |
||
format |
date-time |
|||
type |
null |
|||
|
List of labels. |
|||
anyOf |
type |
array |
||
items |
type |
string |
||
type |
null |
|||
|
List of reactions. |
|||
anyOf |
type |
array |
||
items |
||||
type |
null |
|||
|
List of assignees. |
|||
anyOf |
type |
array |
||
items |
Name of a user assigned to the issue. |
|||
type |
string |
|||
type |
null |
|||
|
URL from which the patch of the pull request can be retrieved. |
|||
type |
string |
|||
|
True if the pull request was merged. |
|||
type |
boolean |
|||
|
The time when the pull request was merged. |
|||
anyOf |
type |
string |
||
format |
date-time |
|||
type |
null |
|||
|
The SHA of the merge commit. |
|||
anyOf |
type |
string |
||
type |
null |
|||
|
The changes proposed in the pull request. |
|||
anyOf |
type |
object |
||
type |
null |
|||
|
The branch where the pull request changes in the head are to be merged. |
|||
anyOf |
type |
object |
||
type |
null |
|||
additionalProperties |
False |
PullRequest reference to a commit
The location of a commit, including the URL of the repository where it can be found. |
||
type |
object |
|
properties |
||
|
URL of the repository where the commit is located. |
|
type |
string |
|
|
Git reference of the commit. |
|
type |
string |
|
|
SHA of the commit. |
|
type |
string |
|
|
Name of the project that contains the git repository. |
|
type |
string |
|
|
Name of the user or organization that contains the project. |
|
type |
string |
|
additionalProperties |
False |
Reaction
Reaction associated to an issue or a comment. |
||
type |
object |
|
properties |
||
|
Unique identifier of the reaction. |
|
type |
number |
|
|
Unique identifier of the user who authored the reaction. |
|
type |
number |
|
|
Representation of the reaction |
|
type |
string |
|
additionalProperties |
False |
Release
Assets that constitute a release for a given tag. |
|||
type |
object |
||
properties |
|||
|
Unique identifier. |
||
type |
number |
||
|
Git tag name of the release. |
||
type |
string |
||
|
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. |
||
type |
string |
||
|
The name of the release. |
||
type |
string |
||
|
Text describing the contents of the release. |
||
type |
string |
||
|
True if the release is a draft. |
||
type |
boolean |
||
|
True if the release is a pre-release. |
||
type |
boolean |
||
|
Unique identifier of the user who authored the release. |
||
type |
number |
||
|
Name of the user who authored the release. |
||
type |
string |
||
|
Email of the user who authored the release. |
||
type |
string |
||
|
List of assets associated with the release. |
||
anyOf |
type |
array |
|
items |
|||
type |
null |
||
|
Creation time. |
||
type |
string |
||
format |
date-time |
||
|
Publication time. |
||
type |
string |
||
format |
date-time |
||
additionalProperties |
False |
Release asset
A file associated with a release. |
||
type |
object |
|
properties |
||
|
Unique identifier of the release asset. |
|
type |
number |
|
|
The name of the release asset. |
|
type |
string |
|
|
The content type of the release asset (application/zip, etc.). |
|
type |
string |
|
|
Size in bytes of the release asset. |
|
type |
number |
|
|
The number of times the release asset was downloaded. |
|
type |
number |
|
|
Creation time. |
|
type |
string |
|
format |
date-time |
|
|
Last update time. |
|
type |
string |
|
format |
date-time |
|
|
The URL from which the release asset can be downloaded. |
|
type |
string |
|
additionalProperties |
False |
Repository
VCS repository relative to a project. |
||
type |
object |
|
properties |
||
|
Suffix to add to the clone URL of the project to access the repository. |
|
type |
string |
|
additionalProperties |
False |
Review
A set of review comments on a pull/merge request. |
|||
type |
object |
||
properties |
|||
|
Unique identifier of the review. |
||
type |
number |
||
|
Unique identifier of the pull/merge request targeted by the review. |
||
type |
number |
||
|
Unique identifer of review author. |
||
type |
number |
||
|
True if a positive review counts to reach the required threshold. |
||
anyOf |
type |
boolean |
|
type |
null |
||
|
SHA of the commit targeted by the review. |
||
type |
string |
||
|
Cover message of the review. |
||
type |
string |
||
|
Creation time. |
||
type |
string |
||
format |
date-time |
||
|
State of the review. |
||
enum |
PENDING, APPROVED, CHANGES_REQUESTED, COMMENTED |
||
|
Review comments inserted on a specific line of the commit. |
||
anyOf |
type |
array |
|
items |
|||
type |
null |
||
additionalProperties |
False |
Review comment
A comment in the context of a review. |
|||
type |
object |
||
properties |
|||
|
Unique identifier of the review comment. |
||
type |
number |
||
|
Unique identifier of the review comment replied to. |
||
type |
number |
||
|
The text of the review comment. |
||
type |
string |
||
|
The relative path to the file that necessitates a comment. |
||
type |
string |
||
|
The hunk being commented on, which is the same as the patch only in a different format. |
||
type |
string |
||
|
The patch being commented on, which is the same as the diff_hunk only in a different format. |
||
type |
string |
||
|
Equals the number of lines down from the first ‘@@’ hunk header in the file you want to add a comment. The line just below the ‘@@’ line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. |
||
type |
number |
||
|
The line number of the comment in the tree_path. |
||
type |
number |
||
|
The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position. |
||
type |
string |
||
|
Unique identifier of the user who authored the comment. |
||
type |
number |
||
|
List of reactions. |
||
anyOf |
type |
array |
|
items |
|||
type |
null |
||
|
Creation time. |
||
type |
string |
||
format |
date-time |
||
|
Last update time. |
||
type |
string |
||
format |
date-time |
||
additionalProperties |
False |
Topic
A list of categories associated with a project. |
||
type |
object |
|
properties |
||
|
Unique identifier. |
|
type |
number |
|
|
The name of the category the project belongs to. |
|
type |
string |
|
additionalProperties |
False |