Attachment

https://code.forgejo.org/f3/f3-schemas/src/branch/main/attachment.json
A file attached to a release, comment, etc.. The content of the file is opaque.
type	object
properties
index	Unique identifier of the attachment.
	type	string
name	The name of the attachment.
	type	string
content_type	The content type of the attachment (application/zip, etc.).
	type	string
size	Size in bytes of the attachment.
	type	number
download_count	The number of times the attachment was downloaded.
	type	number
download_url	The URL from which the attachment can be downloaded.
	type	string
created	Creation time.
	type	string
	format	date-time
sha256	SHA256 of the content of the attachment.
	type	string
additionalProperties	False

CI

https://code.forgejo.org/f3/f3-schemas/src/branch/main/ci.json
The Continuous Integration supported by the project. The configuration files are found in the repository itself, under a path that depends on the CI system.
type	object
properties
index	The type of continuous integration
	enum	Apache Gump, Azure DevOps Server, Bamboo, Buddy, Buildbot, BuildMaster, CircleCI, Drone, Forgejo Actions, Gitea Actions, GitHub Actions, GitLab, GoCD, Jenkins, OpenMake, Semaphore, TeamCity, tekton, Travis CI, Vexor, Woodpecker CI
additionalProperties	False

Comment

https://code.forgejo.org/f3/f3-schemas/src/branch/main/comment.json
Comment associated to a commentable object (i.e. issue, review, etc.). Forge users add a comment to an object to create a non-threaded conversation.
type	object
properties
index	Unique identifier of the comment.
	type	string
poster_id	Unique identifier of the comment author.
	type	string
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
content	Markdown content of the comment.
	type	string
reactions	List of reactions.
	type	array
	items	Reaction
additionalProperties	False

Issue

https://code.forgejo.org/f3/f3-schemas/src/branch/main/issue.json
An issue within an issue tracking system, relative to a project.
type	object
properties
index	Unique identifier of the issue.
	type	string
poster_id	Unique identifier of the user who authored the issue.
	type	string
title	Short description displayed as the title.
	type	string
content	Description of the issue.
	type	string
milestone	Unique identifier of the milestone.
	type	string
state	An issue is ‘closed’ when it is resolved, ‘open’ otherwise. Issues that do not relate to a topic that needs to be resolved, such as an open conversation, may never be closed.
	enum	closed, open
is_locked	A locked issue can only be modified by privileged users. It is commonly used for moderation purposes when comments associated with the issue are too heated.
	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’.
	type	string
	format	date-time
due	Due date.
	type	string
	format	date
labels	List of label unique identifiers.
	type	array
	items	type	string
reactions	List of reactions.
	type	array
	items	Reaction
assignees	List of assignees.
	type	array
	items	Name of a user assigned to the issue.
		type	string
additionalProperties	False

Label

https://code.forgejo.org/f3/f3-schemas/src/branch/main/label.json
Label associated to an issue.
type	object
properties
index	Unique identifier.
	type	string
name	Name of the label, unique within the repository.
	type	string
color	Color code of the label in RGB notation ‘xxx’ or ‘xxxxxx’.
	type	string
description	Long description.
	type	string
exclusive	There can only be one label with the prefix found before the first slash (/).
	type	boolean
additionalProperties	False

Milestone

https://code.forgejo.org/f3/f3-schemas/src/branch/main/milestone.json
Milestone relative to a project, for the purpose of grouping objects due to a given date (issues, etc.).
type	object
properties
index	Unique identifier.
	type	string
title	Short description.
	type	string
description	Long 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’.
	type	string
	format	date-time
state	A ‘closed’ milestone will not see any activity in the future, otherwise it is ‘open’.
	enum	closed, open
additionalProperties	False

Object

https://code.forgejo.org/f3/f3-schemas/src/branch/main/object.json
Meta information and reference to an opaque content such as an image. The unique identifier is the SHA-256 of the content of the object.
type	object
properties
index	Unique identifier.
	type	string
mime	Mime type of the object.
	type	string
name	Human readable file name.
	type	string
