Comment

http://example.com/comment.json
Comments associated to an issue or a pull/merge request within the repository of a forge (Gitea, GitLab, etc.).
type	object
properties
issue_index	Unique identifier of the issue or pull/merge request containing the comment.
	type	number
index	Unique identifier of the comment.
	type	number
poster_id	Unique identifier of the user who authored the comment.
	type	number
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
content	Multiline content of the comment.
	type	string
reactions	List of reactions.
	anyOf	type	array
		items	Reaction
		type	null
additionalProperties	False

Identities

http://example.com/identities.json
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
pairs	type	array
	items	type	number
additionalProperties	False

Issue

http://example.com/issue.json
Issues associated to a repository within a forge (Gitea, GitLab, etc.).
type	object
properties
index	Unique identifier, relative to the repository.
	type	number
poster_id	Unique identifier of the user who authored the issue.
	type	number
title	Short description displayed as the title.
	type	string
content	Long, multiline, description.
	type	string
ref	Target branch in the repository.
	type	string
milestone	Name of the milestone.
	type	string
state	A ‘closed’ issue will not see any activity in the future, otherwise it is ‘open’.
	enum	closed, open
is_locked	A locked issue can only be modified by privileged users.
	type	boolean
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
closed	The last time ‘state’ changed to ‘closed’.
	anyOf	type	string
		format	date-time
		type	null
labels	List of labels.
	anyOf	type	array
		items	type	string
		type	null
reactions	List of reactions.
	anyOf	type	array
		items	Reaction
		type	null
assignees	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
index	Unique identifier.
	type	number
name	Name of the label, unique within the repository.
	type	string
color	Color code of the label.
	type	string
description	Long, multiline, description.
	type	string
additionalProperties	False

Milestone

http://example.com/milestone.json
Milestone associated to a repository within a forge.
type	object
properties
index	Unique identifier.
	type	number
title	Short description.
	type	string
description	Long, multiline, description.
	type	string
deadline	Deadline after which the milestone is overdue.
	type	string
	format	date-time
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
closed	The last time ‘state’ changed to ‘closed’.
	anyOf	type	string
		format	date-time
		type	null
state	A ‘closed’ issue will not see any activity in the future, otherwise it is ‘open’.
	enum	closed, open
additionalProperties	False

Project

http://example.com/project.json
A software project that resides on a forge (Gitea, GitLab, etc.).
type	object
properties
index	Unique identifier of the project.
	type	number
name	Name of the project, relative to the owner.
	type	string
owner	Owner of the project, either a forge user or an organization.
	type	string
is_private	True if the visibility of the project is not public.
	type	boolean
is_mirror	True if it is a mirror of a project residing on another forge.
	type	boolean
description	Long, multiline, description of the project.
	type	string
clone_url	URL to clone the git repository of the project.
	type	string
original_url	URL of the homepage of the project.
	type	string
default_branch	Name of the default branch in the git repository.
	type	string
repositories	type	array
	items	Repository
additionalProperties	False

PullRequest

http://example.com/pullrequest.json
Pull requests associated to a repository within a forge (Gitea, GitLab, etc.).
type	object
properties
index	Unique identifier, relative to the repository.
	type	number
poster_id	Unique identifier of the user who authored the pull request.
	type	number
title	Short description displayed as the title.
	type	string
content	Long, multiline, description.
	type	string
milestone	Name of the milestone.
	type	string
state	A ‘closed’ pull request will not see any activity in the future, otherwise it is ‘open’.
	enum	closed, open
is_locked	A locked pull request can only be modified by privileged users.
	type	boolean
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
closed	The last time ‘state’ changed to ‘closed’.
	anyOf	type	string
		format	date-time
		type	null
labels	List of labels.
	anyOf	type	array
		items	type	string
		type	null
reactions	List of reactions.
	anyOf	type	array
		items	Reaction
		type	null
assignees	List of assignees.
	anyOf	type	array
		items	Name of a user assigned to the issue.
			type	string
		type	null
patch_url	URL from which the patch of the pull request can be retrieved.
	type	string
merged	True if the pull request was merged.
	type	boolean
merged_time	The time when the pull request was merged.
	anyOf	type	string
		format	date-time
		type	null
