deploy.observed

{
  "type": "object",
  "additionalProperties": false,
  "description": "No input.",
  "title": "Empty"
}

{
  "type": "object",
  "properties": {
    "observed": {
      "type": "boolean",
      "description": "Whether this checkout holds an observation at all."
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Why not, and what to run, when it holds none or cannot read it."
    },
    "repository": {
      "type": [
        "string",
        "null"
      ],
      "description": "`owner/name`, when observed."
    },
    "repository_url": {
      "type": [
        "string",
        "null"
      ],
      "description": "The repository's address on the forge, when observed."
    },
    "observed_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the forge was asked, when observed."
    },
    "environments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/EnvironmentSummary"
      },
      "description": "Every environment something was deployed to, by name."
    },
    "deployments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ObservedDeployment"
      },
      "description": "The observed deployments, newest first."
    },
    "releases": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ObservedRelease"
      },
      "description": "The observed releases, newest first."
    }
  },
  "required": [
    "observed",
    "environments",
    "deployments",
    "releases"
  ],
  "description": "`deploy.observed`: what was deployed where, or that nothing has been observed here.",
  "title": "ObservedDeployments",
  "$defs": {
    "EnvironmentSummary": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The environment."
        },
        "deployments": {
          "type": "integer",
          "format": "uint",
          "minimum": 0,
          "description": "How many of the observed deployments went to it."
        },
        "state": {
          "type": "string",
          "description": "The state of its newest deployment."
        },
        "sha": {
          "type": "string",
          "description": "The commit its newest deployment put there."
        },
        "deployed_at": {
          "type": "string",
          "description": "When that was."
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Where it is served, when its newest deployment says."
        },
        "activity_url": {
          "type": "string",
          "description": "The environment's activity on the forge."
        }
      },
      "required": [
        "name",
        "deployments",
        "state",
        "sha",
        "deployed_at",
        "activity_url"
      ],
      "description": "One environment, as its deployments describe it."
    },
    "ObservedDeployment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The forge's identity of the deployment."
        },
        "environment": {
          "type": "string",
          "description": "The environment it went to, in the forge's words (`github-pages`, `production`, ...)."
        },
        "sha": {
          "type": "string",
          "description": "The commit that was deployed."
        },
        "git_ref": {
          "type": [
            "string",
            "null"
          ],
          "description": "The ref it was deployed from, when the forge still names one."
        },
        "created_at": {
          "type": "string",
          "description": "When it was created, RFC 3339."
        },
        "creator": {
          "type": [
            "string",
            "null"
          ],
          "description": "Who or what created it."
        },
        "state": {
          "type": "string",
          "description": "How it ended, lower case as the forge states it (`success`, `failure`, `in_progress`,\n...); `unknown` when the forge reported no status at all."
        },
        "environment_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Where the environment is served, when the deployment says."
        },
        "log_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "The run that performed it, when the deployment says."
        }
      },
      "required": [
        "id",
        "environment",
        "sha",
        "created_at",
        "state"
      ],
      "description": "One deployment the forge recorded."
    },
    "ObservedRelease": {
      "type": "object",
      "properties": {
        "tag": {
          "type": "string",
          "description": "The tag."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The release's title, when it has one."
        },
        "published_at": {
          "type": [
            "string",
            "null"
          ],
          "description": "When it was published; absent for a draft."
        },
        "url": {
          "type": "string",
          "description": "Its page on the forge."
        },
        "prerelease": {
          "type": "boolean",
          "description": "Whether the forge marks it a pre-release."
        },
        "draft": {
          "type": "boolean",
          "description": "Whether it is still a draft."
        }
      },
      "required": [
        "tag",
        "url",
        "prerelease",
        "draft"
      ],
      "description": "One release the forge published."
    }
  }
}