loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Update default value for Perl, Ruby, ROR generators (#265)

Browse Source 
* rename perl genreator default

* update ruby sinatra default

* rename ror default value
This commit is contained in:
William Cheng
2018-04-29 20:37:12 +08:00
committed by GitHub
parent 861d11d010
commit c60010c965
175 changed files with 1121 additions and 2061 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
samples/client/petstore/perl/docs/FakeApi.md
View File

@@ -1,8 +1,8 @@
# WWW::SwaggerClient::FakeApi
# WWW::OpenAPIClient::FakeApi
## Load the API package
```perl
use WWW::SwaggerClient::Object::FakeApi;
use WWW::OpenAPIClient::Object::FakeApi;
```
All URIs are relative to *http://petstore.swagger.io:80/v2*
@@ -13,6 +13,7 @@ Method | HTTP request | Description
[**fake_outer_composite_serialize**](FakeApi.md#fake_outer_composite_serialize) | **POST** /fake/outer/composite |
[**fake_outer_number_serialize**](FakeApi.md#fake_outer_number_serialize) | **POST** /fake/outer/number |
[**fake_outer_string_serialize**](FakeApi.md#fake_outer_string_serialize) | **POST** /fake/outer/string |
[**test_body_with_query_params**](FakeApi.md#test_body_with_query_params) | **PUT** /fake/body-with-query-params |
[**test_client_model**](FakeApi.md#test_client_model) | **PATCH** /fake | To test \"client\" model
[**test_endpoint_parameters**](FakeApi.md#test_endpoint_parameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
[**test_enum_parameters**](FakeApi.md#test_enum_parameters) | **GET** /fake | To test enum parameters
@@ -21,7 +22,7 @@ Method | HTTP request | Description
# **fake_outer_boolean_serialize**
> OuterBoolean fake_outer_boolean_serialize(body => $body)
> boolean fake_outer_boolean_serialize(body => $body)
@@ -30,11 +31,11 @@ Test serialization of outer boolean types
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $body = WWW::SwaggerClient::Object::boolean->new(); # boolean | Input boolean as post body
my $body = WWW::OpenAPIClient::Object::boolean->new(); # boolean | Input boolean as post body
eval {
my $result = $api_instance->fake_outer_boolean_serialize(body => $body);
@@ -53,7 +54,7 @@ Name | Type | Description | Notes
### Return type
[**OuterBoolean**](OuterBoolean.md)
**boolean**
### Authorization
@@ -61,7 +62,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -76,11 +77,11 @@ Test serialization of object with outer number type
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $outer_composite = WWW::SwaggerClient::Object::OuterComposite->new(); # OuterComposite | Input composite as post body
my $outer_composite = WWW::OpenAPIClient::Object::OuterComposite->new(); # OuterComposite | Input composite as post body
eval {
my $result = $api_instance->fake_outer_composite_serialize(outer_composite => $outer_composite);
@@ -107,13 +108,13 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **fake_outer_number_serialize**
> OuterNumber fake_outer_number_serialize(body => $body)
> double fake_outer_number_serialize(body => $body)
@@ -122,11 +123,11 @@ Test serialization of outer number types
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $body = WWW::SwaggerClient::Object::double->new(); # double | Input number as post body
my $body = WWW::OpenAPIClient::Object::double->new(); # double | Input number as post body
eval {
my $result = $api_instance->fake_outer_number_serialize(body => $body);
@@ -145,7 +146,7 @@ Name | Type | Description | Notes
### Return type
[**OuterNumber**](OuterNumber.md)
**double**
### Authorization
@@ -153,13 +154,13 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Content-Type**: Not defined
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **fake_outer_string_serialize**
> OuterString fake_outer_string_serialize(body => $body)
> string fake_outer_string_serialize(body => $body)
@@ -168,11 +169,11 @@ Test serialization of outer string types
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $body = WWW::SwaggerClient::Object::string->new(); # string | Input string as post body
my $body = WWW::OpenAPIClient::Object::string->new(); # string | Input string as post body
eval {
my $result = $api_instance->fake_outer_string_serialize(body => $body);
@@ -191,7 +192,52 @@ Name | Type | Description | Notes
### Return type
[**OuterString**](OuterString.md)
**string**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **test_body_with_query_params**
> test_body_with_query_params(query => $query, user => $user)
### Example
```perl
use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $query = "query_example"; # string |
my $user = WWW::OpenAPIClient::Object::User->new(); # User |
eval {
$api_instance->test_body_with_query_params(query => $query, user => $user);
};
if ($@) {
warn "Exception when calling FakeApi->test_body_with_query_params: $@\n";
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **string**| |
**user** | [**User**](User.md)| |
### Return type
void (empty response body)
### Authorization
@@ -200,7 +246,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -214,11 +260,11 @@ To test \"client\" model
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $client = WWW::SwaggerClient::Object::Client->new(); # Client | client model
my $client = WWW::OpenAPIClient::Object::Client->new(); # Client | client model
eval {
my $result = $api_instance->test_client_model(client => $client);
@@ -260,8 +306,8 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
# Configure HTTP basic authorization: http_basic_test
username => 'YOUR_USERNAME',
@@ -335,8 +381,8 @@ To test enum parameters
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $enum_header_string_array = [("'$'")]; # ARRAY[string] | Header parameter enum test (string array)
@@ -385,21 +431,21 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **test_inline_additional_properties**
> test_inline_additional_properties(UNKNOWN_PARAM_NAME => $UNKNOWN_PARAM_NAME)
> test_inline_additional_properties(request_body => $request_body)
test inline additionalProperties
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $UNKNOWN_PARAM_NAME = WWW::SwaggerClient::Object::->new(); # | request body
my $request_body = WWW::OpenAPIClient::Object::string->new(); # string | request body
eval {
$api_instance->test_inline_additional_properties(UNKNOWN_PARAM_NAME => $UNKNOWN_PARAM_NAME);
$api_instance->test_inline_additional_properties(request_body => $request_body);
};
if ($@) {
warn "Exception when calling FakeApi->test_inline_additional_properties: $@\n";
@@ -410,7 +456,7 @@ if ($@) {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**UNKNOWN_PARAM_NAME** | [****](.md)| request body |
**request_body** | [**string**](string.md)| request body |
### Return type
@@ -435,8 +481,8 @@ test json serialization of form data
### Example
```perl
use Data::Dumper;
use WWW::SwaggerClient::FakeApi;
my $api_instance = WWW::SwaggerClient::FakeApi->new(
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);
my $param = "param_example"; # string | field1