f3-schemas/project.json

125 lines
2.8 KiB
JSON

{
"title": "Project",
"description": "A software project contains a code repository, an issue tracker, etc.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "Unique identifier of the project.",
"type": "string"
},
"name": {
"description": "Name of the project, relative to the owner.",
"type": "string"
},
"is_private": {
"description": "True if the visibility of the project is not public.",
"type": "boolean"
},
"is_mirror": {
"description": "True if it is a mirror of a project residing on another forge.",
"type": "boolean"
},
"description": {
"description": "Long description of the project.",
"type": "string"
},
"default_branch": {
"description": "Name of the default branch in the code repository.",
"type": "string"
},
"repositories": {
"type": "array",
"items": {
"$ref": "repository.json"
}
},
"forked": {
"description": "Unique identifier of the project from which this one was forked.",
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"ci": {
"type": "array",
"items": {
"$ref": "ci.json"
}
},
"archived": {
"description": "True if archived and read only.",
"type": "boolean"
},
"archived_at": {
"description": "Time of archival.",
"type": "string",
"format": "date-time"
},
"created": {
"description": "Creation time.",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Last update time.",
"type": "string",
"format": "date-time"
},
"url": {
"description": "URL associated with the project, for instance the project home page.",
"type": "string"
},
"stars": {
"description": "Number of stars.",
"type": "number"
},
"has_ci": {
"description": "True if CI is enabled.",
"type": "boolean"
},
"has_issues": {
"description": "True if the issue tracker is enabled.",
"type": "boolean"
},
"has_packages": {
"description": "True if the software packages are enabled.",
"type": "boolean"
},
"has_kanban": {
"description": "True if the kanban is enabled.",
"type": "boolean"
},
"has_pull_requests": {
"description": "True if pull requests are enabled.",
"type": "boolean"
},
"has_releases": {
"description": "True if releases are enabled.",
"type": "boolean"
},
"has_wiki": {
"description": "True if the wiki is enabled.",
"type": "boolean"
}
},
"required": [
"index",
"name",
"is_private",
"is_mirror",
"description",
"default_branch",
"repositories"
],
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://lab.forgefriends.org/friendlyforgeformat/f3-schemas/-/blob/v1.0/project.json",
"$$target": "project.json"
}