/
openapi.yaml
39 lines (38 loc) · 1.45 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
openapi: 3.0.1
info:
title: Plugin title
description: Description what can the plugin do
version: 'v1'
servers:
- url: https://7e7e-87-154-223-246.eu.ngrok.io # change this
paths:
/hi:
get: # max 200 characters for each API endpoint description/summary field and each API param description field in API specification
operationId: getHiEndpoint # use a meaningful name and include prompt-related keyword
summary: How to say hi in different lagnauges lilke thai, chinese, english, arabic, hebrew # include keywords for the prompt as much as possible
responses:
'200':
description: Successful action
content:
application/json:
schema:
type: object
properties: # json object schema here
message:
type: string
example: 'This is an example text'
/pi:
get:
operationId: getPiEndpoint # use a meaningful name and include prompt-related keyword
summary: Shows the first digits of the Pi constant # include keywords for the prompt as much as possible
responses:
'200':
description: Successful action
content:
application/json:
schema:
type: object
properties: # json object schema here
message:
type: string
example: 'This is another example text'