description	Description.
	type	string
additionalProperties	False

Organization

https://code.forgejo.org/f3/f3-schemas/src/branch/main/organization.json
A forge organization.
type	object
properties
index	Unique identifier of the organization.
	type	string
name	Unique name of the organization.
	type	string
full_name	Readable name of the organization.
	type	string
avatar	Base64 encoded image of the avatar.
	type	string
additionalProperties	False

Project

https://code.forgejo.org/f3/f3-schemas/src/branch/main/project.json
A software project contains a code repository, an issue tracker, etc.
type	object
properties
index	Unique identifier of the project.
	type	string
name	Name of the project, relative to the owner.
	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 description of the project.
	type	string
avatar	Base64 encoded image of the avatar.
	type	string
default_branch	Name of the default branch in the code repository.
	type	string
forked	Unique identifier of the project from which this one was forked.
	type	string
ci	type	array
	items	CI
archived	True if archived and read only.
	type	boolean
archived_at	Time of archival.
	type	string
	format	date-time
created	Creation time.
	type	string
	format	date-time
updated	Last update time.
	type	string
	format	date-time
has_wiki	True if the wiki is enabled.
	type	boolean
topics	List of topics assigned to the project.
	type	array
	items	Topic assigned to the project.
		type	string
additionalProperties	False

Pull request

https://code.forgejo.org/f3/f3-schemas/src/branch/main/pullrequest.json
A pull requests to merge a commit from a ‘head’ that may be another branch in the same repository or a branch in a forked repository.
type	object
properties
index	Unique identifier of the pull request.
	type	string
poster_id	Unique identifier of the user who authored the pull request.
	type	string
title	Short description displayed as the title.
	type	string
content	Long description.
	type	string
milestone	Unique identifier 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’.
	type	string
	format	date-time
labels	List of labels unique identifiers.
	type	array
	items	type	string
reactions	List of reactions.
	type	array
	items	Reaction
assignees	List of assignees.
	type	array
	items	Name of a user assigned to the issue.
		type	string
merged	True if the pull request was merged.
	type	boolean
merged_time	The time when the pull request was merged.
	type	string
	format	date-time
merged_commit_sha	The SHA of the merge commit.
	type	string
head	The changes proposed in the pull request.
	type	object
base	The branch where the pull request changes in the head are to be merged.
	type	object
merged_by	Unique identifier of the user who merged the pull request.
	type	string
due	Due date.
	type	string
	format	date
allow_edit	True when the author of the pull request allows pushing new commits to its branch.
	type	boolean
additionalProperties	False

Pull request reference to a commit

https://code.forgejo.org/f3/f3-schemas/src/branch/main/pullrequestbranch.json
The location of a commit and the repository where it can be found.
type	object
properties
ref	Repository reference of the commit (branch, tag, etc.).
	type	string
sha	SHA of the commit.
	type	string
repository	Unique identifier of the repository.
	type	string
additionalProperties	False

Reaction

https://code.forgejo.org/f3/f3-schemas/src/branch/main/reaction.json
Reaction associated to a comment that is displayed as a single emoji.
type	object
properties
index	Unique identifier of the reaction.
	type	string
user_id	Unique identifier of the user who authored the reaction.
	type	string
content	Representation of the reaction. The rendering of the reaction depends on the forge displaying it.
	type	string
additionalProperties	False

Release

https://code.forgejo.org/f3/f3-schemas/src/branch/main/release.json
A release is associated with a tag in a repository and contains of a set of files (release assets).
type	object
properties
index	Unique identifier of the release.
	type	string
tag_name	Tag name of the release.
	type	string
target_commitish	Specifies the commitish value that determines where the tag is created from. Can be any branch or commit SHA. If present, it must be exactly the same as the SHA of the tag_name.
	type	string
name	The name of the release.
	type	string
body	Text describing the contents of the release, usually the release notes.
	type	string
draft	True if the release is a draft that is in the process of being published. This is a transient state that may be used when the forge is unable to publish a release atomically.
	type	boolean
