14 KiB
FakeApi
All URIs are relative to /v2
| Method | HTTP request | Description |
|---|---|---|
| fakeHealthGet | GET /fake/health | Health check endpoint |
| fakeOuterBooleanSerialize | POST /fake/outer/boolean | |
| fakeOuterCompositeSerialize | POST /fake/outer/composite | |
| fakeOuterNumberSerialize | POST /fake/outer/number | |
| fakeOuterStringSerialize | POST /fake/outer/string | |
| 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-paramters |
fakeHealthGet
Health check endpoint
Example
petstore-cli fakeHealthGet
Parameters
This endpoint does not need any parameter.
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
fakeOuterBooleanSerialize
Test serialization of outer boolean types
Example
petstore-cli fakeOuterBooleanSerialize
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: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
fakeOuterCompositeSerialize
Test serialization of object with outer number type
Example
petstore-cli fakeOuterCompositeSerialize
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| outerComposite | OuterComposite | Input composite as post body | [optional] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
fakeOuterNumberSerialize
Test serialization of outer number types
Example
petstore-cli fakeOuterNumberSerialize
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | integer | Input number as post body | [optional] |
Return type
integer
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
fakeOuterStringSerialize
Test serialization of outer string types
Example
petstore-cli fakeOuterStringSerialize
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: /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testBodyWithFileSchema
For this test, the body for this request much reference a schema named 'File'.
Example
petstore-cli testBodyWithFileSchema
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fileSchemaTestClass | FileSchemaTestClass |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testBodyWithQueryParams
Example
petstore-cli testBodyWithQueryParams query=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | [default to null] | |
| user | User |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testClientModel
To test "client" model
To test "client" model
Example
petstore-cli testClientModel
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| client | Client | client model |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testEndpointParameters
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Example
petstore-cli testEndpointParameters
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| number | integer | None | [default to null] |
| double | float | None | [default to null] |
| patternWithoutDelimiter | string | None | [default to null] |
| byte | string | None | [default to null] |
| integer | integer | None | [optional] [default to null] |
| int32 | integer | None | [optional] [default to null] |
| int64 | integer | None | [optional] [default to null] |
| float | float | None | [optional] [default to null] |
| string | string | None | [optional] [default to null] |
| binary | binary | None | [optional] [default to null] |
| date | string | None | [optional] [default to null] |
| dateTime | string | None | [optional] [default to null] |
| password | string | None | [optional] [default to null] |
| callback | string | None | [optional] [default to null] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testEnumParameters
To test enum parameters
To test enum parameters
Example
petstore-cli testEnumParameters enum_header_string_array:value enum_header_string:value Specify as: enum_query_string_array=value1 enum_query_string_array=value2 enum_query_string_array=... enum_query_string=value enum_query_integer=value enum_query_double=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| enumHeaderStringArray | array[string] | Header parameter enum test (string array) | [optional] [default to null] |
| enumHeaderString | string | Header parameter enum test (string) | [optional] [default to -efg] |
| enumQueryStringArray | array[string] | Query parameter enum test (string array) | [optional] [default to null] |
| enumQueryString | string | Query parameter enum test (string) | [optional] [default to -efg] |
| enumQueryInteger | integer | Query parameter enum test (double) | [optional] [default to null] |
| enumQueryDouble | float | Query parameter enum test (double) | [optional] [default to null] |
| enumFormStringArray | array[string] | Form parameter enum test (string array) | [optional] [default to $] |
| enumFormString | string | Form parameter enum test (string) | [optional] [default to -efg] |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testGroupParameters
Fake endpoint to test group parameters (optional)
Fake endpoint to test group parameters (optional)
Example
petstore-cli testGroupParameters required_string_group=value required_boolean_group:value required_int64_group=value string_group=value boolean_group:value int64_group=value
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requiredStringGroup | integer | Required String in group parameters | [default to null] |
| requiredBooleanGroup | boolean | Required Boolean in group parameters | [default to null] |
| requiredInt64Group | integer | Required Integer in group parameters | [default to null] |
| stringGroup | integer | String in group parameters | [optional] [default to null] |
| booleanGroup | boolean | Boolean in group parameters | [optional] [default to null] |
| int64Group | integer | Integer in group parameters | [optional] [default to null] |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testInlineAdditionalProperties
test inline additionalProperties
Example
petstore-cli testInlineAdditionalProperties
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| requestBody | map[String, string] | request body |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testJsonFormData
test json serialization of form data
Example
petstore-cli testJsonFormData
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| param | string | field1 | [default to null] |
| param2 | string | field2 | [default to null] |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]
testQueryParameterCollectionFormat
To test the collection format in query parameters
Example
petstore-cli testQueryParameterCollectionFormat Specify as: pipe=value1 pipe=value2 pipe=... Specify as: ioutil="value1,value2,..." Specify as: Specify as: url="value1,value2,..." Specify as: context=value1 context=value2 context=...
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| pipe | array[string] | [default to null] | |
| ioutil | array[string] | [default to null] | |
| http | array[string] | [default to null] | |
| url | array[string] | [default to null] | |
| context | array[string] | [default to null] |
Return type
(empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not Applicable
- Accept: Not Applicable
[Back to top] [Back to API list] [Back to Model list] [Back to README]