openapi-typescript/openapi.yaml at main · 540/openapi-typescript · 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
openapi: 3.1.0

info:
  title: OpenAPI Specification
  description: This is a sample OpenAPI specification for a simple API.
  version: 1.0.0

servers:
  - url: https://api.example.com/v1
    description: Production server

paths:
  /pets:
    get:
      summary: Get all pets
      operationId: getPets
      tags:
        - pets
      responses:
        "200":
          description: A list of pets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Pet"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: "Internal server error"
  /pets/{petId}:
    get:
      summary: Get a pet by ID
      operationId: getPetById
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The ID of the pet to retrieve
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: A single pet
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pet"
        "404":
          description: Pet not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/InternalServerError"

components:
  schemas:
    Pet:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        name:
          type: string
          example: "Fluffy"
        tag:
          type: string
          example: "dog"
      required:
        - id
        - name

    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: "Not Found"
      required:
        - error
    ValidationError:
      type: object
      properties:
        error:
          type: string
          example: "Validation failed"
      required:
        - error
    NotFoundError:
      type: object
      properties:
        error:
          type: string
          example: "Resource not found"
      required:
        - error
    UnauthorizedError:
      type: object
      properties:
        error:
          type: string
          example: "Unauthorized"
      required:
        - error
    ForbiddenError:
      type: object
      properties:
        error:
          type: string
          example: "Forbidden"
      required:
        - error
    InternalServerError:
      type: object
      properties:
        error:
          type: string
          example: "Internal server error"
      required:
        - error
    ServiceUnavailableError:
      type: object
      properties:
        error:
          type: string
          example: "Service unavailable"
      required:
        - error