source: TFP-WebServer/WebServer/src/UrlHandlers/ItemIconHandler.openapi.yaml@ 498

Last change on this file since 498 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.4 KB
RevLine 
[463]1openapi: 3.1.0
2info:
3 title: ItemIconHandler
4 version: '1'
5
6components:
7 parameters:
8 IconNameParameter:
9 name: name
10 in: path
11 required: true
12 schema:
13 type: string
14 description: Name of icon
15
16 IconTintParameter:
17 name: tint
18 in: path
19 required: true
20 schema:
21 type: string
22 pattern: '^[0-9A-Z]{6}$'
23 description: Tint color of icon as 6 hex digits RGB value
24
25
26paths:
27 /BASEPATH/{name}__{tint}.png:
28 get:
29 tags:
30 - Resources
31 summary: ItemIcon get
32 description: Get a specific item icon with the given tint
33 operationId: ItemIconHandler.get.name
34 parameters:
35 - $ref: '#/components/parameters/IconNameParameter'
36 - $ref: '#/components/parameters/IconTintParameter'
37 responses:
38 200:
39 description: Item icon with tint
40 content:
41 image/png:
42 schema:
43 type: string
44 format: binary
45 400:
46 description: Invalid request
47 content:
48 text/plain:
49 schema:
50 type: string
51 const: ''
52 404:
53 description: ItemIcon or tint not found
54 content:
55 text/plain:
56 schema:
57 type: string
58 const: ''
Note: See TracBrowser for help on using the repository browser.