openapi changes
This commit is contained in:
parent
4e15e642ce
commit
51a2ee81bc
164
openapi.yaml
164
openapi.yaml
@ -1,4 +1,4 @@
|
||||
openapi: 3.0.0
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
title: StrafesNET Maps - OpenAPI 3.0
|
||||
description: Browse and manage maps.
|
||||
@ -6,17 +6,15 @@ info:
|
||||
servers:
|
||||
- url: https://maps.strafes.net/v1
|
||||
tags:
|
||||
- name: Times
|
||||
description: Retrieve player times
|
||||
- name: User
|
||||
description: User operations
|
||||
- name: Maps
|
||||
description: Map operations
|
||||
paths:
|
||||
/times:
|
||||
/maps:
|
||||
get:
|
||||
summary: Get list of times
|
||||
operationId: listTimes
|
||||
summary: Get list of maps
|
||||
operationId: listMaps
|
||||
tags:
|
||||
- Times
|
||||
- Maps
|
||||
parameters:
|
||||
- name: page
|
||||
in: query
|
||||
@ -27,7 +25,7 @@ paths:
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
$ref: "#/components/schemas/TimeFilter"
|
||||
$ref: "#/components/schemas/MapFilter"
|
||||
responses:
|
||||
"200":
|
||||
description: Successful response
|
||||
@ -36,21 +34,21 @@ paths:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Time"
|
||||
$ref: "#/components/schemas/Map"
|
||||
default:
|
||||
description: General Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Error"
|
||||
/users/{UserID}:
|
||||
/maps/{MapID}:
|
||||
get:
|
||||
summary: Retrieve user with ID
|
||||
operationId: getUser
|
||||
summary: Retrieve map with ID
|
||||
operationId: getMap
|
||||
tags:
|
||||
- User
|
||||
- Maps
|
||||
parameters:
|
||||
- name: UserID
|
||||
- name: MapID
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
@ -62,51 +60,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
default:
|
||||
description: General Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Error"
|
||||
/users/{UserID}/rank:
|
||||
get:
|
||||
summary: Retrieve rank of user
|
||||
operationId: getUserRank
|
||||
tags:
|
||||
- User
|
||||
parameters:
|
||||
- name: UserID
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
- name: StyleID
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
- name: GameID
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
- name: ModeID
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
responses:
|
||||
"200":
|
||||
description: Successful response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Rank"
|
||||
$ref: "#/components/schemas/Map"
|
||||
default:
|
||||
description: General Error
|
||||
content:
|
||||
@ -142,96 +96,22 @@ components:
|
||||
Date:
|
||||
type: integer
|
||||
format: int64
|
||||
Time:
|
||||
MapFilter:
|
||||
type: object
|
||||
properties:
|
||||
ID:
|
||||
type: integer
|
||||
format: int64
|
||||
Time:
|
||||
DisplayName:
|
||||
type: string
|
||||
Creator:
|
||||
type: string
|
||||
GameID:
|
||||
type: integer
|
||||
format: int64
|
||||
User:
|
||||
$ref: "#/components/schemas/User"
|
||||
Map:
|
||||
$ref: "#/components/schemas/Map"
|
||||
format: int32
|
||||
Date:
|
||||
type: integer
|
||||
format: int64
|
||||
StyleID:
|
||||
type: integer
|
||||
format: int32
|
||||
ModeID:
|
||||
type: integer
|
||||
format: int32
|
||||
GameID:
|
||||
type: integer
|
||||
format: int32
|
||||
TimeFilter:
|
||||
type: object
|
||||
properties:
|
||||
ID:
|
||||
type: integer
|
||||
format: int64
|
||||
Time:
|
||||
type: integer
|
||||
format: int64
|
||||
UserID:
|
||||
type: integer
|
||||
format: int64
|
||||
MapID:
|
||||
type: integer
|
||||
format: int64
|
||||
StyleID:
|
||||
type: integer
|
||||
format: int32
|
||||
ModeID:
|
||||
type: integer
|
||||
format: int32
|
||||
GameID:
|
||||
type: integer
|
||||
format: int32
|
||||
Rank:
|
||||
type: object
|
||||
properties:
|
||||
ID:
|
||||
type: integer
|
||||
format: int64
|
||||
User:
|
||||
$ref: "#/components/schemas/User"
|
||||
StyleID:
|
||||
type: integer
|
||||
format: int32
|
||||
ModeID:
|
||||
type: integer
|
||||
format: int32
|
||||
GameID:
|
||||
type: integer
|
||||
format: int32
|
||||
Rank:
|
||||
type: number
|
||||
format: double
|
||||
Skill:
|
||||
type: number
|
||||
format: double
|
||||
UpdatedAt:
|
||||
type: integer
|
||||
format: int64
|
||||
RankFilter:
|
||||
type: object
|
||||
properties:
|
||||
StyleID:
|
||||
type: integer
|
||||
format: int32
|
||||
GameID:
|
||||
type: integer
|
||||
format: int32
|
||||
ModeID:
|
||||
type: integer
|
||||
format: int32
|
||||
Sort:
|
||||
type: integer
|
||||
format: int64
|
||||
Pagination:
|
||||
type: object
|
||||
required:
|
||||
|
Loading…
Reference in New Issue
Block a user