mirror of
https://github.com/BeamMP/BeamMP-Server.git
synced 2026-04-08 16:56:08 +00:00
add openapi specification for http server
This commit is contained in:
29
openapi.yml
Normal file
29
openapi.yml
Normal 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"
|
||||
Reference in New Issue
Block a user