From 652099ab71c000cbdc62edc1a9352b8cea98d8b7 Mon Sep 17 00:00:00 2001 From: wing328 Date: Sat, 19 Mar 2016 17:02:51 +0800 Subject: [PATCH 1/2] update perl readme --- .../src/main/resources/perl/README.mustache | 10 +++++++--- samples/client/petstore/perl/README.md | 9 +++++---- samples/client/petstore/perl/docs/Name.md | 1 + .../perl/lib/WWW/SwaggerClient/Object/Name.pm | 13 +++++++++++-- .../petstore/perl/lib/WWW/SwaggerClient/Role.pm | 4 ++-- 5 files changed, 26 insertions(+), 11 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/perl/README.mustache b/modules/swagger-codegen/src/main/resources/perl/README.mustache index e4271d94936..b7641ecea8c 100644 --- a/modules/swagger-codegen/src/main/resources/perl/README.mustache +++ b/modules/swagger-codegen/src/main/resources/perl/README.mustache @@ -2,15 +2,19 @@ {{moduleName}}::Role - a Moose role for the {{appName}} -## {{appName}} version: {{appVersion}} +{{#appDescription}}{{{appDescription}}}{{/appDescription}} # VERSION -Automatically generated by the Perl Swagger Codegen project: +Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: +- API verion: {{appVersion}} +- Package version: {{moduleVersion}} - Build date: {{generatedDate}} - Build package: {{generatorClass}} -- Codegen version: +{{#infoUrl}} +For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) +{{/infoUrl}} ## A note on Moose diff --git a/samples/client/petstore/perl/README.md b/samples/client/petstore/perl/README.md index c240e99a10d..6ebfc0dcb76 100644 --- a/samples/client/petstore/perl/README.md +++ b/samples/client/petstore/perl/README.md @@ -2,15 +2,16 @@ WWW::SwaggerClient::Role - a Moose role for the Swagger Petstore -## Swagger Petstore version: 1.0.0 +This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters # VERSION -Automatically generated by the Perl Swagger Codegen project: +Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: -- Build date: 2016-03-17T15:41:15.325+08:00 +- API verion: 1.0.0 +- Package version: 1.0.0 +- Build date: 2016-03-19T16:59:31.367+08:00 - Build package: class io.swagger.codegen.languages.PerlClientCodegen -- Codegen version: ## A note on Moose diff --git a/samples/client/petstore/perl/docs/Name.md b/samples/client/petstore/perl/docs/Name.md index 91d0a056ab8..13b5d0dde82 100644 --- a/samples/client/petstore/perl/docs/Name.md +++ b/samples/client/petstore/perl/docs/Name.md @@ -9,6 +9,7 @@ use WWW::SwaggerClient::Object::Name; Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **int** | | [optional] +**snake_case** | **int** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm index 2413c55650d..f136a7f031e 100644 --- a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm +++ b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm @@ -110,15 +110,24 @@ __PACKAGE__->method_documentation({ format => '', read_only => '', }, + 'snake_case' => { + datatype => 'int', + base_name => 'snake_case', + description => '', + format => '', + read_only => '', + }, }); __PACKAGE__->swagger_types( { - 'name' => 'int' + 'name' => 'int', + 'snake_case' => 'int' } ); __PACKAGE__->attribute_map( { - 'name' => 'name' + 'name' => 'name', + 'snake_case' => 'snake_case' } ); __PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map}); diff --git a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm index 3f09db6f1d5..0b3e7bd5de7 100644 --- a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm +++ b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm @@ -37,7 +37,7 @@ has version_info => ( is => 'ro', default => sub { { app_name => 'Swagger Petstore', app_version => '1.0.0', - generated_date => '2016-03-17T15:41:15.325+08:00', + generated_date => '2016-03-19T16:59:31.367+08:00', generator_class => 'class io.swagger.codegen.languages.PerlClientCodegen', } }, documentation => 'Information about the application version and the codegen codebase version' @@ -103,7 +103,7 @@ Automatically generated by the Perl Swagger Codegen project: =over 4 -=item Build date: 2016-03-17T15:41:15.325+08:00 +=item Build date: 2016-03-19T16:59:31.367+08:00 =item Build package: class io.swagger.codegen.languages.PerlClientCodegen From eb5c689fac2f4213aec2b694e966bf6d98ad2a30 Mon Sep 17 00:00:00 2001 From: wing328 Date: Thu, 24 Mar 2016 19:54:25 +0800 Subject: [PATCH 2/2] update js sample --- .../petstore/javascript-promise/README.md | 69 ++++++++++--------- .../docs/InlineResponse200.md | 1 - .../petstore/javascript-promise/docs/Name.md | 1 + .../javascript-promise/docs/PetApi.md | 45 ++++++------ .../javascript-promise/docs/StoreApi.md | 25 ++++--- .../javascript-promise/docs/UserApi.md | 32 ++++----- .../javascript-promise/src/api/PetApi.js | 4 +- .../javascript-promise/src/api/StoreApi.js | 9 +-- .../javascript-promise/src/api/UserApi.js | 12 +--- .../javascript-promise/src/model/Name.js | 9 +++ samples/client/petstore/javascript/README.md | 2 +- .../client/petstore/javascript/docs/Name.md | 1 + .../petstore/javascript/src/api/PetApi.js | 8 --- .../petstore/javascript/src/model/Name.js | 9 +++ 14 files changed, 114 insertions(+), 113 deletions(-) diff --git a/samples/client/petstore/javascript-promise/README.md b/samples/client/petstore/javascript-promise/README.md index 2c2f6f169b6..478bc4657ca 100644 --- a/samples/client/petstore/javascript-promise/README.md +++ b/samples/client/petstore/javascript-promise/README.md @@ -1,69 +1,76 @@ # swagger-petstore SwaggerPetstore - JavaScript client for swagger-petstore +This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters +This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: -Version: 1.0.0 - -Automatically generated by the JavaScript Swagger Codegen project: - -- Build date: 2016-03-18T15:44:17.513Z +- API verion: 1.0.0 +- Package version: 1.0.0 +- Build date: 2016-03-24T19:50:42.301+08:00 - Build package: class io.swagger.codegen.languages.JavascriptClientCodegen ## Installation -### Use in [Node.js](https://nodejs.org/) +### For [Node.js](https://nodejs.org/) -The generated client is valid [npm](https://www.npmjs.com/) package, you can publish it as described -in [Publishing npm packages](https://docs.npmjs.com/getting-started/publishing-npm-packages). +#### npm -After that, you can install it into your project via: +To publish the library as a [npm](https://www.npmjs.com/), +please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). + +Then install it via: ```shell npm install swagger-petstore --save ``` -You can also host the generated client as a git repository on github, e.g. -https://github.com/YOUR_USERNAME/swagger-petstore - -Then you can install it via: +#### git +# +If the library is hosted at a git repository, e.g. +https://github.com/YOUR_USERNAME/YOUR_GIT_REPO_ID +then install it via: ```shell -npm install YOUR_USERNAME/swagger-petstore --save +npm install YOUR_USERNAME/YOUR_GIT_REPO_ID --save ``` -### Use in browser with [browserify](http://browserify.org/) +### For browser -The client also works in browser environment via npm and browserify. After following +The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, -you can do this in your project (assuming *main.js* is your entry file): +perform the following (assuming *main.js* is your entry file): ```shell browserify main.js > bundle.js ``` -The generated *bundle.js* can now be included in your HTML pages. +Then include *bundle.js* in the HTML pages. ## Getting Started +Please follow the [installation](#installation) instruction and execute the following JS code: + ```javascript var SwaggerPetstore = require('swagger-petstore'); var defaultClient = SwaggerPetstore.ApiClient.default; -defaultClient.timeout = 10 * 1000; -defaultClient.defaultHeaders['Test-Header'] = 'test_value'; -// Assuming there's a `PetApi` containing a `getPetById` method -// which returns a model object: -var api = new SwaggerPetstore.PetApi(); -api.getPetById(2, function(err, pet, resp) { - console.log('HTTP status code: ' + resp.status); - console.log('Response Content-Type: ' + resp.get('Content-Type')); - if (err) { - console.error(err); - } else { - console.log(pet); - } +// Configure OAuth2 access token for authorization: petstore_auth +var petstore_auth = defaultClient.authentications['petstore_auth']; +petstore_auth.accessToken = "YOUR ACCESS TOKEN" + +var api = new SwaggerPetstore.PetApi() + +var opts = { + 'body': new SwaggerPetstore.Pet() // {Pet} Pet object that needs to be added to the store +}; +api.addPet(opts).then(function() { + console.log('API called successfully.'); +}, function(error) { + console.error(error); }); + + ``` ## Documentation for API Endpoints diff --git a/samples/client/petstore/javascript-promise/docs/InlineResponse200.md b/samples/client/petstore/javascript-promise/docs/InlineResponse200.md index 66a4605e2c4..bbb11067e9a 100644 --- a/samples/client/petstore/javascript-promise/docs/InlineResponse200.md +++ b/samples/client/petstore/javascript-promise/docs/InlineResponse200.md @@ -1,4 +1,3 @@ - # SwaggerPetstore.InlineResponse200 ## Properties diff --git a/samples/client/petstore/javascript-promise/docs/Name.md b/samples/client/petstore/javascript-promise/docs/Name.md index 114d6dc980e..5086f6c5a3e 100644 --- a/samples/client/petstore/javascript-promise/docs/Name.md +++ b/samples/client/petstore/javascript-promise/docs/Name.md @@ -4,5 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] +**snakeCase** | **Integer** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/PetApi.md b/samples/client/petstore/javascript-promise/docs/PetApi.md index 9e14ea0c815..77d9630f888 100644 --- a/samples/client/petstore/javascript-promise/docs/PetApi.md +++ b/samples/client/petstore/javascript-promise/docs/PetApi.md @@ -1,4 +1,3 @@ - # SwaggerPetstore.PetApi All URIs are relative to *http://petstore.swagger.io/v2* @@ -35,12 +34,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var opts = { 'body': new SwaggerPetstore.Pet() // {Pet} Pet object that needs to be added to the store }; -api.addPet(opts).then(function() { +apiInstance.addPet(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -84,12 +83,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var opts = { 'body': "B" // {String} Pet object in the form of byte array }; -api.addPetUsingByteArray(opts).then(function() { +apiInstance.addPetUsingByteArray(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -133,14 +132,14 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = 789; // {Integer} Pet id to delete var opts = { 'apiKey': "apiKey_example" // {String} }; -api.deletePet(petId, opts).then(function() { +apiInstance.deletePet(petId, opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -185,12 +184,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var opts = { 'status': ["available"] // {[String]} Status values that need to be considered for query }; -api.findPetsByStatus(opts).then(function(data) { +apiInstance.findPetsByStatus(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -234,12 +233,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var opts = { 'tags': ["tags_example"] // {[String]} Tags to filter by }; -api.findPetsByTags(opts).then(function(data) { +apiInstance.findPetsByTags(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -289,11 +288,11 @@ api_key.apiKey = "YOUR API KEY" var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = 789; // {Integer} ID of pet that needs to be fetched -api.getPetById(petId).then(function(data) { +apiInstance.getPetById(petId).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -343,11 +342,11 @@ api_key.apiKey = "YOUR API KEY" var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = 789; // {Integer} ID of pet that needs to be fetched -api.getPetByIdInObject(petId).then(function(data) { +apiInstance.getPetByIdInObject(petId).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -397,11 +396,11 @@ api_key.apiKey = "YOUR API KEY" var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = 789; // {Integer} ID of pet that needs to be fetched -api.petPetIdtestingByteArraytrueGet(petId).then(function(data) { +apiInstance.petPetIdtestingByteArraytrueGet(petId).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -445,12 +444,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var opts = { 'body': new SwaggerPetstore.Pet() // {Pet} Pet object that needs to be added to the store }; -api.updatePet(opts).then(function() { +apiInstance.updatePet(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -494,7 +493,7 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = "petId_example"; // {String} ID of pet that needs to be updated @@ -502,7 +501,7 @@ var opts = { 'name': "name_example", // {String} Updated name of the pet 'status': "status_example" // {String} Updated status of the pet }; -api.updatePetWithForm(petId, opts).then(function() { +apiInstance.updatePetWithForm(petId, opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -548,7 +547,7 @@ var defaultClient = SwaggerPetstore.ApiClient.default; var petstore_auth = defaultClient.authentications['petstore_auth']; petstore_auth.accessToken = "YOUR ACCESS TOKEN" -var api = new SwaggerPetstore.PetApi() +var apiInstance = new SwaggerPetstore.PetApi() var petId = 789; // {Integer} ID of pet to update @@ -556,7 +555,7 @@ var opts = { 'additionalMetadata': "additionalMetadata_example", // {String} Additional data to pass to server 'file': "/path/to/file.txt" // {File} file to upload }; -api.uploadFile(petId, opts).then(function() { +apiInstance.uploadFile(petId, opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); diff --git a/samples/client/petstore/javascript-promise/docs/StoreApi.md b/samples/client/petstore/javascript-promise/docs/StoreApi.md index 53e4ffd5bc2..930586a96f5 100644 --- a/samples/client/petstore/javascript-promise/docs/StoreApi.md +++ b/samples/client/petstore/javascript-promise/docs/StoreApi.md @@ -1,4 +1,3 @@ - # SwaggerPetstore.StoreApi All URIs are relative to *http://petstore.swagger.io/v2* @@ -25,11 +24,11 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.StoreApi() +var apiInstance = new SwaggerPetstore.StoreApi() var orderId = "orderId_example"; // {String} ID of the order that needs to be deleted -api.deleteOrder(orderId).then(function() { +apiInstance.deleteOrder(orderId).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -81,12 +80,12 @@ test_api_client_secret.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //test_api_client_secret.apiKeyPrefix['x-test_api_client_secret'] = "Token" -var api = new SwaggerPetstore.StoreApi() +var apiInstance = new SwaggerPetstore.StoreApi() var opts = { 'status': "placed" // {String} Status value that needs to be considered for query }; -api.findOrdersByStatus(opts).then(function(data) { +apiInstance.findOrdersByStatus(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -132,8 +131,8 @@ api_key.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix['api_key'] = "Token" -var api = new SwaggerPetstore.StoreApi() -api.getInventory().then(function(data) { +var apiInstance = new SwaggerPetstore.StoreApi() +apiInstance.getInventory().then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -176,8 +175,8 @@ api_key.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //api_key.apiKeyPrefix['api_key'] = "Token" -var api = new SwaggerPetstore.StoreApi() -api.getInventoryInObject().then(function(data) { +var apiInstance = new SwaggerPetstore.StoreApi() +apiInstance.getInventoryInObject().then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -226,11 +225,11 @@ test_api_key_query.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //test_api_key_query.apiKeyPrefix['test_api_key_query'] = "Token" -var api = new SwaggerPetstore.StoreApi() +var apiInstance = new SwaggerPetstore.StoreApi() var orderId = "orderId_example"; // {String} ID of pet that needs to be fetched -api.getOrderById(orderId).then(function(data) { +apiInstance.getOrderById(orderId).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -282,12 +281,12 @@ test_api_client_secret.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //test_api_client_secret.apiKeyPrefix['x-test_api_client_secret'] = "Token" -var api = new SwaggerPetstore.StoreApi() +var apiInstance = new SwaggerPetstore.StoreApi() var opts = { 'body': new SwaggerPetstore.Order() // {Order} order placed for purchasing the pet }; -api.placeOrder(opts).then(function(data) { +apiInstance.placeOrder(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); diff --git a/samples/client/petstore/javascript-promise/docs/UserApi.md b/samples/client/petstore/javascript-promise/docs/UserApi.md index 1a401b698db..1c14b708231 100644 --- a/samples/client/petstore/javascript-promise/docs/UserApi.md +++ b/samples/client/petstore/javascript-promise/docs/UserApi.md @@ -26,12 +26,12 @@ This can only be done by the logged in user. ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var opts = { 'body': new SwaggerPetstore.User() // {User} Created user object }; -api.createUser(opts).then(function() { +apiInstance.createUser(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -70,12 +70,12 @@ Creates list of users with given input array ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var opts = { 'body': [new SwaggerPetstore.User()] // {[User]} List of user object }; -api.createUsersWithArrayInput(opts).then(function() { +apiInstance.createUsersWithArrayInput(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -114,12 +114,12 @@ Creates list of users with given input array ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var opts = { 'body': [new SwaggerPetstore.User()] // {[User]} List of user object }; -api.createUsersWithListInput(opts).then(function() { +apiInstance.createUsersWithListInput(opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -164,11 +164,11 @@ var test_http_basic = defaultClient.authentications['test_http_basic']; test_http_basic.username = 'YOUR USERNAME' test_http_basic.password = 'YOUR PASSWORD' -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var username = "username_example"; // {String} The name that needs to be deleted -api.deleteUser(username).then(function() { +apiInstance.deleteUser(username).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -207,11 +207,11 @@ Get user by user name ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var username = "username_example"; // {String} The name that needs to be fetched. Use user1 for testing. -api.getUserByName(username).then(function(data) { +apiInstance.getUserByName(username).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -250,13 +250,13 @@ Logs user into the system ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var opts = { 'username': "username_example", // {String} The user name for login 'password': "password_example" // {String} The password for login in clear text }; -api.loginUser(opts).then(function(data) { +apiInstance.loginUser(opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -296,8 +296,8 @@ Logs out current logged in user session ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() -api.logoutUser().then(function() { +var apiInstance = new SwaggerPetstore.UserApi() +apiInstance.logoutUser().then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); @@ -333,14 +333,14 @@ This can only be done by the logged in user. ```javascript var SwaggerPetstore = require('swagger-petstore'); -var api = new SwaggerPetstore.UserApi() +var apiInstance = new SwaggerPetstore.UserApi() var username = "username_example"; // {String} name that need to be deleted var opts = { 'body': new SwaggerPetstore.User() // {User} Updated user object }; -api.updateUser(username, opts).then(function() { +apiInstance.updateUser(username, opts).then(function() { console.log('API called successfully.'); }, function(error) { console.error(error); diff --git a/samples/client/petstore/javascript-promise/src/api/PetApi.js b/samples/client/petstore/javascript-promise/src/api/PetApi.js index 6166cf35cb1..520791b3f0a 100644 --- a/samples/client/petstore/javascript-promise/src/api/PetApi.js +++ b/samples/client/petstore/javascript-promise/src/api/PetApi.js @@ -25,7 +25,7 @@ * Constructs a new PetApi. * @alias module:api/PetApi * @class - * @param {module:ApiClient} apiClient Optional API client implementation to use, defaulting to {@link module:ApiClient#instance} + * @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance} * if unspecified. */ var exports = function(apiClient) { @@ -144,7 +144,7 @@ * Finds Pets by status * Multiple status values can be provided with comma separated strings * @param {Object} opts Optional parameters - * @param {Array.} opts.status Status values that need to be considered for query + * @param {Array.} opts.status Status values that need to be considered for query (default to available) * data is of type: {Array.} */ this.findPetsByStatus = function(opts) { diff --git a/samples/client/petstore/javascript-promise/src/api/StoreApi.js b/samples/client/petstore/javascript-promise/src/api/StoreApi.js index c94b6c8169c..32a6dce47e9 100644 --- a/samples/client/petstore/javascript-promise/src/api/StoreApi.js +++ b/samples/client/petstore/javascript-promise/src/api/StoreApi.js @@ -25,7 +25,7 @@ * Constructs a new StoreApi. * @alias module:api/StoreApi * @class - * @param {module:ApiClient} apiClient Optional API client implementation to use, defaulting to {@link module:ApiClient#instance} + * @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance} * if unspecified. */ var exports = function(apiClient) { @@ -40,11 +40,6 @@ */ this.deleteOrder = function(orderId) { var postBody = null; - // verify the required parameter 'orderId' is set - if (orderId == null) { - throw "Missing the required parameter 'orderId' when calling deleteOrder"; - } - // verify the required parameter 'orderId' is set if (orderId == undefined || orderId == null) { @@ -79,7 +74,7 @@ * Finds orders by status * A single status value can be provided as a string * @param {Object} opts Optional parameters - * @param {module:model/String} opts.status Status value that needs to be considered for query + * @param {module:model/String} opts.status Status value that needs to be considered for query (default to placed) * data is of type: {Array.} */ this.findOrdersByStatus = function(opts) { diff --git a/samples/client/petstore/javascript-promise/src/api/UserApi.js b/samples/client/petstore/javascript-promise/src/api/UserApi.js index b869274285c..8914d9c883d 100644 --- a/samples/client/petstore/javascript-promise/src/api/UserApi.js +++ b/samples/client/petstore/javascript-promise/src/api/UserApi.js @@ -25,7 +25,7 @@ * Constructs a new UserApi. * @alias module:api/UserApi * @class - * @param {module:ApiClient} apiClient Optional API client implementation to use, defaulting to {@link module:ApiClient#instance} + * @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance} * if unspecified. */ var exports = function(apiClient) { @@ -139,11 +139,6 @@ */ this.deleteUser = function(username) { var postBody = null; - // verify the required parameter 'username' is set - if (username == null) { - throw "Missing the required parameter 'username' when calling deleteUser"; - } - // verify the required parameter 'username' is set if (username == undefined || username == null) { @@ -182,11 +177,6 @@ */ this.getUserByName = function(username) { var postBody = null; - // verify the required parameter 'username' is set - if (username == null) { - throw "Missing the required parameter 'username' when calling getUserByName"; - } - // verify the required parameter 'username' is set if (username == undefined || username == null) { diff --git a/samples/client/petstore/javascript-promise/src/model/Name.js b/samples/client/petstore/javascript-promise/src/model/Name.js index 20aa186bd97..a5a070025f7 100644 --- a/samples/client/petstore/javascript-promise/src/model/Name.js +++ b/samples/client/petstore/javascript-promise/src/model/Name.js @@ -29,6 +29,7 @@ var exports = function() { + }; /** @@ -45,6 +46,9 @@ if (data.hasOwnProperty('name')) { obj['name'] = ApiClient.convertToType(data['name'], 'Integer'); } + if (data.hasOwnProperty('snake_case')) { + obj['snake_case'] = ApiClient.convertToType(data['snake_case'], 'Integer'); + } } return obj; } @@ -55,6 +59,11 @@ */ exports.prototype['name'] = undefined; + /** + * @member {Integer} snake_case + */ + exports.prototype['snake_case'] = undefined; + diff --git a/samples/client/petstore/javascript/README.md b/samples/client/petstore/javascript/README.md index 268b09738f5..2f3f0edb897 100644 --- a/samples/client/petstore/javascript/README.md +++ b/samples/client/petstore/javascript/README.md @@ -6,7 +6,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/ - API verion: 1.0.0 - Package version: 1.0.0 -- Build date: 2016-03-18T18:26:17.121+08:00 +- Build date: 2016-03-24T19:50:27.240+08:00 - Build package: class io.swagger.codegen.languages.JavascriptClientCodegen ## Installation diff --git a/samples/client/petstore/javascript/docs/Name.md b/samples/client/petstore/javascript/docs/Name.md index 114d6dc980e..5086f6c5a3e 100644 --- a/samples/client/petstore/javascript/docs/Name.md +++ b/samples/client/petstore/javascript/docs/Name.md @@ -4,5 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] +**snakeCase** | **Integer** | | [optional] diff --git a/samples/client/petstore/javascript/src/api/PetApi.js b/samples/client/petstore/javascript/src/api/PetApi.js index dc847f464cf..3bfc6ffd4f0 100644 --- a/samples/client/petstore/javascript/src/api/PetApi.js +++ b/samples/client/petstore/javascript/src/api/PetApi.js @@ -25,11 +25,7 @@ * Constructs a new PetApi. * @alias module:api/PetApi * @class -<<<<<<< HEAD - * @param {module:ApiClient} apiClient Optional API client implementation to use, defaulting to {@link module:ApiClient#instance} -======= * @param {module:ApiClient} apiClient Optional API client implementation to use, default to {@link module:ApiClient#instance} ->>>>>>> update js doc * if unspecified. */ var exports = function(apiClient) { @@ -179,11 +175,7 @@ * Finds Pets by status * Multiple status values can be provided with comma separated strings * @param {Object} opts Optional parameters -<<<<<<< HEAD - * @param {Array.} opts.status Status values that need to be considered for query -======= * @param {Array.} opts.status Status values that need to be considered for query (default to available) ->>>>>>> update js doc * @param {module:api/PetApi~findPetsByStatusCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {Array.} */ diff --git a/samples/client/petstore/javascript/src/model/Name.js b/samples/client/petstore/javascript/src/model/Name.js index 20aa186bd97..a5a070025f7 100644 --- a/samples/client/petstore/javascript/src/model/Name.js +++ b/samples/client/petstore/javascript/src/model/Name.js @@ -29,6 +29,7 @@ var exports = function() { + }; /** @@ -45,6 +46,9 @@ if (data.hasOwnProperty('name')) { obj['name'] = ApiClient.convertToType(data['name'], 'Integer'); } + if (data.hasOwnProperty('snake_case')) { + obj['snake_case'] = ApiClient.convertToType(data['snake_case'], 'Integer'); + } } return obj; } @@ -55,6 +59,11 @@ */ exports.prototype['name'] = undefined; + /** + * @member {Integer} snake_case + */ + exports.prototype['snake_case'] = undefined; +