add /player/{name}/ draft

This commit is contained in:
Lion Kortlepel committed 2022-05-23 23:17:17 +02:00
1 parent 5598d75fd5
commit b0021d42b5
1 file changed
+40 -4
+40 -4
View File
@@ -1,18 +1,55 @@
openapi: "3.0.2" openapi: "3.0.2"
info: info:
title: BeamMP-Server title: BeamMP-Server
version: "1.0" version: "api-v1"
description: | description: |
The BeamMP-Server optionally runs an HTTP server The BeamMP-Server optionally runs an HTTP server
which can be used to query information about the server's which can be used to query information about the server's
status, health, players, etc. status, health, players, etc.
servers: servers:
- url: http://localhost:{port}/v1 - url: http://localhost:{port}/api/v1
description: local BeamMP-Server description: BeamMP-Server API v1
variables: variables:
port: port:
default: "8000" default: "8000"
paths: paths:
/player/{name}/vehicles:
parameters:
- name: "name"
in: path
required: true
schema:
type: string
example: "LionKor"
get:
summary: vehicles this player has spawend
responses:
"200":
description: OK
content:
"application/json":
schema:
type: array
items:
type: object
properties:
jbm:
type: string
example: "bolide"
/version:
get:
summary: server version
description: |
Server version in 'major.minor.patch' semver format
responses:
"200":
description: OK
content:
"text/plain":
schema:
type: string
example: "3.1.0"
/players: /players:
get: get:
summary: list of players on this server summary: list of players on this server
@@ -73,7 +110,6 @@ paths:
"text/plain": "text/plain":
schema: schema:
type: boolean type: boolean
/health: /health:
get: get:
summary: health of the server's systems summary: health of the server's systems