source: TFP-WebServer/WebServer/src/WebAPI/APIs/WorldState/Bloodmoon.openapi.yaml@ 494

Last change on this file since 494 was 463, checked in by alloc, 15 months ago

21.1.16.0 release
Completed OpenAPI specs
Add support to path handlers to register OpenAPI specs
Fixed ItemIconHandler throwing error when requested path contains no dot
File size: 1.7 KB
Line 
1openapi: 3.1.0
2info:
3 title: Bloodmoon
4 version: '1'
5
6components:
7 schemas:
8 BloodmoonObject:
9 type: object
10 properties:
11 gameTime:
12 $ref: './openapi.yaml#/components/schemas/TypeGameTimeObject'
13 description: Current in-game time
14 bloodmoonActive:
15 type: boolean
16 description: A bloodmoon is currently happening
17 nextBloodmoon:
18 $ref: './openapi.yaml#/components/schemas/TypeGameTimeObject'
19 description: In-game time of start of next bloodmoon or the currently running one
20 nextBloodmoonEnd:
21 $ref: './openapi.yaml#/components/schemas/TypeGameTimeObject'
22 description: In-game time of the end of the next bloodmoon - or end of the current one if running
23 required:
24 - gameTime
25 - bloodmoonActive
26 - nextBloodmoon
27 - nextBloodmoonEnd
28
29
30paths:
31 /api/bloodmoon:
32 get:
33 tags:
34 - WorldState
35 summary: Bloodmoon
36 description: Get info on the bloodmoon
37 operationId: Bloodmoon.get
38 responses:
39 200:
40 description: Bloodmoon info
41 content:
42 application/json:
43 schema:
44 type: object
45 properties:
46 data:
47 $ref: '#/components/schemas/BloodmoonObject'
48 meta:
49 $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
50 required:
51 - data
52 - meta
53 403:
54 $ref: './openapi.yaml#/components/responses/Unauthorized'
55 security:
56 - apiTokenName: [ ]
57 apiTokenSecret: [ ]
58 - sessionCookie: [ ]
Note: See TracBrowser for help on using the repository browser.