OpenAPI-Specification/tests/schema/pass/example-object-examples.yaml at 6869dddb532eec411451ff4afc63ebb5d170a906 · handrews/OpenAPI-Specification · 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
openapi: 3.2.0
info:
  title: API
  version: 1.0.0
components:
  requestBodies:
    with-example:
      content:
        'application/json':
          schema:
            $ref: '#/components/schemas/Address'
          examples:
            foo:
              summary: A foo example
              value:
                foo: bar
            bar:
              summary: A bar example
              value:
                bar: baz
        application/xml:
          examples:
            xmlExample:
              summary: This is an example in XML
              externalValue: https://example.org/examples/address-example.xml
        text/plain:
          examples:
            textExample:
              summary: This is a text example
              externalValue: https://foo.bar/examples/address-example.txt
  parameters:
    with-example:
      name: zipCode
      in: query
      schema:
        type: string
        format: zip-code
      examples:
        zip-example:
          $ref: '#/components/examples/zip-example'
  responses:
    '200':
      description: your car appointment has been booked
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessResponse'
          examples:
            confirmation-success:
              $ref: '#/components/examples/confirmation-success'
        application/x-www-form-urlencoded:
          schema:
            type: object
            properties:
              jsonValue:
                type: string
          encoding:
            jsonValue:
              contentType: application/json
          examples:
            jsonFormValue:
              description: 'The JSON string "json" as a form value'
              dataValue: json
              serializedValue: jsonValue=%22json%22