backendDevTest/existingApis.yaml at main · RodGam9/backendDevTest · 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
openapi: 3.0.0
info:
  title: existingApis
  version: '1.0'
servers:
  - url: 'http://localhost:3001'
paths:
  '/product/{productId}/similarids':
    parameters:
      - schema:
          type: string
        name: productId
        in: path
        required: true
    get:
      operationId: get-product-similarids
      summary: Gets the ids of the similar products
      description: Returns the similar products to a given one ordered by similarity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimilarProducts'
  '/product/{productId}':
    parameters:
      - schema:
          type: string
        name: productId
        in: path
        required: true
    get:
      operationId: get-product-productId
      summary: Gets a product detail
      description: Returns the product detail for a given productId
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ProductDetail'
        '404':
          description: Product Not found
components:
  schemas:
    SimilarProducts:
      type: array
      description: 'List of similar product Ids to a given one ordered by similarity'
      minItems: 0
      uniqueItems: true
      items:
        type: string
        example: ["1","2","3"]
    ProductDetail:
      description: 'Product detail'
      type: object
      properties:
        id:
          type: string
          minLength: 1
        name:
          type: string
          minLength: 1
        price:
          type: number
        availability:
          type: boolean
      required:
        - id
        - name
        - price
        - availability