recipes/openapi.yaml at trunk · wilsncc/recipes · GitHub

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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
openapi: 3.0.1
info:
  description: This project provides a RESTful web service for managing recipies.
  title: recipes
  version: '1.0-SNAPSHOT'
externalDocs:
  url: https://github.com/rossdotpink/recipes
  description: Project home
servers:
  - url: http://127.0.0.1:8080
paths:
  /recipes/recipe:
    get:
      operationId: getRecipes
      description: Returns all recipes. Paginated; returns page 1 with 10 results by default.
      parameters:
        - name: pageNumber
          in: query
          schema:
            type: integer
            format: int32
            default: 1
          description: Page number for results pagination
        - name: pageSize
          in: query
          schema:
            type: integer
            format: int32
          description: Page size for results pagination
      responses:
        200:
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Recipe'
        500:
          description: internal server error
    post:
      operationId: createRecipe
      description: Adds a new recipe. Request body must not include an 'id' field, unlike the normal Request schema. JPA will autogenerate an ID for us.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeWithoutId'
      responses:
        200:
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipe'
        404:
          description: not found error
        500:
          description: internal server error
  /recipes/recipe/{id}:
    get:
      operationId: getRecipe
      description: Returns the recipe with the given ID.
      parameters:
        - name: id
          description: ID of the recipe to be returned
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        200:
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipe'
        404:
          description: not found error
        500:
          description: internal server error
    delete:
      operationId: delete
      description: Deletes the recipe with the given ID.
      parameters:
        - name: id
          description: ID of the recipe to be deleted
          in: path
          required: true
          schema:
            type: integer
            format: int32
      responses:
        200:
          description: successful response
        404:
          description: not found error
        500:
          description: internal server error
    patch:
      operationId: patch
      description: Updates the recipe with the given ID.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int32
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/Recipe'
      responses:
        200:
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Recipe'
        404:
          description: not found error
        410:
          description: invalid patch request
        500:
          description: internal server error

  /recipes/search/recipes:
    post:
      operationId: searchRecipe
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecipeSearch'
      responses:
        200:
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Recipe'
        500:
          description: internal server error
components:
  schemas:
    Recipe:
      required:
        - name
        - serves
        - tags
        - ingredients
        - instructions
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        serves:
          type: integer
          format: int32
        tags:
          type: array
          items:
            type: string
        ingredients:
          type: array
          items:
            type: string
        instructions:
          type: string
    RecipeWithoutId:
      required:
        - name
        - serves
        - tags
        - ingredients
        - instructions
      type: object
      properties:
        name:
          type: string
        serves:
          type: integer
          format: int32
        tags:
          type: array
          items:
            type: string
        ingredients:
          type: array
          items:
            type: string
        instructions:
          type: string
    RecipeSearch:
      type: object
      description: This resource represents a search of the stored recipies.
      properties:
        name:
          type: string
        serves:
          type: integer
          format: int32
        tags:
          type: array
          items:
            type: string
        notTags:
          type: array
          items:
            type: string
        ingredients:
          type: array
          items:
            type: string
        notIngredients:
          type: array
          items:
            type: string
        instructions:
          type: string