source: TFP-WebServer/WebServer/src/WebAPI/APIs/OpenAPI.openapi.yaml@ 474

Last change on this file since 474 was 460, checked in by alloc, 16 months ago

More OpenAPI specs added
OpenAPI specs cleanup to have everything validate fine
Added CORS support to API endpoints

File size: 1.1 KB
RevLine 
[459]1openapi: 3.1.0
2info:
3 title: OpenAPI
[460]4 version: '1'
[459]5
6
7paths:
8 /api/OpenAPI/openapi.yaml:
9 get:
[460]10 tags:
11 - Meta
12 summary: OpenAPI master document
13 description: Fetch the OpenAPI master document, referencing all the individual WebAPI specs
[459]14 operationId: OpenAPI.openapi
15 responses:
16 200:
17 content:
18 application/json: {}
19 description: OpenAPI master document
[460]20 /api/OpenAPI/{name}.openapi.yaml:
21 get:
[459]22 tags:
23 - Meta
[460]24 summary: OpenAPI spec for single API
25 description: Fetch the OpenAPI spec of a single WebAPI
[459]26 operationId: OpenAPI.getAPI
27 parameters:
28 - in: path
29 name: name
30 required: true
31 schema:
32 pattern: '[^\/#\?]+?'
33 type: string
34 responses:
35 200:
36 content:
37 application/json: {}
38 description: OpenAPI spec for API
39 404:
40 content:
41 application/json: {}
42 description: No OpenAPI spec found for the API name
Note: See TracBrowser for help on using the repository browser.