prerelease	True if the release is a pre-release, in the sense documented at https://semver.org/.
	type	boolean
publisher_id	Unique identifier of the user who authored the release.
	type	string
created	Creation time.
	type	string
	format	date-time
additionalProperties	False

Repository

https://code.forgejo.org/f3/f3-schemas/src/branch/main/repository.json
VCS repository relative to a project. The actual content of the repository is found in the sibling ‘repository’ directory.
type	object
properties
index	Unique identifier of the repository.
	type	string
vcs	The type of the repository, defaults to ‘git’
	enum	git, hg, bazaar, darcs, fossil, svn
additionalProperties	False

Review

https://code.forgejo.org/f3/f3-schemas/src/branch/main/review.json
A set of review comments on a pull/merge request.
type	object
properties
index	Unique identifier of the review.
	type	string
reviewer_id	Unique identifier of review author.
	type	string
official	True if a positive review counts to reach the required threshold.
	type	boolean
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
additionalProperties	False

Review comment

https://code.forgejo.org/f3/f3-schemas/src/branch/main/reviewcomment.json
A comment in the context of a review.
type	object
properties
index	Unique identifier of the review comment.
	type	string
content	The text of the review comment.
	type	string
tree_path	The relative path to the file commented on.
	type	string
diff_hunk	The hunk commented on.
	type	string
line	The line number of the comment relative to the tree_path.
	type	number
lines_count	The range of lines that are commented on. If absent it defaults to one and is a single line comment. If specified it must be a positive number. If line is N and lines_count is C, the range of lines commented on is ]N-C,N]. In other words, the range starts lines_count before line, which is the last of the range
	type	number
commit_id	The SHA of the tree_path commented on.
	type	string
poster_id	Unique identifier of the user who authored the comment.
	type	string
reactions	List of reactions.
	type	array
	items	Reaction
created_at	Creation time.
	type	string
	format	date-time
updated_at	Last update time.
	type	string
	format	date-time
resolver	Unique identifier of the user who resolved the comment.
	type	string
additionalProperties	False

Team

https://code.forgejo.org/f3/f3-schemas/src/branch/main/team.json
A team of users and their associated permissions on a list of projects.
type	object
properties
index	Unique identifier of the team.
	type	string
name	Name of the team.
	type	string
description	Long description of the team.
	type	string
permissions	type	array
	items	Permission.
		enum	admin, repository:none, repository:read, repository:write, issue:none, issue:read, issue:write, pull_request:none, pull_request:read, pull_request:write, release:none, release:read, release:write
all_projects	If true, the permissions apply to all projects in the organization.
	type	boolean
additionalProperties	False

Team member

https://code.forgejo.org/f3/f3-schemas/src/branch/main/teammember.json
A user that is a member of a team.
type	object
properties
index	Unique identifier of the team member.
	type	string
name	Name of the team member, equal to the user name.
	type	string
user	Unique identifier of the user who is a member of the team.
	type	string
additionalProperties	False

Team project

https://code.forgejo.org/f3/f3-schemas/src/branch/main/teamproject.json
A project that is in scope for a team.
type	object
properties
index	Unique identifier of the project.
	type	string
name	Name of the team project, equal to the project name.
	type	string
project	Unique identifier of the project that is in scope for the team.
	type	string
additionalProperties	False

Topic

https://code.forgejo.org/f3/f3-schemas/src/branch/main/topic.json
A category associated with a project. There can be multiple topics/categories for a given project.
type	object
properties
index	Unique identifier.
	type	string
name	The name of the category the project belongs to.
	type	string
additionalProperties	False

User

https://code.forgejo.org/f3/f3-schemas/src/branch/main/user.json
A forge user.
type	object
properties
index	Unique identifier of the user.
	type	string
name	User readable name of the user.
	type	string
email	Mail of the user.
	type	string
username	Unique name of the user.
	type	string
avatar	Base64 encoded image of the avatar.
	type	string
password	Password of the user.
	type	string
admin	True if the user has administrative permissions on the forge.
	type	boolean
additionalProperties	False