skim api and fill in some blanks
This commit is contained in:
parent
6ffb613a08
commit
14c8cabb44
45
openapi.yaml
45
openapi.yaml
@ -1,11 +1,10 @@
|
|||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: StrafesNET - OpenAPI 3.0
|
title: StrafesNET Maps - OpenAPI 3.0
|
||||||
description: |-
|
description: Browse and manage maps.
|
||||||
TBD
|
|
||||||
version: 0.1.0
|
version: 0.1.0
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.strafes.net/v2
|
- url: https://maps.strafes.net/v1
|
||||||
tags:
|
tags:
|
||||||
- name: Times
|
- name: Times
|
||||||
description: Retrieve player times
|
description: Retrieve player times
|
||||||
@ -114,38 +113,6 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/Error"
|
$ref: "#/components/schemas/Error"
|
||||||
/ranks:
|
|
||||||
get:
|
|
||||||
summary: Get list of ranks
|
|
||||||
operationId: listRanks
|
|
||||||
tags:
|
|
||||||
- User
|
|
||||||
parameters:
|
|
||||||
- name: page
|
|
||||||
in: query
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/Pagination"
|
|
||||||
- name: filter
|
|
||||||
in: query
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/RankFilter"
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: Successful response
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: "#/components/schemas/Rank"
|
|
||||||
default:
|
|
||||||
description: General Error
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/Error"
|
|
||||||
components:
|
components:
|
||||||
schemas:
|
schemas:
|
||||||
User:
|
User:
|
||||||
@ -177,7 +144,7 @@ components:
|
|||||||
format: int64
|
format: int64
|
||||||
Time:
|
Time:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
ID:
|
ID:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
@ -226,7 +193,7 @@ components:
|
|||||||
format: int32
|
format: int32
|
||||||
Rank:
|
Rank:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
ID:
|
ID:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
@ -291,4 +258,4 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
required:
|
required:
|
||||||
- code
|
- code
|
||||||
- message
|
- message
|
||||||
|
Loading…
Reference in New Issue
Block a user