tournamental/docs/api/api.openapi.json at main · 0800tim/tournamental · 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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
{
  "openapi": "3.0.0",
  "info": {
    "title": "VTorn API",
    "description": "Public VTorn API surface. Health, version, and aggregate endpoints. See docs/03-architecture.md for the full system topology.",
    "version": "0.0.1",
    "license": {
      "name": "Apache-2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    }
  },
  "components": {
    "schemas": {}
  },
  "paths": {
    "/": {
      "get": {
        "responses": {
          "200": {
            "description": "Default Response"
          }
        }
      }
    },
    "/health": {
      "get": {
        "summary": "Liveness probe",
        "tags": [
          "health"
        ],
        "description": "Always returns 200 with the current server timestamp. Cache-Control: no-store.",
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status",
                    "ts"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ok"
                      ]
                    },
                    "ts": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/version": {
      "get": {
        "summary": "Service version",
        "tags": [
          "health"
        ],
        "description": "Identifies the running service, package version, spec version, and environment. Cached for 60s.",
        "responses": {
          "200": {
            "description": "Default Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "service",
                    "version",
                    "spec_version",
                    "env",
                    "ts"
                  ],
                  "properties": {
                    "service": {
                      "type": "string"
                    },
                    "version": {
                      "type": "string"
                    },
                    "spec_version": {
                      "type": "string"
                    },
                    "env": {
                      "type": "string"
                    },
                    "ts": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "http://localhost:3310",
      "description": "local dev"
    },
    {
      "url": "https://api.tournamental.com",
      "description": "production"
    }
  ],
  "tags": [
    {
      "name": "health",
      "description": "Liveness + version"
    },
    {
      "name": "social-cards",
      "description": "OG card rendering"
    },
    {
      "name": "admin",
      "description": "Operator-only endpoints"
    }
  ]
}