forked from frontendnetwork/Veganify-API
/
OpenAPI.yaml
71 lines (67 loc) · 2.12 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
openapi: 3.0.1
info:
title: VeganCheck API
version: '0.2.0'
description: API for checking if products and ingredients are vegan
contact:
name: VeganCheck Team
email: info@vegancheck.me
url: https://vegancheck.me/
externalDocs:
description: VeganCheck.me API Documentation
url: https://jokenetwork.de/vegancheck-api
servers:
- url: https://api.vegancheck.me/v0
paths:
/product/{barcode}:
post:
summary: Gives out the name of a product, if the product is vegan or not, if the product is vegetarian or not, if the product is animal cruelty free, if the product contains palmoil, the nutriscore of the product and the VeganCheck Grade of the product as well where this data comes from.
parameters:
- in: path
name: barcode
required: true
description: The barcode of the product
schema:
type: string
responses:
'200':
description: OK
'400':
description: Wrong/bad/missing argument
'404':
description: Product not found
'429':
description: Rate limit exceeded
'500':
description: Server error
'504':
description: Database server took to long to respond
/ingredients/{ingredientslist}:
get:
summary: Check if ingredients out of a ingredientslist are vegan
parameters:
- in: path
name: ingredientslist
required: true
description: A comma- and space-separated list of ingredients to check
schema:
type: string
responses:
'200':
description: OK
'400':
description: Missing required parameter
'404':
description: Missing required parameter
'500':
description: Server error
/peta/crueltyfree:
get:
summary: Get a automatically daily-updated list of brands that produce animal cruelty free according to PETA
responses:
'200':
description: OK
'400':
description: Missing required parameter
'500':
description: Server error