OpenAPI-Specification/tests/schema/minimal-objects.yaml at 1fe6a24dfae7f7475aa2f91fe3a58791237f074c · OAI/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
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
# Minimal instances of Objects defined in the OpenAPI specification
#
# Each instance includes only the required properties for that Object.
# These instances are used to verify that the Object does not allow additional properties.

# OpenAPI Object has separate test cases

- objectName: Info Object
  subSchemaPath: /$defs/info
  minimalInstance:
    title: Sample API
    version: 1.0.0

- objectName: Contact Object
  subSchemaPath: /$defs/contact
  minimalInstance: {}

- objectName: License Object
  subSchemaPath: /$defs/license
  minimalInstance:
    name: Apache 2.0

- objectName: Server Object
  subSchemaPath: /$defs/server
  minimalInstance:
    url: https://example.com/docs

- objectName: Server Variable Object
  subSchemaPath: /$defs/server-variable
  minimalInstance:
    default: defaultValue

- objectName: Components Object
  subSchemaPath: /$defs/components
  minimalInstance: {}

- objectName: Paths Object
  subSchemaPath: /$defs/paths
  minimalInstance: {}

- objectName: Path Item Object
  subSchemaPath: /$defs/path-item
  minimalInstance: {}

- objectName: Operation Object
  subSchemaPath: /$defs/operation
  minimalInstance: {}

- objectName: External Documentation Object
  subSchemaPath: /$defs/external-documentation
  minimalInstance:
    url: https://example.com/docs

- objectName: Parameter Object
  subSchemaPath: /$defs/parameter
  minimalInstance:
    name: sampleParam
    in: query
    schema: # content could also be used, one of them is required
      type: string

- objectName: Request Body Object
  subSchemaPath: /$defs/request-body
  minimalInstance:
    content:
      application/json:
        schema:
          type: object

- objectName: Media Type Object
  subSchemaPath: /$defs/media-type
  minimalInstance: {}

- objectName: Encoding Object
  subSchemaPath: /$defs/encoding
  minimalInstance: {}

- objectName: Responses Object
  subSchemaPath: /$defs/responses
  minimalInstance:
    default: {} # or "200": {}, any response would do, Responses Object requires at least one response

- objectName: Response Object
  subSchemaPath: /$defs/response
  minimalInstance: {}

- objectName: Callback Object
  subSchemaPath: /$defs/callbacks
  minimalInstance: {}

- objectName: Example Object
  subSchemaPath: /$defs/example
  minimalInstance: {}

- objectName: Link Object
  subSchemaPath: /$defs/link
  minimalInstance:
    operationId: sampleOperation # operationRef could also be used, one of them is required

- objectName: Header Object
  subSchemaPath: /$defs/header
  minimalInstance:
    schema: # content could also be used, one of them is required
      type: string

- objectName: Tag Object
  subSchemaPath: /$defs/tag
  minimalInstance:
    name: Sample Tag

# Reference Object allows additional properties (which SHALL be ignored)

# Schema Object allows additional properties

# Discriminator Object is defined in meta.yaml, test case fail/discriminator-unexpected-property.yaml

# XML Object is defined in meta.yaml

- objectName: Security Scheme Object (HTTP Basic)
  subSchemaPath: /$defs/security-scheme
  minimalInstance:
    type: http
    scheme: basic

- objectName: OAuth Flows Object
  subSchemaPath: /$defs/oauth-flows
  minimalInstance: {}

- objectName: OAuth Flow Object (implicit)
  subSchemaPath: /$defs/oauth-flows/$defs/implicit
  minimalInstance:
    authorizationUrl: https://example.com/auth
    scopes: {}

- objectName: OAuth Flow Object (password)
  subSchemaPath: /$defs/oauth-flows/$defs/password
  minimalInstance:
    tokenUrl: https://example.com/token
    scopes: {}

- objectName: OAuth Flow Object (clientCredentials)
  subSchemaPath: /$defs/oauth-flows/$defs/client-credentials
  minimalInstance:
    tokenUrl: https://example.com/token
    scopes: {}

- objectName: OAuth Flow Object (authorizationCode)
  subSchemaPath: /$defs/oauth-flows/$defs/authorization-code
  minimalInstance:
    authorizationUrl: https://example.com/auth
    tokenUrl: https://example.com/token
    scopes: {}

- objectName: OAuth Flow Object (deviceAuthorization)
  subSchemaPath: /$defs/oauth-flows/$defs/device-authorization
  minimalInstance:
    deviceAuthorizationUrl: https://example.com/device
    tokenUrl: https://example.com/auth
    scopes: {}

# Security Requirement Object allows additional properties