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

update wording related to git

Browse Source
This commit is contained in:
wing328
2016-04-30 20:23:35 +08:00
parent 83567861e0
commit 7f09a86a1e
13 changed files with 88 additions and 650 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
modules/swagger-codegen/src/main/java/io/swagger/codegen/config/CodegenConfigurator.java
View File

@@ -60,8 +60,8 @@ public class CodegenConfigurator {
private Map<String, String> additionalProperties = new HashMap<String, String>();
private Map<String, String> importMappings = new HashMap<String, String>();
private Set<String> languageSpecificPrimitives = new HashSet<String>();
private String gitUserId="YOUR_GIT_USR_ID";
private String gitRepoId="YOUR_GIT_REPO_ID";
private String gitUserId="GIT_USER_ID";
private String gitRepoId="GIT_REPO_ID";
private String releaseNote="Minor update";
private String httpUserAgent;

48
samples/client/petstore/javascript-promise/README.md
View File

@@ -6,7 +6,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-04-11T22:19:40.915+08:00
- Build date: 2016-04-30T20:22:59.696+08:00
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
## Installation
@@ -27,11 +27,11 @@ npm install swagger-petstore --save
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/YOUR_GIT_REPO_ID
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
```shell
npm install YOUR_USERNAME/YOUR_GIT_REPO_ID --save
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
@@ -80,20 +80,15 @@ All URIs are relative to *http://petstore.swagger.io/v2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SwaggerPetstore.PetApi* | [**addPet**](docs/PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
*SwaggerPetstore.PetApi* | [**addPetUsingByteArray**](docs/PetApi.md#addPetUsingByteArray) | **POST** /pet?testing_byte_array&#x3D;true | Fake endpoint to test byte array in body parameter for adding a new pet to the store
*SwaggerPetstore.PetApi* | [**deletePet**](docs/PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
*SwaggerPetstore.PetApi* | [**findPetsByStatus**](docs/PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status
*SwaggerPetstore.PetApi* | [**findPetsByTags**](docs/PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags
*SwaggerPetstore.PetApi* | [**getPetById**](docs/PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID
*SwaggerPetstore.PetApi* | [**getPetByIdInObject**](docs/PetApi.md#getPetByIdInObject) | **GET** /pet/{petId}?response&#x3D;inline_arbitrary_object | Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39;
*SwaggerPetstore.PetApi* | [**petPetIdtestingByteArraytrueGet**](docs/PetApi.md#petPetIdtestingByteArraytrueGet) | **GET** /pet/{petId}?testing_byte_array&#x3D;true | Fake endpoint to test byte array return by &#39;Find pet by ID&#39;
*SwaggerPetstore.PetApi* | [**updatePet**](docs/PetApi.md#updatePet) | **PUT** /pet | Update an existing pet
*SwaggerPetstore.PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
*SwaggerPetstore.PetApi* | [**uploadFile**](docs/PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
*SwaggerPetstore.StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
*SwaggerPetstore.StoreApi* | [**findOrdersByStatus**](docs/StoreApi.md#findOrdersByStatus) | **GET** /store/findByStatus | Finds orders by status
*SwaggerPetstore.StoreApi* | [**getInventory**](docs/StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
*SwaggerPetstore.StoreApi* | [**getInventoryInObject**](docs/StoreApi.md#getInventoryInObject) | **GET** /store/inventory?response&#x3D;arbitrary_object | Fake endpoint to test arbitrary object return by &#39;Get inventory&#39;
*SwaggerPetstore.StoreApi* | [**getOrderById**](docs/StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
*SwaggerPetstore.StoreApi* | [**placeOrder**](docs/StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
*SwaggerPetstore.UserApi* | [**createUser**](docs/UserApi.md#createUser) | **POST** /user | Create user
@@ -108,18 +103,9 @@ Class | Method | HTTP request | Description
## Documentation for Models
- [SwaggerPetstore.Animal](docs/Animal.md)
- [SwaggerPetstore.Cat](docs/Cat.md)
- [SwaggerPetstore.Category](docs/Category.md)
- [SwaggerPetstore.Dog](docs/Dog.md)
- [SwaggerPetstore.FormatTest](docs/FormatTest.md)
- [SwaggerPetstore.InlineResponse200](docs/InlineResponse200.md)
- [SwaggerPetstore.Model200Response](docs/Model200Response.md)
- [SwaggerPetstore.ModelReturn](docs/ModelReturn.md)
- [SwaggerPetstore.Name](docs/Name.md)
- [SwaggerPetstore.Order](docs/Order.md)
- [SwaggerPetstore.Pet](docs/Pet.md)
- [SwaggerPetstore.SpecialModelName](docs/SpecialModelName.md)
- [SwaggerPetstore.Tag](docs/Tag.md)
- [SwaggerPetstore.User](docs/User.md)
@@ -127,40 +113,12 @@ Class | Method | HTTP request | Description
## Documentation for Authorization
### test_api_key_header
- **Type**: API key
- **API key parameter name**: test_api_key_header
- **Location**: HTTP header
### api_key
- **Type**: API key
- **API key parameter name**: api_key
- **Location**: HTTP header
### test_http_basic
- **Type**: HTTP basic authentication
### test_api_client_secret
- **Type**: API key
- **API key parameter name**: x-test_api_client_secret
- **Location**: HTTP header
### test_api_client_id
- **Type**: API key
- **API key parameter name**: x-test_api_client_id
- **Location**: HTTP header
### test_api_key_query
- **Type**: API key
- **API key parameter name**: test_api_key_query
- **Location**: URL query string
### petstore_auth
- **Type**: OAuth

226
samples/client/petstore/javascript-promise/docs/PetApi.md
View File

@@ -5,13 +5,10 @@ All URIs are relative to *http://petstore.swagger.io/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**addPet**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
[**addPetUsingByteArray**](PetApi.md#addPetUsingByteArray) | **POST** /pet?testing_byte_array&#x3D;true | Fake endpoint to test byte array in body parameter for adding a new pet to the store
[**deletePet**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
[**findPetsByStatus**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status
[**findPetsByTags**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags
[**getPetById**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID
[**getPetByIdInObject**](PetApi.md#getPetByIdInObject) | **GET** /pet/{petId}?response&#x3D;inline_arbitrary_object | Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39;
[**petPetIdtestingByteArraytrueGet**](PetApi.md#petPetIdtestingByteArraytrueGet) | **GET** /pet/{petId}?testing_byte_array&#x3D;true | Fake endpoint to test byte array return by &#39;Find pet by ID&#39;
[**updatePet**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet
[**updatePetWithForm**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data
[**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image
@@ -32,12 +29,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = 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
'body': new SwaggerPetstore.Pet() // Pet | Pet object that needs to be added to the store
};
apiInstance.addPet(opts).then(function() {
console.log('API called successfully.');
@@ -61,55 +58,6 @@ null (empty response body)
[petstore_auth](../README.md#petstore_auth)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: application/json, application/xml
<a name="addPetUsingByteArray"></a>
# **addPetUsingByteArray**
> addPetUsingByteArray(opts)
Fake endpoint to test byte array in body parameter for adding a new pet to the store
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
var apiInstance = new SwaggerPetstore.PetApi()
var opts = {
'body': "B" // {String} Pet object in the form of byte array
};
apiInstance.addPetUsingByteArray(opts).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **String**| Pet object in the form of byte array | [optional]
### Return type
null (empty response body)
### Authorization
[petstore_auth](../README.md#petstore_auth)
### HTTP request headers
- **Content-Type**: application/json, application/xml
@@ -130,14 +78,14 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var petId = 789; // {Integer} Pet id to delete
var petId = 789; // Integer | Pet id to delete
var opts = {
'apiKey': "apiKey_example" // {String}
'apiKey': "apiKey_example" // String |
};
apiInstance.deletePet(petId, opts).then(function() {
console.log('API called successfully.');
@@ -173,7 +121,7 @@ null (empty response body)
Finds Pets by status
Multiple status values can be provided with comma separated strings
Multiple status values can be provided with comma seperated strings
### Example
```javascript
@@ -182,12 +130,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var opts = {
'status': ["available"] // {[String]} Status values that need to be considered for query
'status': ["available"] // [String] | Status values that need to be considered for filter
};
apiInstance.findPetsByStatus(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -201,7 +149,7 @@ apiInstance.findPetsByStatus(opts).then(function(data) {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**[String]**](String.md)| Status values that need to be considered for query | [optional] [default to available]
**status** | [**[String]**](String.md)| Status values that need to be considered for filter | [optional] [default to available]
### Return type
@@ -231,12 +179,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var opts = {
'tags': ["tags_example"] // {[String]} Tags to filter by
'tags': ["tags_example"] // [String] | Tags to filter by
};
apiInstance.findPetsByTags(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -280,17 +228,17 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
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"
//api_key.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var petId = 789; // {Integer} ID of pet that needs to be fetched
var petId = 789; // Integer | ID of pet that needs to be fetched
apiInstance.getPetById(petId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -314,114 +262,6 @@ Name | Type | Description | Notes
[api_key](../README.md#api_key), [petstore_auth](../README.md#petstore_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
<a name="getPetByIdInObject"></a>
# **getPetByIdInObject**
> InlineResponse200 getPetByIdInObject(petId)
Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39;
Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
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"
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
var apiInstance = new SwaggerPetstore.PetApi()
var petId = 789; // {Integer} ID of pet that needs to be fetched
apiInstance.getPetByIdInObject(petId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Integer**| ID of pet that needs to be fetched |
### Return type
[**InlineResponse200**](InlineResponse200.md)
### Authorization
[api_key](../README.md#api_key), [petstore_auth](../README.md#petstore_auth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
<a name="petPetIdtestingByteArraytrueGet"></a>
# **petPetIdtestingByteArraytrueGet**
> &#39;String&#39; petPetIdtestingByteArraytrueGet(petId)
Fake endpoint to test byte array return by &#39;Find pet by ID&#39;
Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
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"
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
var apiInstance = new SwaggerPetstore.PetApi()
var petId = 789; // {Integer} ID of pet that needs to be fetched
apiInstance.petPetIdtestingByteArraytrueGet(petId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Integer**| ID of pet that needs to be fetched |
### Return type
**&#39;String&#39;**
### Authorization
[api_key](../README.md#api_key), [petstore_auth](../README.md#petstore_auth)
### HTTP request headers
- **Content-Type**: Not defined
@@ -442,12 +282,12 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = 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
'body': new SwaggerPetstore.Pet() // Pet | Pet object that needs to be added to the store
};
apiInstance.updatePet(opts).then(function() {
console.log('API called successfully.');
@@ -491,15 +331,15 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var petId = "petId_example"; // {String} ID of pet that needs to be updated
var petId = "petId_example"; // String | ID of pet that needs to be updated
var opts = {
'name': "name_example", // {String} Updated name of the pet
'status': "status_example" // {String} Updated status of the pet
'name': "name_example", // String | Updated name of the pet
'status': "status_example" // String | Updated status of the pet
};
apiInstance.updatePetWithForm(petId, opts).then(function() {
console.log('API called successfully.');
@@ -545,15 +385,15 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure OAuth2 access token for authorization: petstore_auth
var petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = "YOUR ACCESS TOKEN"
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new SwaggerPetstore.PetApi()
var apiInstance = new SwaggerPetstore.PetApi();
var petId = 789; // {Integer} ID of pet to update
var petId = 789; // Integer | ID of pet to update
var opts = {
'additionalMetadata': "additionalMetadata_example", // {String} Additional data to pass to server
'file': "/path/to/file.txt" // {File} file to upload
'additionalMetadata': "additionalMetadata_example", // String | Additional data to pass to server
'file': "/path/to/file.txt" // File | file to upload
};
apiInstance.uploadFile(petId, opts).then(function() {
console.log('API called successfully.');

153
samples/client/petstore/javascript-promise/docs/StoreApi.md
View File

@@ -5,9 +5,7 @@ All URIs are relative to *http://petstore.swagger.io/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
[**findOrdersByStatus**](StoreApi.md#findOrdersByStatus) | **GET** /store/findByStatus | Finds orders by status
[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
[**getInventoryInObject**](StoreApi.md#getInventoryInObject) | **GET** /store/inventory?response&#x3D;arbitrary_object | Fake endpoint to test arbitrary object return by &#39;Get inventory&#39;
[**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{orderId} | Find purchase order by ID
[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
@@ -24,9 +22,9 @@ For valid response try integer IDs with value &lt; 1000. Anything above 1000 or
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.StoreApi()
var apiInstance = new SwaggerPetstore.StoreApi();
var orderId = "orderId_example"; // {String} ID of the order that needs to be deleted
var orderId = "orderId_example"; // String | ID of the order that needs to be deleted
apiInstance.deleteOrder(orderId).then(function() {
console.log('API called successfully.');
@@ -50,63 +48,6 @@ null (empty response body)
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
<a name="findOrdersByStatus"></a>
# **findOrdersByStatus**
> [Order] findOrdersByStatus(opts)
Finds orders by status
A single status value can be provided as a string
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: test_api_client_id
var test_api_client_id = defaultClient.authentications['test_api_client_id'];
test_api_client_id.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_id.apiKeyPrefix['x-test_api_client_id'] = "Token"
// Configure API key authorization: test_api_client_secret
var test_api_client_secret = defaultClient.authentications['test_api_client_secret'];
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 apiInstance = new SwaggerPetstore.StoreApi()
var opts = {
'status': "placed" // {String} Status value that needs to be considered for query
};
apiInstance.findOrdersByStatus(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **String**| Status value that needs to be considered for query | [optional] [default to placed]
### Return type
[**[Order]**](Order.md)
### Authorization
[test_api_client_id](../README.md#test_api_client_id), [test_api_client_secret](../README.md#test_api_client_secret)
### HTTP request headers
- **Content-Type**: Not defined
@@ -114,7 +55,7 @@ Name | Type | Description | Notes
<a name="getInventory"></a>
# **getInventory**
> {&#39;String&#39;: &#39;Integer&#39;} getInventory
> {&#39;String&#39;: &#39;Integer&#39;} getInventory()
Returns pet inventories by status
@@ -127,11 +68,11 @@ var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
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"
//api_key.apiKeyPrefix = 'Token';
var apiInstance = new SwaggerPetstore.StoreApi()
var apiInstance = new SwaggerPetstore.StoreApi();
apiInstance.getInventory().then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
@@ -151,50 +92,6 @@ This endpoint does not need any parameter.
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
<a name="getInventoryInObject"></a>
# **getInventoryInObject**
> Object getInventoryInObject
Fake endpoint to test arbitrary object return by &#39;Get inventory&#39;
Returns an arbitrary object which is actually a map of status codes to quantities
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
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 apiInstance = new SwaggerPetstore.StoreApi()
apiInstance.getInventoryInObject().then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
**Object**
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
@@ -211,23 +108,10 @@ For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other val
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: test_api_key_header
var test_api_key_header = defaultClient.authentications['test_api_key_header'];
test_api_key_header.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_header.apiKeyPrefix['test_api_key_header'] = "Token"
var apiInstance = new SwaggerPetstore.StoreApi();
// Configure API key authorization: test_api_key_query
var test_api_key_query = defaultClient.authentications['test_api_key_query'];
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 apiInstance = new SwaggerPetstore.StoreApi()
var orderId = "orderId_example"; // {String} ID of pet that needs to be fetched
var orderId = "orderId_example"; // String | ID of pet that needs to be fetched
apiInstance.getOrderById(orderId).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -249,7 +133,7 @@ Name | Type | Description | Notes
### Authorization
[test_api_key_header](../README.md#test_api_key_header), [test_api_key_query](../README.md#test_api_key_query)
No authorization required
### HTTP request headers
@@ -267,24 +151,11 @@ Place an order for a pet
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure API key authorization: test_api_client_id
var test_api_client_id = defaultClient.authentications['test_api_client_id'];
test_api_client_id.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_id.apiKeyPrefix['x-test_api_client_id'] = "Token"
// Configure API key authorization: test_api_client_secret
var test_api_client_secret = defaultClient.authentications['test_api_client_secret'];
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 apiInstance = new SwaggerPetstore.StoreApi()
var apiInstance = new SwaggerPetstore.StoreApi();
var opts = {
'body': new SwaggerPetstore.Order() // {Order} order placed for purchasing the pet
'body': new SwaggerPetstore.Order() // Order | order placed for purchasing the pet
};
apiInstance.placeOrder(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -306,7 +177,7 @@ Name | Type | Description | Notes
### Authorization
[test_api_client_id](../README.md#test_api_client_id), [test_api_client_secret](../README.md#test_api_client_secret)
No authorization required
### HTTP request headers

44
samples/client/petstore/javascript-promise/docs/UserApi.md
View File

@@ -26,10 +26,10 @@ This can only be done by the logged in user.
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
var opts = {
'body': new SwaggerPetstore.User() // {User} Created user object
'body': new SwaggerPetstore.User() // User | Created user object
};
apiInstance.createUser(opts).then(function() {
console.log('API called successfully.');
@@ -70,10 +70,10 @@ Creates list of users with given input array
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
var opts = {
'body': [new SwaggerPetstore.User()] // {[User]} List of user object
'body': [new SwaggerPetstore.User()] // [User] | List of user object
};
apiInstance.createUsersWithArrayInput(opts).then(function() {
console.log('API called successfully.');
@@ -114,10 +114,10 @@ Creates list of users with given input array
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
var opts = {
'body': [new SwaggerPetstore.User()] // {[User]} List of user object
'body': [new SwaggerPetstore.User()] // [User] | List of user object
};
apiInstance.createUsersWithListInput(opts).then(function() {
console.log('API called successfully.');
@@ -157,16 +157,10 @@ This can only be done by the logged in user.
### Example
```javascript
var SwaggerPetstore = require('swagger-petstore');
var defaultClient = SwaggerPetstore.ApiClient.default;
// Configure HTTP basic authorization: test_http_basic
var test_http_basic = defaultClient.authentications['test_http_basic'];
test_http_basic.username = 'YOUR USERNAME'
test_http_basic.password = 'YOUR PASSWORD'
var apiInstance = new SwaggerPetstore.UserApi();
var apiInstance = new SwaggerPetstore.UserApi()
var username = "username_example"; // {String} The name that needs to be deleted
var username = "username_example"; // String | The name that needs to be deleted
apiInstance.deleteUser(username).then(function() {
console.log('API called successfully.');
@@ -188,7 +182,7 @@ null (empty response body)
### Authorization
[test_http_basic](../README.md#test_http_basic)
No authorization required
### HTTP request headers
@@ -207,9 +201,9 @@ Get user by user name
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
var username = "username_example"; // {String} The name that needs to be fetched. Use user1 for testing.
var username = "username_example"; // String | The name that needs to be fetched. Use user1 for testing.
apiInstance.getUserByName(username).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -250,11 +244,11 @@ Logs user into the system
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = 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
'username': "username_example", // String | The user name for login
'password': "password_example" // String | The password for login in clear text
};
apiInstance.loginUser(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
@@ -286,7 +280,7 @@ No authorization required
<a name="logoutUser"></a>
# **logoutUser**
> logoutUser
> logoutUser()
Logs out current logged in user session
@@ -296,7 +290,7 @@ Logs out current logged in user session
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
apiInstance.logoutUser().then(function() {
console.log('API called successfully.');
}, function(error) {
@@ -333,12 +327,12 @@ This can only be done by the logged in user.
```javascript
var SwaggerPetstore = require('swagger-petstore');
var apiInstance = new SwaggerPetstore.UserApi()
var apiInstance = new SwaggerPetstore.UserApi();
var username = "username_example"; // {String} name that need to be deleted
var username = "username_example"; // String | name that need to be deleted
var opts = {
'body': new SwaggerPetstore.User() // {User} Updated user object
'body': new SwaggerPetstore.User() // User | Updated user object
};
apiInstance.updateUser(username, opts).then(function() {
console.log('API called successfully.');

4
samples/client/petstore/javascript-promise/git_push.sh
View File

@@ -8,12 +8,12 @@ git_repo_id=$2
release_note=$3
if [ "$git_user_id" = "" ]; then
git_user_id="YOUR_GIT_USR_ID"
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="YOUR_GIT_REPO_ID"
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi

5
samples/client/petstore/javascript-promise/src/ApiClient.js
View File

@@ -40,12 +40,7 @@
* @type {Array.<String>}
*/
this.authentications = {
'test_api_key_header': {type: 'apiKey', 'in': 'header', name: 'test_api_key_header'},
'api_key': {type: 'apiKey', 'in': 'header', name: 'api_key'},
'test_http_basic': {type: 'basic'},
'test_api_client_secret': {type: 'apiKey', 'in': 'header', name: 'x-test_api_client_secret'},
'test_api_client_id': {type: 'apiKey', 'in': 'header', name: 'x-test_api_client_id'},
'test_api_key_query': {type: 'apiKey', 'in': 'query', name: 'test_api_key_query'},
'petstore_auth': {type: 'oauth2'}
};
/**

121
samples/client/petstore/javascript-promise/src/api/PetApi.js
View File

@@ -1,18 +1,18 @@
(function(root, factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['../ApiClient', '../model/Pet', '../model/InlineResponse200'], factory);
define(['../ApiClient', '../model/Pet'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('../ApiClient'), require('../model/Pet'), require('../model/InlineResponse200'));
module.exports = factory(require('../ApiClient'), require('../model/Pet'));
} else {
// Browser globals (root is window)
if (!root.SwaggerPetstore) {
root.SwaggerPetstore = {};
}
root.SwaggerPetstore.PetApi = factory(root.SwaggerPetstore.ApiClient, root.SwaggerPetstore.Pet, root.SwaggerPetstore.InlineResponse200);
root.SwaggerPetstore.PetApi = factory(root.SwaggerPetstore.ApiClient, root.SwaggerPetstore.Pet);
}
}(this, function(ApiClient, Pet, InlineResponse200) {
}(this, function(ApiClient, Pet) {
'use strict';
/**
@@ -66,39 +66,6 @@
}
/**
* Fake endpoint to test byte array in body parameter for adding a new pet to the store
*
* @param {Object} opts Optional parameters
* @param {String} opts.body Pet object in the form of byte array
*/
this.addPetUsingByteArray = function(opts) {
opts = opts || {};
var postBody = opts['body'];
var pathParams = {
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['petstore_auth'];
var contentTypes = ['application/json', 'application/xml'];
var accepts = ['application/json', 'application/xml'];
var returnType = null;
return this.apiClient.callApi(
'/pet?testing_byte_array=true', 'POST',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Deletes a pet
*
@@ -142,9 +109,9 @@
/**
* Finds Pets by status
* Multiple status values can be provided with comma separated strings
* Multiple status values can be provided with comma seperated strings
* @param {Object} opts Optional parameters
* @param {Array.<String>} opts.status Status values that need to be considered for query (default to available)
* @param {Array.<String>} opts.status Status values that need to be considered for filter (default to available)
* data is of type: {Array.<module:model/Pet>}
*/
this.findPetsByStatus = function(opts) {
@@ -248,82 +215,6 @@
}
/**
* Fake endpoint to test inline arbitrary object return by &#39;Find pet by ID&#39;
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* @param {Integer} petId ID of pet that needs to be fetched
* data is of type: {module:model/InlineResponse200}
*/
this.getPetByIdInObject = function(petId) {
var postBody = null;
// verify the required parameter 'petId' is set
if (petId == undefined || petId == null) {
throw "Missing the required parameter 'petId' when calling getPetByIdInObject";
}
var pathParams = {
'petId': petId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['api_key', 'petstore_auth'];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = InlineResponse200;
return this.apiClient.callApi(
'/pet/{petId}?response=inline_arbitrary_object', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Fake endpoint to test byte array return by &#39;Find pet by ID&#39;
* Returns a pet when ID &lt; 10. ID &gt; 10 or nonintegers will simulate API error conditions
* @param {Integer} petId ID of pet that needs to be fetched
* data is of type: {'String'}
*/
this.petPetIdtestingByteArraytrueGet = function(petId) {
var postBody = null;
// verify the required parameter 'petId' is set
if (petId == undefined || petId == null) {
throw "Missing the required parameter 'petId' when calling petPetIdtestingByteArraytrueGet";
}
var pathParams = {
'petId': petId
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['api_key', 'petstore_auth'];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = 'String';
return this.apiClient.callApi(
'/pet/{petId}?testing_byte_array=true', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Update an existing pet
*

70
samples/client/petstore/javascript-promise/src/api/StoreApi.js
View File

@@ -70,41 +70,6 @@
}
/**
* 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 (default to placed)
* data is of type: {Array.<module:model/Order>}
*/
this.findOrdersByStatus = function(opts) {
opts = opts || {};
var postBody = null;
var pathParams = {
};
var queryParams = {
'status': opts['status']
};
var headerParams = {
};
var formParams = {
};
var authNames = ['test_api_client_id', 'test_api_client_secret'];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = [Order];
return this.apiClient.callApi(
'/store/findByStatus', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Returns pet inventories by status
* Returns a map of status codes to quantities
@@ -136,37 +101,6 @@
}
/**
* Fake endpoint to test arbitrary object return by &#39;Get inventory&#39;
* Returns an arbitrary object which is actually a map of status codes to quantities
* data is of type: {Object}
*/
this.getInventoryInObject = function() {
var postBody = null;
var pathParams = {
};
var queryParams = {
};
var headerParams = {
};
var formParams = {
};
var authNames = ['api_key'];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = Object;
return this.apiClient.callApi(
'/store/inventory?response=arbitrary_object', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authNames, contentTypes, accepts, returnType
);
}
/**
* Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
@@ -192,7 +126,7 @@
var formParams = {
};
var authNames = ['test_api_key_header', 'test_api_key_query'];
var authNames = [];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = Order;
@@ -226,7 +160,7 @@
var formParams = {
};
var authNames = ['test_api_client_id', 'test_api_client_secret'];
var authNames = [];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = Order;

2
samples/client/petstore/javascript-promise/src/api/UserApi.js
View File

@@ -156,7 +156,7 @@
var formParams = {
};
var authNames = ['test_http_basic'];
var authNames = [];
var contentTypes = [];
var accepts = ['application/json', 'application/xml'];
var returnType = null;

51
samples/client/petstore/javascript-promise/src/index.js
View File

@@ -1,12 +1,12 @@
(function(factory) {
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['./ApiClient', './model/Animal', './model/Cat', './model/Category', './model/Dog', './model/FormatTest', './model/InlineResponse200', './model/Model200Response', './model/ModelReturn', './model/Name', './model/Order', './model/Pet', './model/SpecialModelName', './model/Tag', './model/User', './api/PetApi', './api/StoreApi', './api/UserApi'], factory);
define(['./ApiClient', './model/Category', './model/Order', './model/Pet', './model/Tag', './model/User', './api/PetApi', './api/StoreApi', './api/UserApi'], factory);
} else if (typeof module === 'object' && module.exports) {
// CommonJS-like environments that support module.exports, like Node.
module.exports = factory(require('./ApiClient'), require('./model/Animal'), require('./model/Cat'), require('./model/Category'), require('./model/Dog'), require('./model/FormatTest'), require('./model/InlineResponse200'), require('./model/Model200Response'), require('./model/ModelReturn'), require('./model/Name'), require('./model/Order'), require('./model/Pet'), require('./model/SpecialModelName'), require('./model/Tag'), require('./model/User'), require('./api/PetApi'), require('./api/StoreApi'), require('./api/UserApi'));
module.exports = factory(require('./ApiClient'), require('./model/Category'), require('./model/Order'), require('./model/Pet'), require('./model/Tag'), require('./model/User'), require('./api/PetApi'), require('./api/StoreApi'), require('./api/UserApi'));
}
}(function(ApiClient, Animal, Cat, Category, Dog, FormatTest, InlineResponse200, Model200Response, ModelReturn, Name, Order, Pet, SpecialModelName, Tag, User, PetApi, StoreApi, UserApi) {
}(function(ApiClient, Category, Order, Pet, Tag, User, PetApi, StoreApi, UserApi) {
'use strict';
/**
@@ -46,51 +46,11 @@
* @property {module:ApiClient}
*/
ApiClient: ApiClient,
/**
* The Animal model constructor.
* @property {module:model/Animal}
*/
Animal: Animal,
/**
* The Cat model constructor.
* @property {module:model/Cat}
*/
Cat: Cat,
/**
* The Category model constructor.
* @property {module:model/Category}
*/
Category: Category,
/**
* The Dog model constructor.
* @property {module:model/Dog}
*/
Dog: Dog,
/**
* The FormatTest model constructor.
* @property {module:model/FormatTest}
*/
FormatTest: FormatTest,
/**
* The InlineResponse200 model constructor.
* @property {module:model/InlineResponse200}
*/
InlineResponse200: InlineResponse200,
/**
* The Model200Response model constructor.
* @property {module:model/Model200Response}
*/
Model200Response: Model200Response,
/**
* The ModelReturn model constructor.
* @property {module:model/ModelReturn}
*/
ModelReturn: ModelReturn,
/**
* The Name model constructor.
* @property {module:model/Name}
*/
Name: Name,
/**
* The Order model constructor.
* @property {module:model/Order}
@@ -101,11 +61,6 @@
* @property {module:model/Pet}
*/
Pet: Pet,
/**
* The SpecialModelName model constructor.
* @property {module:model/SpecialModelName}
*/
SpecialModelName: SpecialModelName,
/**
* The Tag model constructor.
* @property {module:model/Tag}

6
samples/client/petstore/javascript/README.md
View File

@@ -6,7 +6,7 @@ This SDK is automatically generated by the [Swagger Codegen](https://github.com/
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-04-30T20:15:39.280+08:00
- Build date: 2016-04-30T20:20:04.619+08:00
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
## Installation
@@ -27,11 +27,11 @@ npm install swagger-petstore --save
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
```shell
npm install YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID --save
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser

4
samples/client/petstore/javascript/git_push.sh
View File

@@ -8,12 +8,12 @@ git_repo_id=$2
release_note=$3
if [ "$git_user_id" = "" ]; then
git_user_id="YOUR_GIT_USR_ID"
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="YOUR_GIT_REPO_ID"
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi