Skip to content

Commit 9c7316d

Browse files
committed
fix return type in perl doc
1 parent 9eecccb commit 9c7316d

File tree

5 files changed

+58
-58
lines changed

5 files changed

+58
-58
lines changed

samples/client/petstore/perl/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ WWW::SwaggerClient::Role - a Moose role for the Swagger Petstore
88

99
Automatically generated by the Perl Swagger Codegen project:
1010

11-
- Build date: 2016-03-06T15:35:17.711+08:00
11+
- Build date: 2016-03-08T16:48:08.361+08:00
1212
- Build package: class io.swagger.codegen.languages.PerlClientCodegen
1313
- Codegen version:
1414

@@ -256,7 +256,7 @@ Class | Method | HTTP request | Description
256256
- [WWW::SwaggerClient::Object::Category](docs/Category.md)
257257
- [WWW::SwaggerClient::Object::Pet](docs/Pet.md)
258258
- [WWW::SwaggerClient::Object::Tag](docs/Tag.md)
259-
- [WWW::SwaggerClient::Object::ObjectReturn](docs/ObjectReturn.md)
259+
- [WWW::SwaggerClient::Object::ModelReturn](docs/ModelReturn.md)
260260
- [WWW::SwaggerClient::Object::Order](docs/Order.md)
261261
- [WWW::SwaggerClient::Object::SpecialModelName](docs/SpecialModelName.md)
262262
- [WWW::SwaggerClient::Object::InlineResponse200](docs/InlineResponse200.md)

samples/client/petstore/perl/docs/PetApi.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ Update an existing pet
2424

2525

2626

27-
### Sample
27+
### Example
2828
```perl
2929
my $api = WWW::SwaggerClient::PetApi->new();
3030
my $body = WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
3131

3232
eval {
33-
my $result = $api->update_pet(body => $body);
33+
$api->update_pet(body => $body);
3434
};
3535
if ($@) {
3636
warn "Exception when calling update_pet: $@\n";
@@ -66,13 +66,13 @@ Add a new pet to the store
6666

6767

6868

69-
### Sample
69+
### Example
7070
```perl
7171
my $api = WWW::SwaggerClient::PetApi->new();
7272
my $body = WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
7373

