Add openapi/github.json for demo purposes

Signed-off-by: René Jochum <rene@webmeisterei.com>
master
René Jochum 4 years ago
parent 9f84a0e60e
commit dc9d508a90

@ -0,0 +1 @@
{"openapi":"3.0.1","info":{"title":"LQL API","description":"This is the LQL API for your check_mk Server.\n\nAll v1/ endpoints require http basic auth","version":"unset"},"paths":{"/v1/ping":{"get":{"tags":["v1"],"summary":"Play ping-ping with the API","operationId":"v1Ping","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}},"400":{"description":"Bad Request"}}}},"/v1/raw":{"post":{"tags":["v1"],"summary":"GET RAW LQL Data or execute a COMMAND","operationId":"v1RawPost","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"},"description":"Columns to query, you should always provide this"},"command":{"type":"string","description":"The command, required if method is COMMAND"},"limit":{"type":"integer","description":"Limit result count","format":"int32"},"method":{"type":"string","description":"Either GET or COMMAND"},"query":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"raw query Data"},"table":{"type":"string","description":"The table to query, required if method is GET"}},"required":["method"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"400":{"description":"Bad Request"}}}},"/v1/stats/tactical_overview":{"get":{"tags":["v1"],"summary":"GET tactical overview data","operationId":"v1StatsGetTacticalOverview","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LqlV1StatsTacticalOverview"}}}},"400":{"description":"Bad Request"}}}},"/v1/table/{name}":{"get":{"tags":["v1"],"summary":"GET a table from LQL","operationId":"v1TableGet","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}},{"name":"column","in":"query","description":"Columns to return","schema":{"type":"array","items":{"type":"string"},"description":"Columns to return"}},{"name":"filter","in":"query","description":"Filter to apply on the table","schema":{"type":"array","items":{"type":"string"},"description":"Filter to apply on the table"}},{"name":"limit","in":"query","description":"Limit number of results","schema":{"type":"number","description":"Limit number of results","format":"double","nullable":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"400":{"description":"Bad Request"}}}},"/v1/table/{name}/columns":{"get":{"tags":["v1"],"summary":"GET a table columns from LQL","operationId":"v1TableGetColumns","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad Request"}}}}},"components":{"schemas":{"LqlV1StatsTacticalOverview":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/LqlV1StatsTacticalOverviewEntry"},"hosts":{"$ref":"#/components/schemas/LqlV1StatsTacticalOverviewEntry"},"services":{"$ref":"#/components/schemas/LqlV1StatsTacticalOverviewEntry"}},"required":["events","hosts","services"]},"LqlV1StatsTacticalOverviewEntry":{"type":"object","properties":{"all":{"type":"number","description":"all services/hosts","format":"double"},"problems":{"type":"number","description":"Num of problems","format":"double"},"stale":{"type":"number","description":"Num of stale","format":"double"},"unhandled":{"type":"number","description":"Num of unhandled","format":"double"}},"description":"Event stats","required":["all"]}}},"tags":[{"name":"v1","description":"LQL API v1"}]}
Loading…
Cancel
Save