-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
117 lines (117 loc) · 2.8 KB
/
swagger.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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
swagger: "2.0"
info:
description: "Sample project using micronaut and api gateway"
version: "1.0.0"
title: "Product Serverless Service"
host: "products.swagger.io"
tags:
- name: "products"
description: "product endpoints"
schemes:
- "https"
- "http"
paths:
/products:
post:
tags:
- "products"
summary: "Add a new products"
description: ""
operationId: "addProduct"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Product object that needs to be added to the store"
required: true
schema:
$ref: "#/definitions/ProductRequest"
/products/{productId}:
get:
tags:
- "products"
summary: "Find product by ID"
description: "Returns a single product"
operationId: "getProductById"
produces:
- "application/json"
parameters:
- name: "productId"
in: "path"
description: "ID of product to return"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/ProductResponse"
put:
tags:
- "products"
summary: "Update existent product by ID"
description: "Update a single product"
operationId: "updateProductById"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "productId"
in: "path"
description: "ID of product to return"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/ProductRequest"
delete:
tags:
- "products"
summary: "Delete product by ID"
description: "Delete a single product"
operationId: "deleteProductById"
produces:
- "application/json"
parameters:
- name: "productId"
in: "path"
description: "ID of product to return"
required: true
type: "string"
responses:
"204":
description: "successful operation"
definitions:
ProductRequest:
type: "object"
properties:
name:
type: "string"
price:
type: "number"
description:
type: "string"
category:
type: "string"
ProductResponse:
type: "object"
properties:
id:
type: "string"
name:
type: "string"
price:
type: "number"
description:
type: "string"
category:
type: "string"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"