add query params negation in documentation

This commit is contained in:
2023-04-21 10:15:52 +02:00
parent 99085c9863
commit ab1f3b90ba
2 changed files with 36 additions and 29 deletions
+11 -10
View File
File diff suppressed because one or more lines are too long
+25 -19
View File
@@ -8,7 +8,10 @@ info:
license: license:
name: The Unlicense name: The Unlicense
url: 'https://unlicense.org/' url: 'https://unlicense.org/'
description: 'Stats tracking API for Titanfall 2 Northstar ' description: |-
Stats tracking API for Titanfall 2 Northstar
All query params can be negated using `!`. Example : (`https://tone.sleepycat.date/v2/client/gamemodes?gamemode=!sns`)
tags: tags:
- name: client - name: client
description: Routes accessibles by everyone description: Routes accessibles by everyone
@@ -19,7 +22,7 @@ servers:
paths: paths:
/client/hosts: /client/hosts:
get: get:
summary: List of hosts summary: Your GET endpoint
tags: tags:
- client - client
responses: responses:
@@ -42,7 +45,7 @@ paths:
description: An object with host ID as keys and host name as values description: An object with host ID as keys and host name as values
/client/servers: /client/servers:
get: get:
summary: Statistics for servers summary: List of servers
tags: tags:
- client - client
responses: responses:
@@ -93,7 +96,7 @@ paths:
parameters: [] parameters: []
/client/weapons: /client/weapons:
get: get:
summary: Statistics for weapons summary: Statistics for all weapons
tags: tags:
- client - client
responses: responses:
@@ -105,7 +108,20 @@ paths:
type: object type: object
properties: properties:
'[string] weapon_id': '[string] weapon_id':
$ref: '#/components/schemas/KillData' type: object
properties:
deaths:
type: integer
description: Number of deaths caused by this weapon
kills:
type: integer
max_distance:
type: integer
total_distance:
type: integer
deaths_while_equipped:
type: integer
description: Number of deaths while this weapon is equipped
examples: examples:
Example 1: Example 1:
value: value:
@@ -134,7 +150,7 @@ paths:
parameters: [] parameters: []
/client/players: /client/players:
get: get:
summary: Statistics for players summary: Statistics for all players
tags: tags:
- client - client
responses: responses:
@@ -178,7 +194,7 @@ paths:
description: A JSON Object with player IDs as keys and player data as values description: A JSON Object with player IDs as keys and player data as values
/client/maps: /client/maps:
get: get:
summary: Statistics for maps summary: Your GET endpoint
tags: tags:
- client - client
responses: responses:
@@ -215,7 +231,7 @@ paths:
description: A JSON Object with map IDs as keys and map data as values description: A JSON Object with map IDs as keys and map data as values
/client/gamemodes: /client/gamemodes:
get: get:
summary: Statistics for gamemodes summary: Your GET endpoint
tags: tags:
- client - client
responses: responses:
@@ -241,16 +257,6 @@ paths:
kills: 12814 kills: 12814
max_distance: 5689 max_distance: 5689
total_distance: 9184028 total_distance: 9184028
sns:
deaths: 20364
kills: 19294
max_distance: 4623
total_distance: 10297366
fw:
deaths: 25
kills: 53
max_distance: 4031
total_distance: 45761
operationId: get-client-gamemodes operationId: get-client-gamemodes
description: A JSON Object with gamemodes IDs as keys and gamemodes data as values description: A JSON Object with gamemodes IDs as keys and gamemodes data as values
parameters: parameters:
@@ -266,7 +272,7 @@ paths:
tags: tags:
- server - server
summary: '' summary: ''
operationId: Check token validity operationId: post-servers-serverId
responses: responses:
'200': '200':
description: OK description: OK