E-Commerce-Inventory/openapi.yaml at main · vikavl/E-Commerce-Inventory · 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
openapi: 3.0.3
info:
  title: Inventory & Order API
  version: 1.0.0

paths:
  /api/v1/inventory/changes:
    get:
      summary: GET api/v1/inventory/changes
      operationId: getLastStockChanges
      parameters:
        - name: hours
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: minutes
          in: query
          required: true
          schema:
            type: integer
            format: int32
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/InventoryChangeDto"

  /api/v1/products:
    get:
      summary: GET api/v1/products
      operationId: getProducts
      parameters:
        - name: page
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: size
          in: query
          required: true
          schema:
            type: integer
            format: int32
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
            default: id
        - name: ascending
          in: query
          required: false
          schema:
            type: boolean
            default: true
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/ProductDto"

  /api/v1/products/{id}:
    get:
      summary: GET api/v1/products/{id}
      operationId: getProduct
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/ProductDto"

    put:
      summary: PUT api/v1/products/{id}
      operationId: updateProduct
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProductDto"
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: object

  /api/v1/orders:
    post:
      summary: POST api/v1/orders
      operationId: placeOrder
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateOrderRequest"
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                type: object

  /api/v1/orders/{id}:
    get:
      summary: GET api/v1/orders/{id}
      operationId: getOrder
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: OK
          content:
            "*/*":
              schema:
                $ref: "#/components/schemas/OrderDto"

components:
  schemas:
    InventoryChangeDto:
      type: object
      properties:
        id:
          type: string
        productId:
          type: string
        quantityChange:
          type: integer
        timestamp:
          type: string
          format: date-time

    ProductDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        price:
          type: number
          format: double
        stock:
          type: integer

    CreateOrderRequest:
      type: object
      properties:
        productId:
          type: string
        quantity:
          type: integer

    OrderDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
        productId:
          type: string
        quantity:
          type: integer
        status:
          type: string