f3-schemas/issue.json
Jean Daricade 827c71b3ed
issue: poster_id is a reference
It previously was the identifier of the user (string) and is now the
reference to the user (a path to the user that ends with the unique
identifier.
2024-04-17 09:38:55 +02:00

136 lines
2.7 KiB
JSON

{
"title": "Issue",
"description": "An issue within an issue tracking system, relative to a project.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "Unique identifier of the issue.",
"type": "string"
},
"poster_id": {
"description": "Reference to the user who authored the issue.",
"type": "string"
},
"title": {
"description": "Short description displayed as the title.",
"type": "string"
},
"content": {
"description": "Description of the issue.",
"type": "string"
},
"ref": {
"description": "Optional reference (branch) associated with the issue in the project repository.",
"type": "string"
},
"milestone": {
"description": "Unique identifier of the milestone.",
"type": "string"
},
"state": {
"description": "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": {
"description": "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": {
"description": "Creation time.",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Last update time.",
"type": "string",
"format": "date-time"
},
"closed": {
"description": "The last time 'state' changed to 'closed'.",
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"due": {
"description": "Due date.",
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"labels": {
"description": "List of labels.",
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"reactions": {
"description": "List of reactions.",
"anyOf": [
{
"type": "array",
"items": {
"$ref": "reaction.json"
}
},
{
"type": "null"
}
]
},
"assignees": {
"description": "List of assignees.",
"anyOf": [
{
"type": "array",
"items": {
"description": "Name of a user assigned to the issue.",
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"poster_id",
"title",
"content",
"state",
"is_locked",
"created",
"updated"
],
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://lab.forgefriends.org/friendlyforgeformat/f3-schemas/-/blob/v1.0/issue.json",
"$$target": "issue.json"
}