github-webhook-dispatcher/openapi.yaml at main · collinmcneese/github-webhook-dispatcher · 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
openapi: 3.0.0
info:
  title: GitHub Webhook Dispatcher API
  version: 1.3.1
  description: An API for routing incoming GitHub webhook events to downstream services
paths:
  /:
    post:
      summary: Handle incoming GitHub webhook events
      requestBody:
        description: The payload of the incoming webhook event
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  description: The action that triggered the webhook event
                repository:
                  type: object
                  description: The repository that the webhook event is associated with
                  properties:
                    owner:
                      type: object
                      properties:
                        login:
                          type: string
                          description: The username of the repository owner or the organization name
                    name:
                      type: string
                      description: The name of the repository
                sender:
                  type: object
                  description: The user that triggered the webhook event
                  properties:
                    login:
                      type: string
                      description: The username of the user
      responses:
        '200':
          description: The webhook event was successfully processed
        '400':
          description: The webhook event was invalid or could not be processed
  /routes:
    get:
      summary: Get a list of all configured routes
      parameters:
        - name: format
          in: query
          description: The format of the response. Valid values are "json" and "text". Defaults to "text" if not specified.
          schema:
            type: string
            enum: [json, text]
            default: text
      responses:
        '200':
          description: A list of all configured routes
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    owner:
                      type: string
                      description: The username of the repository owner or the organization name
                    name:
                      type: string
                      description: The name of the repository
  /health:
    post:
      summary: Check the health of the API
      responses:
        '200':
          description: The API is alive
  /dummy1:
    post:
      summary: A dummy route for testing purposes
      responses:
        '200':
          description: The route is working
  /dummy2:
    post:
      summary: Another dummy route for testing purposes
      responses:
        '200':
          description: The route is working