f3-schemas/review.json

85 lines
1.6 KiB
JSON

{
"title": "Review",
"description": "A set of review comments on a pull/merge request.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "Unique identifier of the review.",
"type": "string"
},
"reviewer_id": {
"description": "Unique identifer of review author.",
"type": "string"
},
"official": {
"description": "True if a positive review counts to reach the required threshold.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"commit_id": {
"description": "SHA of the commit targeted by the review.",
"type": "string"
},
"content": {
"description": "Cover message of the review.",
"type": "string"
},
"created_at": {
"description": "Creation time.",
"type": "string",
"format": "date-time"
},
"state": {
"description": "State of the review.",
"enum": [
"PENDING",
"APPROVED",
"CHANGES_REQUESTED",
"COMMENTED"
]
},
"dissmissed": {
"description": "True if the review was dismissed.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stale": {
"description": "True if the review is stale because the pull request content changed after it was published.",
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"reviewer_id",
"commit_id",
"content",
"created_at",
"state"
],
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://lab.forgefriends.org/friendlyforgeformat/f3-schemas/-/blob/v1.0/release.json",
"$$target": "release.json"
}