Skip to content

Commit 48e7905

Browse files
working examples of parameter and encoding object permutations with all defaults omitted
tested with: $ openapi-validate --with-defaults tests/schema/pass/style-defaults.yaml { "defaults" : { "/components/mediaTypes/encoding_object_defaults/encoding/allowReserved/explode" : true, "/components/mediaTypes/encoding_object_defaults/encoding/allowReserved/style" : "form", "/components/mediaTypes/encoding_object_defaults/encoding/explode/allowReserved" : false, "/components/mediaTypes/encoding_object_defaults/encoding/explode/style" : "form", "/components/mediaTypes/encoding_object_defaults/encoding/style_form/allowReserved" : false, "/components/mediaTypes/encoding_object_defaults/encoding/style_form/explode" : true, "/components/mediaTypes/encoding_object_defaults/encoding/style_spaceDelimited/allowReserved" : false, "/components/mediaTypes/encoding_object_defaults/encoding/style_spaceDelimited/explode" : false, "/components/parameters/cookie_cookie/deprecated" : false, "/components/parameters/cookie_cookie/explode" : true, "/components/parameters/cookie_cookie/required" : false, "/components/parameters/cookie_form/allowReserved" : false, "/components/parameters/cookie_form/deprecated" : false, "/components/parameters/cookie_form/explode" : true, "/components/parameters/cookie_form/required" : false, "/components/parameters/cookie_form/style" : "form", "/components/parameters/cookie_media_type/deprecated" : false, "/components/parameters/cookie_media_type/required" : false, "/components/parameters/header/allowReserved" : false, "/components/parameters/header/deprecated" : false, "/components/parameters/header/explode" : false, "/components/parameters/header/style" : "simple", "/components/parameters/path_label/allowReserved" : false, "/components/parameters/path_label/deprecated" : false, "/components/parameters/path_label/explode" : false, "/components/parameters/path_matrix/allowReserved" : false, "/components/parameters/path_matrix/deprecated" : false, "/components/parameters/path_matrix/explode" : false, "/components/parameters/path_media_type/deprecated" : false, "/components/parameters/path_simple/allowReserved" : false, "/components/parameters/path_simple/deprecated" : false, "/components/parameters/path_simple/explode" : false, "/components/parameters/path_simple/style" : "simple", "/components/parameters/query_deepObject/allowEmptyValue" : false, "/components/parameters/query_deepObject/allowReserved" : false, "/components/parameters/query_deepObject/deprecated" : false, "/components/parameters/query_deepObject/explode" : false, "/components/parameters/query_deepObject/required" : false, "/components/parameters/query_form/allowEmptyValue" : false, "/components/parameters/query_form/allowReserved" : false, "/components/parameters/query_form/deprecated" : false, "/components/parameters/query_form/explode" : true, "/components/parameters/query_form/required" : false, "/components/parameters/query_form/style" : "form", "/components/parameters/query_media_type/allowEmptyValue" : false, "/components/parameters/query_media_type/deprecated" : false, "/components/parameters/query_media_type/required" : false, "/components/parameters/query_pipeDelimited/allowEmptyValue" : false, "/components/parameters/query_pipeDelimited/allowReserved" : false, "/components/parameters/query_pipeDelimited/deprecated" : false, "/components/parameters/query_pipeDelimited/explode" : false, "/components/parameters/query_pipeDelimited/required" : false, "/components/parameters/query_spaceDelimited/allowEmptyValue" : false, "/components/parameters/query_spaceDelimited/allowReserved" : false, "/components/parameters/query_spaceDelimited/deprecated" : false, "/components/parameters/query_spaceDelimited/explode" : false, "/components/parameters/query_spaceDelimited/required" : false, "/jsonSchemaDialect" : "https://spec.openapis.org/oas/3.2/dialect/WORK-IN-PROGRESS", "/servers" : [ { "url" : "/" } ] }, "valid" : true } (executable is part of https://github.com/karenetheridge/OpenAPI-Modern)
1 parent 7281c4a commit 48e7905

1 file changed

Lines changed: 105 additions & 0 deletions

File tree

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
openapi: 3.2.0
2+
info:
3+
title: various permutations of parameter objects, with non-required values left to their defaults
4+
version: 1.0.0
5+
components:
6+
mediaTypes:
7+
encoding_object_defaults: # media type name
8+
encoding:
9+
no_styles: # property name
10+
x-comment: "style, explode and allowReserved are not present, so contentType is used; no defaults expected as default contentType cannot be determined by the schema"
11+
style_form:
12+
x-comment: "expecting defaults: explode=true, allowReserved=false"
13+
style: form
14+
style_spaceDelimited:
15+
x-comment: "expecting defaults: explode=false, allowReserved=false"
16+
style: spaceDelimited
17+
explode:
18+
x-comment: "expecting defaults: style=form, allowReserved=false"
19+
explode: false
20+
allowReserved:
21+
x-comment: "expecting default: style=form, explode=true"
22+
allowReserved: true
23+
parameters:
24+
path_media_type:
25+
x-comment: "expecting defaults: deprecated=false"
26+
name: path_media-type
27+
in: path
28+
required: true
29+
content:
30+
text/*:
31+
schema: {}
32+
path_simple:
33+
x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false"
34+
name: path_simple
35+
in: path
36+
required: true
37+
schema: {}
38+
path_matrix:
39+
x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false"
40+
name: path_matrix
41+
in: path
42+
required: true
43+
style: matrix
44+
schema: {}
45+
path_label:
46+
x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false"
47+
name: path_label
48+
in: path
49+
required: true
50+
style: label
51+
schema: {}
52+
query_media_type:
53+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false"
54+
name: query_media_type
55+
in: query
56+
content:
57+
text/*:
58+
schema: {}
59+
query_form:
60+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, style=form, explode=true, allowReserved=false"
61+
name: query_form
62+
in: query
63+
schema: {}
64+
query_spaceDelimited:
65+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false"
66+
name: query_spaceDelimited
67+
in: query
68+
style: spaceDelimited
69+
schema: {}
70+
query_pipeDelimited:
71+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false"
72+
name: query_pipeDelimited
73+
in: query
74+
style: pipeDelimited
75+
schema: {}
76+
query_deepObject:
77+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, allowReserved=false"
78+
name: query_deepObject
79+
in: query
80+
style: deepObject
81+
schema: {}
82+
header:
83+
x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false"
84+
name: header
85+
in: path
86+
required: true
87+
schema: {}
88+
cookie_media_type:
89+
x-comment: "expecting defaults: required=false, deprecated=false"
90+
name: cookie_media_type
91+
in: cookie
92+
content:
93+
text/*:
94+
schema: {}
95+
cookie_form:
96+
x-comment: "expecting defaults: required=false, deprecated=false, style=form, explode=true, allowReserved=false"
97+
name: cookie_form
98+
in: cookie
99+
schema: {}
100+
cookie_cookie:
101+
x-comment: "expecting defaults: required=false, deprecated=false, explode=true"
102+
name: cookie_cookie
103+
in: cookie
104+
style: cookie
105+
schema: {}

0 commit comments

Comments
 (0)