oms-hexagonal-architecture-ddd/openapi/products-api.yml at main · hirannor/oms-hexagonal-architecture-ddd · 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
openapi: 3.0.3
info:
  title: Products API
  description: Products API
  version: 1.0.0
security:
  - bearerAuth: [ ]

paths:
  /products:
    get:
      tags:
        - Product
      summary: List all products
      operationId: displayAll
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
        - name: search
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'

    post:
      tags:
        - Product
      summary: Create a new product
      operationId: create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProduct'
      responses:
        '201':
          description: Product created
          headers:
            Location:
              schema:
                type: string
                description: URI of the created product
        '400':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Product with same name already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'

  /products/{id}:
    get:
      tags:
        - Product
      summary: Get product by ID
      operationId: displayBy
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic

  schemas:
    CreateProduct:
      type: object
      required: [ name, description, price ]
      properties:
        name:
          type: string
        description:
          type: string
        price:
          $ref: '#/components/schemas/Money'

    Product:
      type: object
      required: [ id, name, description, price ]
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        category:
          $ref: '#/components/schemas/ProductCategory'
        price:
          $ref: '#/components/schemas/Money'

    Money:
      type: object
      properties:
        amount:
          type: string
          format: decimal
          example: "99.99"
        currency:
          $ref: '#/components/schemas/Currency'
      required: [ amount, currency ]

    Currency:
      type: string
      enum:
        - HUF
        - EUR
    ProductCategory:
      type: string
      enum:
        - PERIPHERAL
        - DISPLAY
        - AUDIO_AND_SMART_DEVICE
        - ACCESSORIES
        - STORAGE

    ProblemDetails:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        fields:
          type: object
          additionalProperties:
            type: string
          description: A map of fieldName -> validation error message