Skip to content

Commit 4acc945

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/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/encoding_object_defaults/content/encoding_object_defaults/encoding/allowReserved/explode" : true, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/allowReserved/style" : "form", "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/explode/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/explode/style" : "form", "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_form/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_form/explode" : true, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_spaceDelimited/allowReserved" : false, "/components/parameters/encoding_object_defaults/content/encoding_object_defaults/encoding/style_spaceDelimited/explode" : false, "/components/parameters/encoding_object_defaults/deprecated" : false, "/components/parameters/encoding_object_defaults/required" : false, "/components/parameters/header/deprecated" : false, "/components/parameters/header/explode" : false, "/components/parameters/header/style" : "simple", "/components/parameters/path_label/deprecated" : false, "/components/parameters/path_label/explode" : false, "/components/parameters/path_matrix/deprecated" : false, "/components/parameters/path_matrix/explode" : false, "/components/parameters/path_media_type/deprecated" : 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.1/dialect/WORK-IN-PROGRESS", "/servers" : [ { "url" : "/" } ] }, "valid" : true } (executable is part of https://github.com/karenetheridge/OpenAPI-Modern)
1 parent d74d33a commit 4acc945

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
openapi: 3.1.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+
parameters:
7+
encoding_object_defaults:
8+
name: encoding_object_defaults
9+
in: path
10+
content:
11+
encoding_object_defaults: # media type name
12+
encoding:
13+
no_styles: # property name
14+
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"
15+
style_form:
16+
x-comment: "expecting defaults: explode=true, allowReserved=false"
17+
style: form
18+
style_spaceDelimited:
19+
x-comment: "expecting defaults: explode=false, allowReserved=false"
20+
style: spaceDelimited
21+
explode:
22+
x-comment: "expecting defaults: style=form, allowReserved=false"
23+
explode: false
24+
allowReserved:
25+
x-comment: "expecting default: style=form, explode=true"
26+
allowReserved: true
27+
path_media_type:
28+
x-comment: "expecting defaults: deprecated=false"
29+
name: path_media-type
30+
in: path
31+
required: true
32+
content:
33+
text/*:
34+
schema: {}
35+
path_simple:
36+
x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false"
37+
name: path_simple
38+
in: path
39+
required: true
40+
schema: {}
41+
path_matrix:
42+
x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false"
43+
name: path_matrix
44+
in: path
45+
required: true
46+
style: matrix
47+
schema: {}
48+
path_label:
49+
x-comment: "expecting defaults: deprecated=false, explode=false, allowReserved=false"
50+
name: path_label
51+
in: path
52+
required: true
53+
style: label
54+
schema: {}
55+
query_media_type:
56+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false"
57+
name: query_media_type
58+
in: query
59+
content:
60+
text/*:
61+
schema: {}
62+
query_form:
63+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, style=form, explode=true, allowReserved=false"
64+
name: query_form
65+
in: query
66+
schema: {}
67+
query_spaceDelimited:
68+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false"
69+
name: query_spaceDelimited
70+
in: query
71+
style: spaceDelimited
72+
schema: {}
73+
query_pipeDelimited:
74+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, explode=false, allowReserved=false"
75+
name: query_pipeDelimited
76+
in: query
77+
style: pipeDelimited
78+
schema: {}
79+
query_deepObject:
80+
x-comment: "expecting defaults: required=false, deprecated=false, allowEmptyValue=false, allowReserved=false"
81+
name: query_deepObject
82+
in: query
83+
style: deepObject
84+
schema: {}
85+
header:
86+
x-comment: "expecting defaults: deprecated=false, style=simple, explode=false, allowReserved=false"
87+
name: header
88+
in: path
89+
required: true
90+
schema: {}
91+
cookie_media_type:
92+
x-comment: "expecting defaults: required=false, deprecated=false"
93+
name: cookie_media_type
94+
in: cookie
95+
content:
96+
text/*:
97+
schema: {}
98+
cookie_form:
99+
x-comment: "expecting defaults: required=false, deprecated=false, style=form, explode=true, allowReserved=false"
100+
name: cookie_form
101+
in: cookie
102+
schema: {}

0 commit comments

Comments
 (0)