example-openapi-spec/response-no-body.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
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
openapi: 3.0.0
info:
  title: Repair Service
  description: A simple service to manage repairs for various items
  version: 1.0.0
servers:
  - url: https://piercerepairsapi.azurewebsites.net/
paths:
  /repairs:
    get:
      operationId: list_Repairs_
      summary: List all repairs
      description: Returns a list of repairs with their details and images
      parameters:
        - name: assignedTo
          in: query
          description: Filter repairs by who they're assigned to
          schema:
            type: string
          required: false
      responses:
        '200':
          description: A successful response
          content:
            html/text:
              schema:
                type: array
                items:
                  properties:
                    id:
                      description: The unique identifier of the repair
                    title:
                      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
                    date:
                      type: string
                      format: date-time
                      description: The date and time when the repair is scheduled or completed
                    image:
                      type: string
                      format: uri
                      description: The URL of the image of the item to be repaired or the repair process
    patch:
      summary: Update an existing repair
      description: Update an existing repair to the list with the new updated details and image URL
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - id
              properties:
                id:
                  type: integer
                  description: The unique identifier of the repair to update
                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
                date:
                  type: string
                  format: date-time
                  description: The date and time when the repair is scheduled or completed
                image:
                  type: string
                  format: uri
                  description: The URL of the image of the item to be repaired or the repair process
      responses:
        '200':
          description: Repair updated
        '404':
          description: Repair not found
      operationId: patchRepairs
    post:
      operationId: createRepair
      summary: Create a new repair
      description: Adds a new repair to the list with the given details and image URL
      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
                date:
                  type: string
                  format: date-time
                  description: The optional date and time when the repair is scheduled or completed
                image:
                  type: string
                  format: uri
                  description: The URL of the image of the item to be repaired or the repair process
              required:
                - title
                - description
                - assignedTo
      responses:
        '201':
          description: A successful response indicating that the repair was created