add openapi specification for http server

This commit is contained in:
Lion Kortlepel
2022-05-23 18:00:45 +02:00
parent 62c300f285
commit 18b4c698fc
2 changed files with 36 additions and 1 deletions

29
openapi.yml Normal file
View File

@@ -0,0 +1,29 @@
openapi: "3.0.2"
info:
title: API Title
version: "1.0"
servers:
- url: https://localhost:8000/v1
paths:
/health:
get:
responses:
"200":
description: OK
content:
"application/json":
schema:
type: object
properties:
healthy:
type: boolean
good:
type: array
items:
type: string
example: "Heartbeat"
bad:
type: array
items:
type: string
example: "ResourceManager"