charon/contracts/openapi.yaml at dev · ak5/charon · 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
openapi: 3.1.0
info:
  title: Charon runtime probe API
  version: 1.0.0
  description: >
    Liveness and credential-free readiness endpoints. Charon's forward-proxy
    data plane and external reconciler are separate protocols and are not
    represented as REST operations.
paths:
  /healthz:
    get:
      operationId: getLiveness
      summary: Report that the Charon process is serving requests
      responses:
        "204":
          description: Process is live
  /readyz:
    get:
      operationId: getReadiness
      summary: Report realm identity, provider, and receipt-writer readiness
      responses:
        "200":
          description: Configured provider and receipt writer are ready without resolving a secret
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Readiness"
        "503":
          description: Provider or receipt writer is unavailable
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Unavailable"
components:
  schemas:
    RuntimeIdentity:
      type: object
      additionalProperties: false
      required: [status, realm, tenant, persona, generation]
      properties:
        status:
          type: string
        realm:
          type: string
          minLength: 1
          maxLength: 128
        tenant:
          type: string
          minLength: 1
          maxLength: 128
        persona:
          type: string
          minLength: 1
          maxLength: 128
        generation:
          type: integer
          minimum: 1
    Readiness:
      allOf:
        - $ref: "#/components/schemas/RuntimeIdentity"
        - type: object
          properties:
            status:
              const: ready
    Unavailable:
      allOf:
        - $ref: "#/components/schemas/RuntimeIdentity"
        - type: object
          properties:
            status:
              const: unavailable