7474
eval {
75-
my $result = $api->add_pet(body => $body);
75+
$api->add_pet(body => $body);
7676
};
7777
if ($@) {
7878
warn "Exception when calling add_pet: $@\n";
@@ -102,13 +102,13 @@ petstore_auth
102102

103103

104104
# **find_pets_by_status**
105-
> find_pets_by_status(status => $status)
105+
> ARRAY[Pet] find_pets_by_status(status => $status)
106106
107107
Finds Pets by status
108108

109109
Multiple status values can be provided with comma separated strings
110110

111-
### Sample
111+
### Example
112112
```perl
113113
my $api = WWW::SwaggerClient::PetApi->new();
114114
my $status = (); # [ARRAY[string]] Status values that need to be considered for query
@@ -144,13 +144,13 @@ petstore_auth
144144

145145

146146
# **find_pets_by_tags**
147-
> find_pets_by_tags(tags => $tags)
147+
> ARRAY[Pet] find_pets_by_tags(tags => $tags)
148148
149149
Finds Pets by tags
150150

151151
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
152152

153-
### Sample
153+
### Example
154154
```perl
155155
my $api = WWW::SwaggerClient::PetApi->new();
156156
my $tags = (); # [ARRAY[string]] Tags to filter by
@@ -186,13 +186,13 @@ petstore_auth
186186

187187

188188
# **get_pet_by_id**
189-
> get_pet_by_id(pet_id => $pet_id)
189+
> Pet get_pet_by_id(pet_id => $pet_id)
190190
191191
Find pet by ID
192192

193193
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
194194

195-
### Sample
195+
### Example
196196
```perl
197197
my $api = WWW::SwaggerClient::PetApi->new();
198198
my $pet_id = 789; # [int] ID of pet that needs to be fetched
@@ -234,15 +234,15 @@ Updates a pet in the store with form data
234234

235235

236236

237-
### Sample
237+
### Example
238238
```perl
239239
my $api = WWW::SwaggerClient::PetApi->new();
240240
my $pet_id = 'pet_id_example'; # [string] ID of pet that needs to be updated
241241
my $name = 'name_example'; # [string] Updated name of the pet
242242
my $status = 'status_example'; # [string] Updated status of the pet
243243

244244
eval {
245-
my $result = $api->update_pet_with_form(pet_id => $pet_id, name => $name, status => $status);
245+
$api->update_pet_with_form(pet_id => $pet_id, name => $name, status => $status);
246246
};
247247
if ($@) {
248248
warn "Exception when calling update_pet_with_form: $@\n";
@@ -280,14 +280,14 @@ Deletes a pet
280280

281281

282282

283-
### Sample
283+
### Example
284284
```perl
285285
my $api = WWW::SwaggerClient::PetApi->new();
286286
my $pet_id = 789; # [int] Pet id to delete
287287
my $api_key = 'api_key_example'; # [string]
288288

289289
eval {
290-
my $result = $api->delete_pet(pet_id => $pet_id, api_key => $api_key);
290+
$api->delete_pet(pet_id => $pet_id, api_key => $api_key);
291291
};
292292
if ($@) {
293293
warn "Exception when calling delete_pet: $@\n";
@@ -324,15 +324,15 @@ uploads an image
324324

325325

326326

327-
### Sample
327+
### Example
328328
```perl
329329
my $api = WWW::SwaggerClient::PetApi->new();
330330
my $pet_id = 789; # [int] ID of pet to update
331331
my $additional_metadata = 'additional_metadata_example'; # [string] Additional data to pass to server
332332
my $file = '/path/to/file.txt'; # [File] file to upload
333333

334334
eval {
335-
my $result = $api->upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file);
335+
$api->upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file);
336336
};
337337
if ($@) {
338338
warn "Exception when calling upload_file: $@\n";
@@ -364,13 +364,13 @@ petstore_auth
364364

365365

366366
# **get_pet_by_id_in_object**
367-
> get_pet_by_id_in_object(pet_id => $pet_id)
367+
> InlineResponse200 get_pet_by_id_in_object(pet_id => $pet_id)
368368
369369
Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
370370

371371
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
372372

373-
### Sample
373+
### Example
374374
```perl
375375
my $api = WWW::SwaggerClient::PetApi->new();
376376
my $pet_id = 789; # [int] ID of pet that needs to be fetched
@@ -406,13 +406,13 @@ api_keypetstore_auth
406406

407407

408408
# **pet_pet_idtesting_byte_arraytrue_get**
409-
> pet_pet_idtesting_byte_arraytrue_get(pet_id => $pet_id)
409+
> string pet_pet_idtesting_byte_arraytrue_get(pet_id => $pet_id)
410410
411411
Fake endpoint to test byte array return by 'Find pet by ID'
412412

413413
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
414414

415-
### Sample
415+
### Example
416416
```perl
417417
my $api = WWW::SwaggerClient::PetApi->new();
418418
my $pet_id = 789; # [int] ID of pet that needs to be fetched
@@ -432,7 +432,7 @@ Name | Type | Description | Notes
432432

433433
### Return type
434434

435-
[**string**](string.md)
435+
**string**
436436

437437
### HTTP headers
438438

@@ -454,13 +454,13 @@ Fake endpoint to test byte array in body parameter for adding a new pet to the s
454454

455455

456456

457-
### Sample
457+
### Example
458458
```perl
459459
my $api = WWW::SwaggerClient::PetApi->new();
460460
my $body = WWW::SwaggerClient::Object::string->new(); # [string] Pet object in the form of byte array
461461

462462
eval {
463-
my $result = $api->add_pet_using_byte_array(body => $body);
463+
$api->add_pet_using_byte_array(body => $body);
464464
};
465465
if ($@) {
466466
warn "Exception when calling add_pet_using_byte_array: $@\n";

samples/client/petstore/perl/docs/StoreApi.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Method | HTTP request | Description
1313

1414

1515
# **find_orders_by_status**
16-
> find_orders_by_status(status => $status)
16+
> ARRAY[Order] find_orders_by_status(status => $status)
1717
1818
Finds orders by status
1919

2020
A single status value can be provided as a string
2121

22-
### Sample
22+
### Example
2323
```perl
2424
my $api = WWW::SwaggerClient::StoreApi->new();
2525
my $status = 'status_example'; # [string] Status value that needs to be considered for query
@@ -55,13 +55,13 @@ test_api_client_idtest_api_client_secret
5555

5656

5757
# **get_inventory**
58-
> get_inventory()
58+
> HASH[string,int] get_inventory()
5959
6060
Returns pet inventories by status
6161

6262
Returns a map of status codes to quantities
6363

64-
### Sample
64+
### Example
6565
```perl
6666
my $api = WWW::SwaggerClient::StoreApi->new();
6767

@@ -79,7 +79,7 @@ Name | Type | Description | Notes
7979

8080
### Return type
8181

82-
[**HASH[string,int]**](HASH.md)
82+
**HASH[string,int]**
8383

8484
### HTTP headers
8585

@@ -95,13 +95,13 @@ api_key
9595

9696

9797
# **get_inventory_in_object**
98-
> get_inventory_in_object()
98+
> object get_inventory_in_object()
9999
100100
Fake endpoint to test arbitrary object return by 'Get inventory'
101101

102102
Returns an arbitrary object which is actually a map of status codes to quantities
103103

104-
### Sample
104+
### Example
105105
```perl
106106
my $api = WWW::SwaggerClient::StoreApi->new();
107107

@@ -119,7 +119,7 @@ Name | Type | Description | Notes
119119

120120
### Return type
121121

122-
[**object**](object.md)
122+
**object**
123123

124124
### HTTP headers
125125

@@ -135,13 +135,13 @@ api_key
135135

136136

137137
# **place_order**
138-
> place_order(body => $body)
138+
> Order place_order(body => $body)
139139
140140
Place an order for a pet
141141

142142

143143

144-
### Sample
144+
### Example
145145
```perl
146146
my $api = WWW::SwaggerClient::StoreApi->new();
147147
my $body = WWW::SwaggerClient::Object::Order->new(); # [Order] order placed for purchasing the pet
@@ -177,13 +177,13 @@ test_api_client_idtest_api_client_secret
177177

178178

179179
# **get_order_by_id**
180-
> get_order_by_id(order_id => $order_id)
180+
> Order get_order_by_id(order_id => $order_id)
181181
182182
Find purchase order by ID
183183

184184
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
185185

186-
### Sample
186+
### Example
187187
```perl
188188
my $api = WWW::SwaggerClient::StoreApi->new();
189189
my $order_id = 'order_id_example'; # [string] ID of pet that needs to be fetched
@@ -225,13 +225,13 @@ Delete purchase order by ID
225225

226226
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
227227

228-
### Sample
228+
### Example
229229
```perl
230230
my $api = WWW::SwaggerClient::StoreApi->new();
231231
my $order_id = 'order_id_example'; # [string] ID of the order that needs to be deleted
232232

233233
eval {
234-
my $result = $api->delete_order(order_id => $order_id);
234+
$api->delete_order(order_id => $order_id);
235235
};
236236
if ($@) {
237237
warn "Exception when calling delete_order: $@\n";

0 commit comments

Comments
 (0)