Status Check Policy

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
strict	boolean
contexts	array
checks	array
contexts_url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/status-check-policy",
  "title": "Status Check Policy",
  "description": "Status Check Policy",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks"
    },
    "strict": {
      "type": "boolean",
      "example": true
    },
    "contexts": {
      "type": "array",
      "example": [
        "continuous-integration/travis-ci"
      ],
      "items": {
        "type": "string"
      }
    },
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "context": {
            "type": "string",
            "example": "continuous-integration/travis-ci"
          },
          "app_id": {
            "type": "integer",
            "nullable": true
          }
        },
        "required": [
          "context",
          "app_id"
        ]
      }
    },
    "contexts_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts"
    }
  },
  "required": [
    "url",
    "contexts_url",
    "strict",
    "contexts",
    "checks"
  ]
}