forked from loafle/openapi-generator-original

Fix another batch of spelling typos (#13915 )

* Fix typos

* Remove repeated words

* Minor grammar fixes

2022-11-07 21:30:24 +08:00

16 KiB

Raw Permalink Blame History

FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
fakeHealthGet	GET /fake/health	Health check endpoint
fakeHttpSignatureTest	GET /fake/http-signature-test	test http signature authentication
fakeOuterBooleanSerialize	POST /fake/outer/boolean
fakeOuterCompositeSerialize	POST /fake/outer/composite
fakeOuterNumberSerialize	POST /fake/outer/number
fakeOuterStringSerialize	POST /fake/outer/string
fakePropertyEnumIntegerSerialize	POST /fake/property/enum-int
testBodyWithBinary	PUT /fake/body-with-binary
testBodyWithFileSchema	PUT /fake/body-with-file-schema
testBodyWithQueryParams	PUT /fake/body-with-query-params
testClientModel	PATCH /fake	To test "client" model
testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
testEnumParameters	GET /fake	To test enum parameters
testGroupParameters	DELETE /fake	Fake endpoint to test group parameters (optional)
testInlineAdditionalProperties	POST /fake/inline-additionalProperties	test inline additionalProperties
testJsonFormData	GET /fake/jsonFormData	test json serialization of form data
testQueryParameterCollectionFormat	PUT /fake/test-query-parameters

fakeHealthGet

HealthCheckResult fakeHealthGet()

Health check endpoint

Parameters

This endpoint does not need any parameter.

Return type

HealthCheckResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The instance started successfully	-

fakeHttpSignatureTest

void fakeHttpSignatureTest(pet, query1, header1)

test http signature authentication

Parameters

Name	Type	Description	Notes
pet	Pet	Pet object that needs to be added to the store
query1	String	query parameter	[optional]
header1	String	header parameter	[optional]

Return type

void

Authorization

http_signature_test

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	The instance started successfully	-

fakeOuterBooleanSerialize

Boolean fakeOuterBooleanSerialize(body)

Test serialization of outer boolean types

Parameters

Name	Type	Description	Notes
body	Boolean	Input boolean as post body	[optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Output boolean	-

fakeOuterCompositeSerialize

OuterComposite fakeOuterCompositeSerialize(outerComposite)

Test serialization of object with outer number type

Parameters

Name	Type	Description	Notes
outerComposite	OuterComposite	Input composite as post body	[optional]

Return type

OuterComposite

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Output composite	-

fakeOuterNumberSerialize

BigDecimal fakeOuterNumberSerialize(body)

Test serialization of outer number types

Parameters

Name	Type	Description	Notes
body	BigDecimal	Input number as post body	[optional]

Return type

BigDecimal

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Output number	-

fakeOuterStringSerialize

String fakeOuterStringSerialize(body)

Test serialization of outer string types

Parameters

Name	Type	Description	Notes
body	String	Input string as post body	[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Output string	-

fakePropertyEnumIntegerSerialize

OuterObjectWithEnumProperty fakePropertyEnumIntegerSerialize(outerObjectWithEnumProperty)

Test serialization of enum (int) properties with examples

Parameters

Name	Type	Description	Notes
outerObjectWithEnumProperty	OuterObjectWithEnumProperty	Input enum (int) as post body

Return type

OuterObjectWithEnumProperty

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Output enum (int)	-

testBodyWithBinary

void testBodyWithBinary(body)

For this test, the body has to be a binary file.

Parameters

Name	Type	Description	Notes
body	File	image to upload

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: image/png
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

testBodyWithFileSchema

void testBodyWithFileSchema(fileSchemaTestClass)

For this test, the body for this request must reference a schema named `File`.

Parameters

Name	Type	Description	Notes
fileSchemaTestClass	FileSchemaTestClass

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

testBodyWithQueryParams

void testBodyWithQueryParams(query, user)

Parameters

Name	Type	Description	Notes
query	String
user	User

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

testClientModel

Client testClientModel(client)

To test "client" model

Parameters

Name	Type	Description	Notes
client	Client	client model

Return type

Client

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-

testEndpointParameters

void testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback)

Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트

Parameters

Name	Type	Description	Notes
number	BigDecimal	None
_double	Double	None
patternWithoutDelimiter	String	None
_byte	byte[]	None
integer	Integer	None	[optional]
int32	Integer	None	[optional]
int64	Long	None	[optional]
_float	Float	None	[optional]
string	String	None	[optional]
binary	File	None	[optional]
date	LocalDate	None	[optional]
dateTime	OffsetDateTime	None	[optional]
password	String	None	[optional]
paramCallback	String	None	[optional]

Return type

void

Authorization

http_basic_test

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid username supplied	-
404	User not found	-

testEnumParameters

void testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumQueryModelArray, enumFormStringArray, enumFormString)

To test enum parameters

Parameters

Name	Type	Description	Notes
enumHeaderStringArray	List<String>	Header parameter enum test (string array)	[optional] [enum: >, $]
enumHeaderString	String	Header parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryStringArray	List<String>	Query parameter enum test (string array)	[optional] [enum: >, $]
enumQueryString	String	Query parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryInteger	Integer	Query parameter enum test (double)	[optional] [enum: 1, -2]
enumQueryDouble	Double	Query parameter enum test (double)	[optional] [enum: 1.1, -1.2]
enumQueryModelArray	List<EnumClass>		[optional]
enumFormStringArray	List<String>	Form parameter enum test (string array)	[optional] [enum: >, $]
enumFormString	String	Form parameter enum test (string)	[optional] [default to -efg] [enum: _abc, -efg, (xyz)]

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Invalid request	-
404	Not found	-

testGroupParameters

void testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group)

Fake endpoint to test group parameters (optional)

Parameters

Name	Type	Description	Notes
requiredStringGroup	Integer	Required String in group parameters
requiredBooleanGroup	Boolean	Required Boolean in group parameters
requiredInt64Group	Long	Required Integer in group parameters
stringGroup	Integer	String in group parameters	[optional]
booleanGroup	Boolean	Boolean in group parameters	[optional]
int64Group	Long	Integer in group parameters	[optional]

Return type

void

Authorization

bearer_test

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
400	Something wrong	-

testInlineAdditionalProperties

void testInlineAdditionalProperties(requestBody)

test inline additionalProperties

Parameters

Name	Type	Description	Notes
requestBody	Map<String, String>	request body

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	successful operation	-

testJsonFormData

void testJsonFormData(param, param2)

test json serialization of form data

Parameters

Name	Type	Description	Notes
param	String	field1
param2	String	field2

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	successful operation	-

testQueryParameterCollectionFormat

void testQueryParameterCollectionFormat(pipe, ioutil, http, url, context, allowEmpty, language)

To test the collection format in query parameters

Parameters

Name	Type	Notes
pipe	List<String>
ioutil	List<String>
http	List<String>
url	List<String>
context	List<String>
allowEmpty	String
language	Map<String, String>	[optional]

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

16 KiB Raw Permalink Blame History

FakeApi

fakeHealthGet

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakeHttpSignatureTest

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakeOuterBooleanSerialize

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakeOuterCompositeSerialize

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakeOuterNumberSerialize

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakeOuterStringSerialize

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fakePropertyEnumIntegerSerialize

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testBodyWithBinary

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testBodyWithFileSchema

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testBodyWithQueryParams

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testClientModel

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testEndpointParameters

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testEnumParameters

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

16 KiB

Raw Permalink Blame History