Pet-API-Microservice/api-definition.yaml at main · sbmars/Pet-API-Microservice · 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
openapi: 3.0.3
info:
  title: Pet API Microservice
  description: An API Microservice to manage pets.
  version: 1.0.0
servers:
  - url: http://localhost:3000
    description: Local server

paths:
  /pet:
    get:
      summary: Get all pets
      operationId: getPets
      responses:
        '200':
          description: A list of pets.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Pet'

    post:
      summary: Add a new pet
      operationId: addPet
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPet'
      responses:
        '201':
          description: Pet created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '404':
          description: Parameter Exception - Parameter name is not set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

    put:
      summary: Update a pet by ID (in request body)
      operationId: updatePetByIdInBody
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pet'
      responses:
        '200':
          description: Pet updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '404':
          description: API Exception - Pet not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

  /pet/{id}:
    put:
      summary: Update a pet by ID (in path parameter)
      operationId: updatePetByIdInPath
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPet'
      responses:
        '200':
          description: Pet updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '404':
          description: API Exception - Pet not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

    delete:
      summary: Delete a pet by ID
      operationId: deletePetById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '204':
          description: Pet deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
        '404':
          description: API Exception - Pet not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    Pet:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        type:
          type: string
        age:
          type: integer

    NewPet:
      type: object
      properties:
        name:
          type: string
          example: "Buddy"
        type:
          type: string
          example: "Dog"
        age:
          type: integer
          example: 4
      required:
        - name

    Error:
      type: object
      properties:
        type:
          type: string
          example: "API Exception"
        errorMessage:
          type: string
          example: "Pet not found"

    Success:
      type: object
      properties:
        type:
          type: string
          example: "success"
        errorMessage:
          type: string
          example: "Pet with id 1 deleted"