{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/pullRequestGet", "title": "Pull Request Payload", "type": "object", "properties": { "createdAt": { "type": "string", "description": "The date and time at which the pull request was created.", "example": "2024-02-20T09:55:46.000Z" }, "updatedAt": { "type": "string", "description": "The date and time at which the pull request was updated.", "example": "2024-02-20T09:58:38.000Z" }, "id": { "type": "string", "description": "The pull request's ID.", "example": "4e1a6609-1a29-4037-a411-89ecc14c6cd8" }, "title": { "type": "string", "description": "The pull request's title.", "example": "Test PR" }, "description": { "type": "string", "description": "The pull request's description.", "example": "This is a test pull request." }, "createdBy": { "type": "string", "description": "The ID of the user who created the pull request.", "example": "12345678" }, "updatedBy": { "type": "string", "description": "The ID of the user who last updated the pull request.", "example": "12345678" }, "comment": { "type": "string", "description": "If the pull request is a `decline` status, an optoinal comment about why the pull request was declined.", "example": "Missing descriptions in requests" }, "fortkType": { "type": "string", "description": "The type of element the pull request was forked from.", "example": "collection" }, "source": { "type": "object", "description": "Information about the pull request's source (parent) element.", "properties": { "id": { "type": "string", "description": "The pull request's source ID.", "example": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef" }, "name": { "type": "string", "description": "The source element's name.", "example": "test-collection" }, "forkName": { "type": "string", "description": "The name of the fork created from the source element.", "example": "Taylor Lee's fork" }, "exists": { "type": "boolean", "description": "If true, whether the element is present and not deleted.", "example": true } } }, "destination": { "description": "Information about the pull request destination element.", "type": "object", "properties": { "id": { "type": "string", "description": "The destination element's ID.", "example": "123456789-24f57217-1169-4b7c-a810-0e957c04eaa5" }, "name": { "type": "string", "description": "The destination element's name.", "example": "test-collection" }, "exists": { "type": "boolean", "description": "If true, whether the element is present and not deleted.", "example": true } } }, "status": { "type": "string", "description": "The pull request's current review status:\n- `open` \u2014 The pull request is still open.\n- `approved` \u2014 The pull request was approved by its reviewers.\n- `declined` \u2014 The pull request was not approved by its reviewers.\n", "example": "declined" }, "merge": { "type": "object", "description": "Information about the current progress of the pull request's merge.", "properties": { "status": { "type": "string", "description": "The pull request's current merge status:\n- `inactive` \u2014 There is no merge in progress.\n- `inprogress` \u2014 The pull request is currently merging.\n- `failed` \u2014 The pull request's merge failed.\n", "enum": [ "inactive", "inprogress", "failed" ], "example": "inactive" } } }, "reviewers": { "type": "array", "description": "Information about the reviewers assigned to the pull request.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The reviewer's user ID.", "example": "12345678" }, "status": { "type": "string", "description": "The reviewer's review status response. One of:\n- `approved`\n- `declined`\n", "example": "declined" } } } } } }