example-openapi-spec/request-body-contains-nested-obj.yaml at main · Alive-Fish/example-openapi-spec · 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
openapi: 3.0.0
info:
  title: Repair Service
  description: A simple service to manage repairs
  version: 1.0.0
servers:
  - url: https://sme85beaf.azurewebsites.net/api
    description: The repair api server
paths:
  /repairs:
    post:
      operationId: createRepair
      summary: Create a new repair
      description: Creates a new repair with the provided details
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: The short summary of the repair
                description:
                  type: string
                  description: The detailed description of the repair
                assignedTo:
                  type: string
                  description: The user who is responsible for the repair
                details:
                  type: object
                  description: Additional details about the repair
                  properties:
                    partNumber:
                      type: string
                      description: The part number of the item to be repaired
                    warranty:
                      type: boolean
                      description: Whether the item is under warranty
      responses:
        '201':
          description: Repair created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier of the created repair
                  title:
                    type: string
                    description: The short summary of the repair
                  description:
                    type: string
                    description: The detailed description of the repair
                  assignedTo:
                    type: string
                    description: The user who is responsible for the repair
                  details:
                    type: object
                    description: Additional details about the repair
                    properties:
                      partNumber:
                        type: string
                        description: The part number of the item to be repaired
                      warranty:
                        type: boolean
                        description: Whether the item is under warranty