2022-12-08 00:30:07 +08:00
openapi : 3.0 .3
info :
contact :
email : team@openapitools.org
description : Echo Server API
license :
name : Apache 2.0
url : http://www.apache.org/licenses/LICENSE-2.0.html
title : Echo Server API
version : 0.1 .0
servers :
- url : http://localhost:3000/
paths :
2023-10-10 11:10:30 +02:00
/path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}:
2022-12-08 00:30:07 +08:00
get :
description : Test path parameter(s)
2023-10-10 11:10:30 +02:00
operationId : "tests/path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path}"
2022-12-08 00:30:07 +08:00
parameters :
- explode : false
in : path
name : path_string
required : true
schema :
type : string
style : simple
- explode : false
in : path
name : path_integer
required : true
schema :
type : integer
style : simple
2023-10-10 11:10:30 +02:00
- explode : false
in : path
name : enum_nonref_string_path
required : true
schema :
enum :
- success
- failure
- unclassified
type : string
style : simple
- explode : false
in : path
name : enum_ref_string_path
required : true
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2023-10-10 11:10:30 +02:00
style : simple
2022-12-08 00:30:07 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test path parameter(s)
tags :
- path
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-02-02 18:18:55 +08:00
/form/integer/boolean/string :
post :
description : Test form parameter(s)
operationId : test/form/integer/boolean/string
requestBody :
content :
application/x-www-form-urlencoded :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_form_integer_boolean_string_request"
2023-02-02 18:18:55 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test form parameter(s)
tags :
- form
x-content-type : application/x-www-form-urlencoded
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-09-03 16:15:54 +08:00
/form/oneof :
post :
description : Test form parameter(s) for oneOf schema
operationId : test/form/oneof
requestBody :
content :
application/x-www-form-urlencoded :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_form_oneof_request"
2023-09-03 16:15:54 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test form parameter(s) for oneOf schema
tags :
- form
x-content-type : application/x-www-form-urlencoded
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2024-03-23 22:40:10 +09:00
/form/object/multipart :
post :
description : Test form parameter(s) for multipart schema
operationId : test/form/object/multipart
requestBody :
content :
multipart/form-data :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_form_object_multipart_request"
2024-03-23 22:40:10 +09:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test form parameter(s) for multipart schema
tags :
- form
x-content-type : multipart/form-data
x-accepts :
- text/plain
2023-10-10 11:10:30 +02:00
/header/integer/boolean/string/enums :
2023-02-02 18:18:55 +08:00
get :
description : Test header parameter(s)
2023-10-10 11:10:30 +02:00
operationId : test/header/integer/boolean/string/enums
2023-02-02 18:18:55 +08:00
parameters :
- explode : true
in : header
name : integer_header
required : false
schema :
type : integer
style : form
- explode : true
in : header
name : boolean_header
required : false
schema :
type : boolean
style : form
- explode : true
in : header
name : string_header
required : false
schema :
type : string
style : form
2023-10-10 11:10:30 +02:00
- explode : true
in : header
name : enum_nonref_string_header
required : false
schema :
enum :
- success
- failure
- unclassified
type : string
style : form
- explode : true
in : header
name : enum_ref_string_header
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2023-10-10 11:10:30 +02:00
style : form
2023-02-02 18:18:55 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test header parameter(s)
tags :
- header
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-04-22 16:08:59 +08:00
/query/enum_ref_string :
get :
description : Test query parameter(s)
operationId : test/enum_ref_string
parameters :
2023-10-10 11:10:30 +02:00
- explode : true
in : query
name : enum_nonref_string_query
required : false
schema :
enum :
- success
- failure
- unclassified
type : string
style : form
2023-04-22 16:08:59 +08:00
- explode : true
in : query
name : enum_ref_string_query
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2023-04-22 16:08:59 +08:00
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-02-12 21:11:29 +08:00
/query/datetime/date/string :
get :
description : Test query parameter(s)
operationId : test/query/datetime/date/string
parameters :
- explode : true
in : query
name : datetime_query
required : false
schema :
format : date-time
type : string
style : form
- explode : true
in : query
name : date_query
required : false
schema :
format : date
type : string
style : form
- explode : true
in : query
name : string_query
required : false
schema :
type : string
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2022-12-08 00:30:07 +08:00
/query/integer/boolean/string :
get :
description : Test query parameter(s)
operationId : test/query/integer/boolean/string
parameters :
- explode : true
in : query
name : integer_query
required : false
schema :
type : integer
style : form
- explode : true
in : query
name : boolean_query
required : false
schema :
type : boolean
style : form
- explode : true
in : query
name : string_query
required : false
schema :
type : string
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2022-12-08 00:30:07 +08:00
/query/style_form/explode_true/array_string :
get :
description : Test query parameter(s)
operationId : test/query/style_form/explode_true/array_string
parameters :
- explode : true
in : query
name : query_object
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_query_style_form_explode_true_array_string_query_object_parameter"
2022-12-08 00:30:07 +08:00
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2024-01-24 10:20:18 +08:00
/query/style_form/explode_false/array_integer :
get :
description : Test query parameter(s)
operationId : test/query/style_form/explode_false/array_integer
parameters :
- explode : false
in : query
name : query_object
required : false
schema :
items :
type : integer
type : array
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2024-01-24 10:20:18 +08:00
/query/style_form/explode_false/array_string :
get :
description : Test query parameter(s)
operationId : test/query/style_form/explode_false/array_string
parameters :
- explode : false
in : query
name : query_object
required : false
schema :
items :
type : string
type : array
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2022-12-08 00:30:07 +08:00
/query/style_form/explode_true/object :
get :
description : Test query parameter(s)
operationId : test/query/style_form/explode_true/object
parameters :
- explode : true
in : query
name : query_object
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2022-12-08 00:30:07 +08:00
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-01-19 16:13:51 +08:00
/query/style_form/explode_true/object/allOf :
get :
description : Test query parameter(s)
operationId : test/query/style_form/explode_true/object/allOf
parameters :
- explode : true
in : query
name : query_object
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/DataQuery"
2023-01-19 16:13:51 +08:00
style : form
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-01-06 17:10:06 +08:00
/query/style_deepObject/explode_true/object :
get :
description : Test query parameter(s)
operationId : test/query/style_deepObject/explode_true/object
parameters :
- explode : true
in : query
name : query_object
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2023-01-06 17:10:06 +08:00
style : deepObject
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-01-11 20:29:13 +08:00
/query/style_deepObject/explode_true/object/allOf :
get :
description : Test query parameter(s)
operationId : test/query/style_deepObject/explode_true/object/allOf
parameters :
- explode : true
in : query
name : query_object
required : false
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_query_style_deepObject_explode_true_object_allOf_query_object_parameter"
2023-01-11 20:29:13 +08:00
style : deepObject
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2025-08-10 16:47:51 +02:00
/query/style_jsonSerialization/object :
get :
description : Test query parameter(s)
operationId : test/query/style_jsonSerialization/object
parameters :
- content :
application/json :
schema :
$ref : "#/components/schemas/Pet"
in : query
name : json_serialized_object_ref_string_query
required : false
- content :
application/json :
schema :
items :
$ref : "#/components/schemas/Pet"
type : array
in : query
name : json_serialized_object_array_ref_string_query
required : false
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test query parameter(s)
tags :
- query
x-accepts :
- text/plain
2023-05-01 10:51:22 +08:00
/body/application/octetstream/binary :
post :
description : Test body parameter(s)
operationId : test/body/application/octetstream/binary
requestBody :
content :
application/octet-stream :
schema :
format : binary
type : string
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test body parameter(s)
tags :
- body
x-content-type : application/octet-stream
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2022-12-08 17:29:53 +08:00
/echo/body/Pet :
post :
description : Test body parameter(s)
operationId : test/echo/body/Pet
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/Pet"
2022-12-08 17:29:53 +08:00
responses :
"200" :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2022-12-08 17:29:53 +08:00
description : Successful operation
summary : Test body parameter(s)
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- application/json
2023-11-05 22:43:45 +08:00
/echo/body/allOf/Pet :
post :
description : Test body parameter(s)
operationId : test/echo/body/allOf/Pet
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/AllOfPet"
2023-11-05 22:43:45 +08:00
responses :
"200" :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2023-11-05 22:43:45 +08:00
description : Successful operation
summary : Test body parameter(s)
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- application/json
2023-02-02 18:18:55 +08:00
/echo/body/Pet/response_string :
post :
description : Test empty response body
operationId : test/echo/body/Pet/response_string
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/Pet"
2023-02-02 18:18:55 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test empty response body
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-04-28 14:06:27 +08:00
/echo/body/Tag/response_string :
post :
description : Test empty json (request body)
operationId : test/echo/body/Tag/response_string
requestBody :
2025-06-02 15:33:27 +08:00
$ref : "#/components/requestBodies/Tag"
2023-04-28 14:06:27 +08:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test empty json (request body)
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-04-28 14:06:27 +08:00
/echo/body/FreeFormObject/response_string :
post :
description : Test free form object
operationId : test/echo/body/FreeFormObject/response_string
requestBody :
content :
application/json :
schema :
type : object
description : Free form object
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test free form object
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2024-02-08 03:52:43 +01:00
/echo/body/string_enum :
post :
description : Test string enum response body
operationId : test/echo/body/string_enum
requestBody :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2024-02-08 03:52:43 +01:00
description : String enum
responses :
"200" :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2024-02-08 03:52:43 +01:00
description : Successful operation
summary : Test string enum response body
tags :
- body
x-content-type : application/json
2024-03-21 10:53:18 +01:00
x-accepts :
- application/json
2023-03-31 16:16:58 +08:00
/binary/gif :
post :
description : Test binary (gif) response body
operationId : test/binary/gif
responses :
"200" :
content :
image/gif :
schema :
format : binary
type : string
description : Successful operation
summary : Test binary (gif) response body
tags :
- body
2024-03-21 10:53:18 +01:00
x-accepts :
- image/gif
2023-12-26 02:32:51 +01:00
/body/application/octetstream/single_binary :
post :
description : Test single binary in multipart mime
operationId : test/body/multipart/formdata/single_binary
requestBody :
content :
multipart/form-data :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_body_multipart_formdata_single_binary_request"
2023-12-26 02:32:51 +01:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test single binary in multipart mime
tags :
- body
x-content-type : multipart/form-data
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-07-24 09:57:21 +02:00
/body/application/octetstream/array_of_binary :
post :
description : Test array of binary in multipart mime
operationId : test/body/multipart/formdata/array_of_binary
requestBody :
content :
multipart/form-data :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_body_multipart_formdata_array_of_binary_request"
2023-07-24 09:57:21 +02:00
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
summary : Test array of binary in multipart mime
tags :
- body
x-content-type : multipart/form-data
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-09-03 19:11:53 +08:00
/auth/http/basic :
post :
description : To test HTTP basic authentication
operationId : test/auth/http/basic
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
security :
- http_auth : [ ]
summary : To test HTTP basic authentication
tags :
- auth
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2023-11-16 01:38:49 +09:00
/auth/http/bearer :
post :
description : To test HTTP bearer authentication
operationId : test/auth/http/bearer
responses :
"200" :
content :
text/plain :
schema :
type : string
description : Successful operation
security :
- http_bearer_auth : [ ]
summary : To test HTTP bearer authentication
tags :
- auth
2024-03-21 10:53:18 +01:00
x-accepts :
- text/plain
2022-12-08 00:30:07 +08:00
components :
2022-12-08 17:29:53 +08:00
requestBodies :
Pet :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Pet"
2022-12-08 17:29:53 +08:00
description : Pet object that needs to be added to the store
2023-11-05 22:43:45 +08:00
AllOfPet :
content :
application/json :
schema :
allOf :
2025-06-02 15:33:27 +08:00
- $ref : "#/components/schemas/Pet"
2023-11-05 22:43:45 +08:00
description : Pet object that needs to be added to the store
2023-04-28 14:06:27 +08:00
Tag :
content :
application/json :
schema :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Tag"
2023-04-28 14:06:27 +08:00
description : Tag object
2022-12-08 00:30:07 +08:00
schemas :
Category :
2022-12-08 17:29:53 +08:00
example :
name : Dogs
id : 1
2022-12-08 00:30:07 +08:00
properties :
id :
example : 1
format : int64
type : integer
name :
example : Dogs
type : string
type : object
xml :
name : category
Tag :
2022-12-08 17:29:53 +08:00
example :
name : name
id : 0
2022-12-08 00:30:07 +08:00
properties :
id :
format : int64
type : integer
name :
type : string
type : object
xml :
name : tag
Pet :
2022-12-08 17:29:53 +08:00
example :
photoUrls :
- photoUrls
- photoUrls
name : doggie
id : 10
category :
name : Dogs
id : 1
tags :
- name : name
id : 0
- name : name
id : 0
status : available
2022-12-08 00:30:07 +08:00
properties :
id :
example : 10
format : int64
type : integer
name :
example : doggie
type : string
category :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Category"
2022-12-08 00:30:07 +08:00
photoUrls :
items :
type : string
xml :
name : photoUrl
type : array
xml :
wrapped : true
tags :
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/Tag"
2022-12-08 00:30:07 +08:00
type : array
xml :
wrapped : true
status :
description : pet status in the store
enum :
- available
- pending
- sold
type : string
required :
- name
- photoUrls
type : object
xml :
name : pet
2023-02-07 21:49:30 +08:00
StringEnumRef :
enum :
- success
- failure
- unclassified
type : string
2023-01-30 20:19:00 +08:00
DefaultValue :
description : to test the default value of properties
properties :
2023-02-07 21:49:30 +08:00
array_string_enum_ref_default :
default :
- success
- failure
items :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/StringEnumRef"
2023-02-07 21:49:30 +08:00
type : array
2023-01-30 20:19:00 +08:00
array_string_enum_default :
default :
- success
- failure
items :
enum :
- success
- failure
- unclassified
type : string
type : array
array_string_default :
default :
- failure
- skipped
items :
type : string
type : array
array_integer_default :
default :
- 1
- 3
items :
type : integer
type : array
array_string :
items :
type : string
type : array
array_string_nullable :
items :
type : string
nullable : true
type : array
2023-02-24 15:24:34 +08:00
array_string_extension_nullable :
items :
type : string
type : array
x-nullable : true
2023-01-30 20:19:00 +08:00
string_nullable :
nullable : true
type : string
type : object
2023-01-11 20:29:13 +08:00
Bird :
properties :
size :
type : string
color :
type : string
type : object
2023-01-19 16:13:51 +08:00
Query :
properties :
id :
description : Query
format : int64
type : integer
outcomes :
default :
- SUCCESS
- FAILURE
items :
enum :
- SUCCESS
- FAILURE
- SKIPPED
type : string
type : array
type : object
x-parent : true
DataQuery :
allOf :
2023-06-11 15:35:58 +08:00
- properties :
suffix :
description : test suffix
type : string
text :
description : Some text containing white spaces
example : Some text
type : string
date :
description : A date
format : date-time
type : string
type : object
2025-06-02 15:33:27 +08:00
- $ref : "#/components/schemas/Query"
2023-04-06 11:51:12 +08:00
NumberPropertiesOnly :
properties :
number :
type : number
float :
format : float
type : number
double :
format : double
maximum : 50.2
minimum : 0.8
type : number
type : object
2023-02-02 18:18:55 +08:00
test_form_integer_boolean_string_request :
properties :
integer_form :
type : integer
boolean_form :
type : boolean
string_form :
type : string
type : object
2023-09-03 16:15:54 +08:00
test_form_oneof_request_oneOf :
properties :
form1 :
type : string
form2 :
type : integer
type : object
test_form_oneof_request_oneOf_1 :
properties :
form3 :
type : string
form4 :
type : boolean
type : object
test_form_oneof_request :
oneOf :
2025-06-02 15:33:27 +08:00
- $ref : "#/components/schemas/test_form_oneof_request_oneOf"
- $ref : "#/components/schemas/test_form_oneof_request_oneOf_1"
- $ref : "#/components/schemas/Tag"
2023-09-03 16:15:54 +08:00
type : object
2024-03-23 22:40:10 +09:00
test_form_object_multipart_request_marker :
properties :
name :
type : string
type : object
test_form_object_multipart_request :
properties :
marker :
2025-06-02 15:33:27 +08:00
$ref : "#/components/schemas/test_form_object_multipart_request_marker"
2024-03-23 22:40:10 +09:00
required :
- marker
type : object
2022-12-08 00:30:07 +08:00
test_query_style_form_explode_true_array_string_query_object_parameter :
properties :
values :
items :
type : string
type : array
type : object
2023-01-13 17:21:28 +08:00
test_query_style_deepObject_explode_true_object_allOf_query_object_parameter :
allOf :
2025-06-02 15:33:27 +08:00
- $ref : "#/components/schemas/Bird"
- $ref : "#/components/schemas/Category"
2023-12-26 02:32:51 +01:00
test_body_multipart_formdata_single_binary_request :
properties :
my-file :
format : binary
type : string
type : object
2023-07-24 09:57:21 +02:00
test_body_multipart_formdata_array_of_binary_request :
properties :
files :
items :
format : binary
type : string
type : array
required :
- files
type : object
2023-09-03 19:11:53 +08:00
securitySchemes :
http_auth :
scheme : basic
type : http
2023-11-16 01:38:49 +09:00
http_bearer_auth :
scheme : bearer
type : http
2022-12-08 00:30:07 +08:00