Updated Pull Request Payload

APIs.ioEngineeringPlatform

Properties

Name Type Description
createdAt string The date and time at which the pull request was created.
createdBy string The ID of the user who created the pull request.
description string The pull request's description.
destinationId string The pull request's merge destination ID.
forkType string The type of forked element.
id string The pull request's ID.
sourceId string The unique ID of the source element.
status string The pull request's status.
title string The pull request's title.
updatedAt string The date and time at which the pull request was updated.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pullrequestupdated-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pullRequestUpdated",
  "title": "Updated 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:58:57.000Z"
    },
    "createdBy": {
      "type": "string",
      "description": "The ID of the user who created the pull request.",
      "example": "12345678"
    },
    "description": {
      "type": "string",
      "description": "The pull request's description.",
      "example": "Updated description of the pull request."
    },
    "destinationId": {
      "type": "string",
      "description": "The pull request's merge destination ID.",
      "example": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
    },
    "forkType": {
      "type": "string",
      "description": "The type of forked element.",
      "example": "collection"
    },
    "id": {
      "type": "string",
      "description": "The pull request's ID.",
      "example": "4e1a6609-1a29-4037-a411-89ecc14c6cd8"
    },
    "sourceId": {
      "type": "string",
      "description": "The unique ID of the source element.",
      "example": "87654321-3b79068c-dbe5-41d5-a826-51be4bf646ef"
    },
    "status": {
      "type": "string",
      "description": "The pull request's status.",
      "enum": [
        "open",
        "approved",
        "declined",
        "merged"
      ],
      "example": "open"
    },
    "title": {
      "type": "string",
      "description": "The pull request's title.",
      "example": "Updated PR title"
    },
    "updatedAt": {
      "type": "string",
      "description": "The date and time at which the pull request was updated.",
      "example": "2024-02-20T09:58:57.000Z"
    }
  }
}