microservices-reference-application/order-openapi-spec.yml at develop · anitechcs/microservices-reference-application · 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
openapi: 3.0.2
info:
  title: OrderService API Specification
  description: 'This API server exposes required endpoints for managing Orders in Microservices reference application.'
  termsOfService: https://www.anitechcs.com/terms-condition/
  contact:
    email: contact@anitechcs.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: v1.0.0
externalDocs:
  description: Find out more about Microservices reference application
  url: https://github.com/anitechcs/microservices-reference-application
servers:
  - url: 'https://mra-bookstore.tk/v1'
    description: Order Service production server
tags:
- name: Order-Service
  description: All order enpoints required for Microservices reference application
components:
  schemas:
    Order:
      type: object
      properties:
        orderId:
          description: Unique order Id in the system
          type: integer
          format: int64
        bookId:
          description: Ordered book id
          type: integer
          format: int64
        quantity:
          type: integer
          format: int32
        shipDate:
          type: string
          format: date-time
        address:
          description: Shipping address of the order
          type: object
          properties:
            firstName:
              description: First name
              type: string
              nullable: false
            lastName:
              description: Last name
              type: string
            addressLine:
              description: Address Line 1
              type: string
            city:
              description: City
              type: string
            zip:
              description: Zip code
              type: integer
              format: int64
            phone:
              description: Phone number
              type: string
            email:
              description: Email address
              type: string
              format: email
        amount:
          description: Total amount paid
          type: number
          format: double
        paymentMethod:
          description: Payment method used
          type: string
          enum:
          - Paypal
          - Credit Card
          - Internet Banking
          - UPI
        status:
          type: string
          description: Order Status
          enum:
          - placed
          - approved
          - shipped
          - delivered
        complete:
          type: boolean
          default: false
    OrderListSuccessResponse:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        message:
          type: string
        total:
          type: integer
          format: int64
        results:
          type: array
          items:
            $ref: '#/components/schemas/Order'
    OrderSuccessResponse:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        message:
          type: string
        orderId:
          type: integer
          format: int64
    OrderDetailSuccessResponse:
      type: object
      properties:
        statusCode:
          type: integer
          format: int32
        message:
          type: string
        results:
          $ref: '#/components/schemas/Order'
    OrderErrorResponse:
      type: object
      properties:
        statusCode:
          description: Non zero error code
          type: integer
          format: int32
        message:
          description: Error message
          type: string
paths:
  /order:
    summary: This end point exposes operations related to orders
    description: Order endpoints
    post:
      tags:
        - Order-Service
      description: Place a new order
      operationId: createNewOrder
      requestBody:
        description: Oredr creation content
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Order'
      responses:
          200:
            description: Success response
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/OrderSuccessResponse'
          400:
            description: Client error
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/OrderErrorResponse'
          500:
            description: Server error
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/OrderErrorResponse'
    get:
      tags:
        - Order-Service
      description: Get All Orders with Pagination
      operationId: getAllOrders
      responses:
        200:
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderListSuccessResponse'
        400:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'
        404:
          description: No records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'
        500:
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'
  /order/{orderId}:
    description: Get indivisual order details by Id
    get:
      tags:
        - Order-Service
      description: Get order details
      operationId: getOrderById
      parameters:
      - name: orderId
        in: path
        description: Id of order to return details
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderDetailSuccessResponse'
        400:
          description: Client error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'
        404:
          description: No records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'
        500:
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderErrorResponse'