File size: 4,760 Bytes
4304c6d
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
172
173
174
175
176
177
178
179
180
181
182
const examples = [
  {
    key: 'json',
    content: `{

      "openapi": "3.1.0",

      "info": {

        "title": "Get weather data",

        "description": "Retrieves current weather data for a location.",

        "version": "v1.0.0"

      },

      "servers": [

        {

          "url": "https://weather.example.com"

        }

      ],

      "paths": {

        "/location": {

          "get": {

            "description": "Get temperature for a specific location",

            "operationId": "GetCurrentWeather",

            "parameters": [

              {

                "name": "location",

                "in": "query",

                "description": "The city and state to retrieve the weather for",

                "required": true,

                "schema": {

                  "type": "string"

                }

              }

            ],

            "deprecated": false

          }

        }

      },

      "components": {

        "schemas": {}

      }

    }`,
  },
  {
    key: 'yaml',
    content: `# Taken from https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.0/petstore.yaml



    openapi: "3.0.0"

    info:

      version: 1.0.0

      title: Swagger Petstore

      license:

        name: MIT

    servers:

      - url: https://petstore.swagger.io/v1

    paths:

      /pets:

        get:

          summary: List all pets

          operationId: listPets

          tags:

            - pets

          parameters:

            - name: limit

              in: query

              description: How many items to return at one time (max 100)

              required: false

              schema:

                type: integer

                maximum: 100

                format: int32

          responses:

            '200':

              description: A paged array of pets

              headers:

                x-next:

                  description: A link to the next page of responses

                  schema:

                    type: string

              content:

                application/json:    

                  schema:

                    $ref: "#/components/schemas/Pets"

            default:

              description: unexpected error

              content:

                application/json:

                  schema:

                    $ref: "#/components/schemas/Error"

        post:

          summary: Create a pet

          operationId: createPets

          tags:

            - pets

          responses:

            '201':

              description: Null response

            default:

              description: unexpected error

              content:

                application/json:

                  schema:

                    $ref: "#/components/schemas/Error"

      /pets/{petId}:

        get:

          summary: Info for a specific pet

          operationId: showPetById

          tags:

            - pets

          parameters:

            - name: petId

              in: path

              required: true

              description: The id of the pet to retrieve

              schema:

                type: string

          responses:

            '200':

              description: Expected response to a valid request

              content:

                application/json:

                  schema:

                    $ref: "#/components/schemas/Pet"

            default:

              description: unexpected error

              content:

                application/json:

                  schema:

                    $ref: "#/components/schemas/Error"

    components:

      schemas:

        Pet:

          type: object

          required:

            - id

            - name

          properties:

            id:

              type: integer

              format: int64

            name:

              type: string

            tag:

              type: string

        Pets:

          type: array

          maxItems: 100

          items:

            $ref: "#/components/schemas/Pet"

        Error:

          type: object

          required:

            - code

            - message

          properties:

            code:

              type: integer

              format: int32

            message:

              type: string`,
  },
  {
    key: 'blankTemplate',
    content: `{

      "openapi": "3.1.0",

      "info": {

        "title": "Untitled",

        "description": "Your OpenAPI specification",

        "version": "v1.0.0"

      },

      "servers": [

        {

          "url": ""

        }

      ],

      "paths": {},

      "components": {

        "schemas": {}

      }

    }`,
  },
]

export default examples