omni/docs/examples/event-schemas/github/custom.github.push.json at dev · automagik-dev/omni · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "custom.github.push",
  "description": "GitHub push webhook delivery (X-GitHub-Event: push). Minimal-but-real contract: the fields consumers rely on are required; everything else GitHub sends passes through (additionalProperties: true). Evolution rule: revisions must be additive-optional (issue #959).",
  "type": "object",
  "additionalProperties": true,
  "required": ["ref", "repository", "sender"],
  "properties": {
    "ref": {
      "type": "string",
      "description": "Full git ref that was pushed, e.g. refs/heads/main"
    },
    "before": {
      "type": "string",
      "description": "SHA of the most recent commit on ref before the push"
    },
    "after": {
      "type": "string",
      "description": "SHA of the most recent commit on ref after the push"
    },
    "commits": {
      "type": "array",
      "description": "Commits in the push (GitHub caps this at 2048 entries)",
      "items": {
        "type": "object",
        "additionalProperties": true,
        "properties": {
          "id": { "type": "string" },
          "message": { "type": "string" },
          "url": { "type": "string" }
        }
      }
    },
    "repository": {
      "type": "object",
      "additionalProperties": true,
      "required": ["full_name"],
      "properties": {
        "full_name": {
          "type": "string",
          "description": "owner/repo, e.g. automagik-dev/omni"
        }
      }
    },
    "sender": {
      "type": "object",
      "additionalProperties": true,
      "required": ["login"],
      "properties": {
        "login": {
          "type": "string",
          "description": "GitHub username that triggered the delivery"
        }
      }
    }
  }
}