merged_commit_sha	The SHA of the merge commit.
	anyOf	type	string
		type	null
head	The changes proposed in the pull request.
	anyOf	type	object
		type	null
base	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

http://example.com/pullrequestbranch.json
The location of a commit, including the URL of the repository where it can be found.
type	object
properties
clone_url	URL of the repository where the commit is located.
	type	string
ref	Git reference of the commit.
	type	string
sha	SHA of the commit.
	type	string
repo_name	Name of the project that contains the git repository.
	type	string
owner_name	Name of the user or organization that contains the project.
	type	string
additionalProperties	False

Reaction

http://example.com/reaction.json
Reaction associated to an issue or a comment.
type	object
properties
index	Unique identifier of the reaction.
	type	number
user_id	Unique identifier of the user who authored the reaction.
	type	number
content	Representation of the reaction
	type	string
additionalProperties	False

Release

http://example.com/release.json
Assets that constitute a release for a given tag.
type	object
properties
index	Unique identifier.
	type	number
tag_name	Git tag name of the release.
	type	string
target_commitish	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
name	The name of the release.
	type	string
body	Text describing the contents of the release.
	type	string
draft	True if the release is a draft.
	type	boolean
prerelease	True if the release is a pre-release.
	type	boolean
publisher_id	Unique identifier of the user who authored the release.
	type	number
publisher_name	Name of the user who authored the release.
	type	string
publisher_email	Email of the user who authored the release.
	type	string
assets	List of assets associated with the release.
	anyOf	type	array
		items	Release asset
		type	null
created	Creation time.
	type	string
	format	date-time
published	Publication time.
	type	string
	format	date-time
additionalProperties	False

Release asset

http://example.com/releaseasset.json
A file associated with a release.
type	object
properties
index	Unique identifier of the release asset.
	type	number
name	The name of the release asset.
	type	string
content_type	The content type of the release asset (application/zip, etc.).
	type	string
size	Size in bytes of the release asset.
	type	number
download_count	The number of times the release asset was downloaded.
	type	number
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
download_url	The URL from which the release asset can be downloaded.
	type	string
additionalProperties	False

Repository

http://example.com/repository.json
VCS repository relative to a project.
type	object
properties
name	Suffix to add to the clone URL of the project to access the repository.
	type	string
additionalProperties	False

Review

http://example.com/release.json
A set of review comments on a pull/merge request.
type	object
properties
index	Unique identifier of the review.
	type	number
issue_index	Unique identifier of the pull/merge request targeted by the review.
	type	number
reviewer_id	Unique identifer of review author.
	type	number
official	True if a positive review counts to reach the required threshold.
	anyOf	type	boolean
		type	null
commit_id	SHA of the commit targeted by the review.
	type	string
content	Cover message of the review.
	type	string
created_at	Creation time.
	type	string
	format	date-time
state	State of the review.
	enum	PENDING, APPROVED, CHANGES_REQUESTED, COMMENTED
comments	Review comments inserted on a specific line of the commit.
	anyOf	type	array
		items	Review comment
		type	null
additionalProperties	False

Review comment

http://example.com/reviewcomment.json
A comment in the context of a review.
type	object
properties
index	Unique identifier of the review comment.
	type	number
in_reply_to	Unique identifier of the review comment replied to.
	type	number
content	The text of the review comment.
	type	string
tree_path	The relative path to the file that necessitates a comment.
	type	string
diff_hunk	The hunk being commented on, which is the same as the patch only in a different format.
	type	string
patch	The patch being commented on, which is the same as the diff_hunk only in a different format.
	type	string
position	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
line	The line number of the comment in the tree_path.
	type	number
commit_id	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
poster_id	Unique identifier of the user who authored the comment.
	type	number
reactions	List of reactions.
	anyOf	type	array
		items	Reaction
		type	null
created_at	Creation time.
	type	string
	format	date-time
updated_at	Last update time.
	type	string
	format	date-time
additionalProperties	False

Topic

http://example.com/topic.json
A list of categories associated with a project.
type	object
properties
index	Unique identifier.
	type	number
name	The name of the category the project belongs to.
	type	string
additionalProperties	False