-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
91 lines (86 loc) · 1.94 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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
openapi: "3.0.0"
info:
version: 1.0.0
title: Best Type of Coffee API
license:
name: MIT
servers:
- url: http://localhost:3000
paths:
/v1/best-coffees:
get:
summary: Get the right type of coffee
operationId: getBestTypeCoffee
tags:
- Coffee
parameters:
- name: characteristics
in: query
description: Characteristics to build your best type of coffee, up to 3 selected characteristics.
required: true
schema:
type: array
items:
$ref: "#/components/schemas/Characteristic"
responses:
'200':
description: The best coffee options
content:
application/json:
schema:
$ref: "#/components/schemas/BestCoffees"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
BestCoffees:
type: object
required:
- characteristics
- chat_gpt
properties:
characteristics:
type: array
items:
$ref: "#/components/schemas/Characteristic"
chat_gpt:
type: array
items:
$ref: "#/components/schemas/Option"
database:
type: array
items:
$ref: "#/components/schemas/Option"
Option:
type: object
required:
- message
properties:
message:
type: string
details:
type: object
Characteristic:
type: string
enum:
- acidity
- aftertaste
- aroma
- body
- flavor
- sweetness
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string