Pending Deployment

Details of a deployment that is waiting for protection rules to pass

APIs.ioEngineeringPlatform

Properties

Name Type Description
environment object
wait_timer integer The set duration of the wait timer
wait_timer_started_at string The time that the wait timer began.
current_user_can_approve boolean Whether the currently authenticated user can approve the deployment
reviewers array The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one o
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-pending-deployment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pending-deployment",
  "title": "Pending Deployment",
  "description": "Details of a deployment that is waiting for protection rules to pass",
  "type": "object",
  "properties": {
    "environment": {
      "type": "object",
      "properties": {
        "id": {
          "description": "The id of the environment.",
          "type": "integer",
          "format": "int64",
          "example": 56780428
        },
        "node_id": {
          "type": "string",
          "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
        },
        "name": {
          "description": "The name of the environment.",
          "example": "staging",
          "type": "string"
        },
        "url": {
          "type": "string",
          "example": "https://api.github.com/repos/github/hello-world/environments/staging"
        },
        "html_url": {
          "type": "string",
          "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
        }
      }
    },
    "wait_timer": {
      "type": "integer",
      "description": "The set duration of the wait timer",
      "example": 30
    },
    "wait_timer_started_at": {
      "description": "The time that the wait timer began.",
      "example": "2020-11-23T22:00:40Z",
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "current_user_can_approve": {
      "description": "Whether the currently authenticated user can approve the deployment",
      "type": "boolean",
      "example": true
    },
    "reviewers": {
      "type": "array",
      "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/deployment-reviewer-type"
          },
          "reviewer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/simple-user"
              },
              {
                "$ref": "#/components/schemas/team"
              }
            ]
          }
        }
      }
    }
  },
  "required": [
    "environment",
    "wait_timer",
    "wait_timer_started_at",
    "current_user_can_approve",
    "reviewers"
  ]
}