bookstore-example/openapi.yml at a44fc86b89289a7f016e903127fb2918e1d3da2f · opticdev/bookstore-example · 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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
openapi: 3.1.3
x-optic-url: https://app.useoptic.com/organizations/32613bcd-704e-4661-85f0-7b3d75613fb0/apis/NHZgBHDASGWtM3JjjE0m5
info:
  title: Optic Bookstore Demo Spec
  description: A demo specification for Optic
  contact:
    email: support@useoptic.com
  version: 1.0.0
servers:
  - url: https://bookstore.optic.dev
paths:
  /books:
    get:
      summary: Get a list of books
      parameters:
        - schema:
            type: string
          in: query
          description: ID of book to fetch after
          name: after_id
          required: false
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          description: Order to sort books by, defaults to asc
          name: sort_order
          required: false
        - schema:
            type: string
            enum:
              - created_at
              - name
          in: query
          description: Book key to sort by, defaults to name
          name: sort_key
          required: false
      responses:
        "200":
          description: Book success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: "#/components/schemas/BookResponse"
                  next:
                    type:
                      - string
                      - "null"
                    description: after_id for next page
                  has_more_data:
                    type: boolean
                required:
                  - data
                  - next
                  - has_more_data
    post:
      summary: Create a book
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BookRequest"
      responses:
        "201":
          description: Successfully created book
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                required:
                  - id
  /books/{book_id}:
    get:
      summary: Get a book
      parameters:
        - $ref: "#/components/parameters/BookId"
      responses:
        "200":
          description: Book success response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BookResponse"
    patch:
      summary: Update a book
      parameters:
        - $ref: "#/components/parameters/BookId"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                author_id:
                  type: string
      responses:
        "204":
          description: Successfully updated book
  /author:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AuthorRequest"
      responses:
        "201":
          description: Successfully created author
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                required:
                  - id
  /author/{author_id}:
    get:
      parameters:
        - $ref: "#/components/parameters/AuthorId"
      responses:
        "200":
          description: Successful response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AuthorResponse"
    patch:
      parameters:
        - $ref: "#/components/parameters/AuthorId"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        "204":
          description: Successfully updated author

components:
  parameters:
    BookId:
      schema:
        type: string
      in: path
      description: ID of book
      name: book_id
      required: true
    AuthorId:
      schema:
        type: string
      in: path
      description: ID of author
      name: author_id
      required: true
  schemas:
    AuthorRequest:
      type: object
      properties:
        name:
          type: string
      required:
        - name
    AuthorResponse:
      type: object
      properties:
        id:
          type: string
          example: FrCmluBlTSwwxLLEbEDCP
        name:
          type: string
          example: Jane Austen
        created_at:
          type: string
          format: timestamp
          example: 2023-02-18T14:29:26.384Z
        updated_at:
          type: string
          format: timestamp
          example: 2023-03-18T14:29:26.384Z
      required:
        - id
        - name
        - created_at
        - updated_at
    BookRequest:
      type: object
      properties:
        name:
          type: string
        author_id:
          type: string
        type:
          type: string
          enum:
            - fiction
            - non-fiction
      required:
        - name
        - author_id
        - type
    BookResponse:
      type: object
      properties:
        id:
          type: string
          example: BEfCDC5FHWelCADHR9Rcm
        name:
          type: string
          example: Pride and Prejudice
        author_id:
          type: string
          example: FrCmluBlTSwwxLLEbEDCP
        created_at:
          type: string
          format: timestamp
          example: 2023-05-18T14:29:26.384Z
        updated_at:
          type: string
          format: timestamp
          example: 2023-05-18T14:29:26.384Z
      required:
        - id
        - name
        - author_id
        - created_at
        - updated_at