mirror of
https://github.com/jlengrand/openapi-generator.git
synced 2026-03-10 08:31:23 +00:00
Adding dummy versions, my IDE crashed
This commit is contained in:
@@ -35,12 +35,25 @@ public class JetbrainsHttpClientClientCodegen extends DefaultCodegen implements
|
||||
super();
|
||||
|
||||
outputFolder = "generated-code" + File.separator + "jetbrains-http-client";
|
||||
modelTemplateFiles.put("model.mustache", ".zz");
|
||||
apiTemplateFiles.put("api.mustache", ".zz");
|
||||
modelTemplateFiles.put("model.mustache", ".http");
|
||||
apiTemplateFiles.put("api.mustache", ".http");
|
||||
embeddedTemplateDir = templateDir = "jetbrains-http-client";
|
||||
apiPackage = "Apis";
|
||||
modelPackage = "Models";
|
||||
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
|
||||
// TODO: Fill this out.
|
||||
}
|
||||
|
||||
@Override
|
||||
// protected ImmutableMap.Builder<String, Lambda> addMustacheLambdas() {
|
||||
// return super.addMustacheLambdas()
|
||||
// .put("doubleMustache", new DoubleMustache());
|
||||
// }
|
||||
//
|
||||
// private static class DoubleMustache implements Mustache.Lambda {
|
||||
// @Override
|
||||
// public void execute(final Template.Fragment fragment, final Writer writer) throws IOException {
|
||||
// writer.write(fragment.execute().replaceAll("{", "{{"));
|
||||
// }
|
||||
// }
|
||||
}
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
# # Documentation for {{appName}}
|
||||
|
||||
{{#generateApiDocs}}
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
|
||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||
{{/generateApiDocs}}
|
||||
|
||||
29
modules/openapi-generator/src/main/resources/jetbrains-http-client/api.bkp.mustache
vendored
Normal file
29
modules/openapi-generator/src/main/resources/jetbrains-http-client/api.bkp.mustache
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
# {{classname}}{{#description}}
|
||||
{{description}}{{/description}}
|
||||
All URIs are relative to *{{basePath}}*
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
|
||||
{{/operation}}{{/operations}}
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
<a name="{{operationId}}"></a>
|
||||
# **{{operationId}}**
|
||||
> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
{{summary}}{{#notes}}
|
||||
{{notes}}{{/notes}}
|
||||
### Parameters
|
||||
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
|
||||
{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}
|
||||
{{/allParams}}
|
||||
### Return type
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
|
||||
### Authorization
|
||||
{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}
|
||||
### HTTP request headers
|
||||
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
|
||||
- **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}
|
||||
{{/operation}}
|
||||
{{/operations}}
|
||||
@@ -0,0 +1,11 @@
|
||||
## {{classname}}
|
||||
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
### {{#summary}}{{summary}}{{/summary}}
|
||||
# {{operationId}}
|
||||
{{httpMethod}} {{basePath}}{{#lambda.doubleMustache}}{{path}}{{/lambda.doubleMustache}}
|
||||
|
||||
|
||||
{{/operation}}
|
||||
{{/operations}}
|
||||
@@ -0,0 +1,16 @@
|
||||
{{#models}}
|
||||
{{#model}}
|
||||
# {{{packageName}}}.{{modelPackage}}.{{{classname}}}
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#parent}}
|
||||
{{#parentVars}}
|
||||
**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{/parentVars}}
|
||||
{{/parent}}
|
||||
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{/vars}}
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
{{/model}}
|
||||
{{/models}}
|
||||
@@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
@@ -0,0 +1,10 @@
|
||||
Apis/PetApi.http
|
||||
Apis/StoreApi.http
|
||||
Apis/UserApi.http
|
||||
Models/ApiResponse.http
|
||||
Models/Category.http
|
||||
Models/Order.http
|
||||
Models/Pet.http
|
||||
Models/Tag.http
|
||||
Models/User.http
|
||||
README.md
|
||||
@@ -0,0 +1 @@
|
||||
6.3.0-SNAPSHOT
|
||||
@@ -0,0 +1,154 @@
|
||||
# PetApi
|
||||
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
|
||||
[**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
|
||||
[**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
|
||||
|
||||
<a name="addPet"></a>
|
||||
# **addPet**
|
||||
> Pet addPet(pet)
|
||||
Add a new pet to the store
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
|
||||
### Return type
|
||||
[**Pet**](Pet.md)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="deletePet"></a>
|
||||
# **deletePet**
|
||||
> deletePet(petId, apiKey)
|
||||
Deletes a pet
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**petId** | **Long**| Pet id to delete | [default to null]
|
||||
**apiKey** | **String**| | [optional] [default to null]
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
<a name="findPetsByStatus"></a>
|
||||
# **findPetsByStatus**
|
||||
> List findPetsByStatus(status)
|
||||
Finds Pets by status
|
||||
Multiple status values can be provided with comma separated strings
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | [**List**](String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold]
|
||||
### Return type
|
||||
[**List**](Pet.md)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="findPetsByTags"></a>
|
||||
# **findPetsByTags**
|
||||
> List findPetsByTags(tags)
|
||||
Finds Pets by tags
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**tags** | [**List**](String.md)| Tags to filter by | [default to null]
|
||||
### Return type
|
||||
[**List**](Pet.md)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="getPetById"></a>
|
||||
# **getPetById**
|
||||
> Pet getPetById(petId)
|
||||
Find pet by ID
|
||||
Returns a single pet
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**petId** | **Long**| ID of pet to return | [default to null]
|
||||
### Return type
|
||||
[**Pet**](Pet.md)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="updatePet"></a>
|
||||
# **updatePet**
|
||||
> Pet updatePet(pet)
|
||||
Update an existing pet
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
|
||||
### Return type
|
||||
[**Pet**](Pet.md)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="updatePetWithForm"></a>
|
||||
# **updatePetWithForm**
|
||||
> updatePetWithForm(petId, name, status)
|
||||
Updates a pet in the store with form data
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**petId** | **Long**| ID of pet that needs to be updated | [default to null]
|
||||
**name** | **String**| Updated name of the pet | [optional] [default to null]
|
||||
**status** | **String**| Updated status of the pet | [optional] [default to null]
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: Not defined
|
||||
<a name="uploadFile"></a>
|
||||
# **uploadFile**
|
||||
> ApiResponse uploadFile(petId, additionalMetadata, file)
|
||||
uploads an image
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**petId** | **Long**| ID of pet to update | [default to null]
|
||||
**additionalMetadata** | **String**| Additional data to pass to server | [optional] [default to null]
|
||||
**file** | **File**| file to upload | [optional] [default to null]
|
||||
### Return type
|
||||
[**ApiResponse**](ApiResponse.md)
|
||||
### Authorization
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
@@ -0,0 +1,74 @@
|
||||
# StoreApi
|
||||
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
|
||||
[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||
[**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
|
||||
|
||||
<a name="deleteOrder"></a>
|
||||
# **deleteOrder**
|
||||
> deleteOrder(orderId)
|
||||
Delete purchase order by ID
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**orderId** | **String**| ID of the order that needs to be deleted | [default to null]
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
No authorization required
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
<a name="getInventory"></a>
|
||||
# **getInventory**
|
||||
> Map getInventory()
|
||||
Returns pet inventories by status
|
||||
Returns a map of status codes to quantities
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
### Return type
|
||||
[**Map**](integer.md)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
<a name="getOrderById"></a>
|
||||
# **getOrderById**
|
||||
> Order getOrderById(orderId)
|
||||
Find purchase order by ID
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**orderId** | **Long**| ID of pet that needs to be fetched | [default to null]
|
||||
### Return type
|
||||
[**Order**](Order.md)
|
||||
### Authorization
|
||||
No authorization required
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="placeOrder"></a>
|
||||
# **placeOrder**
|
||||
> Order placeOrder(order)
|
||||
Place an order for a pet
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**order** | [**Order**](Order.md)| order placed for purchasing the pet |
|
||||
### Return type
|
||||
[**Order**](Order.md)
|
||||
### Authorization
|
||||
No authorization required
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/xml, application/json
|
||||
@@ -0,0 +1,148 @@
|
||||
# UserApi
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createUser**](UserApi.md#createUser) | **POST** /user | Create user
|
||||
[**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||
[**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array
|
||||
[**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user
|
||||
[**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name
|
||||
[**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system
|
||||
[**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session
|
||||
[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
<a name="createUser"></a>
|
||||
# **createUser**
|
||||
> createUser(user)
|
||||
Create user
|
||||
This can only be done by the logged in user.
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**user** | [**User**](User.md)| Created user object |
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
<a name="createUsersWithArrayInput"></a>
|
||||
# **createUsersWithArrayInput**
|
||||
> createUsersWithArrayInput(user)
|
||||
Creates list of users with given input array
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**user** | [**List**](User.md)| List of user object |
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
<a name="createUsersWithListInput"></a>
|
||||
# **createUsersWithListInput**
|
||||
> createUsersWithListInput(user)
|
||||
Creates list of users with given input array
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**user** | [**List**](User.md)| List of user object |
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
<a name="deleteUser"></a>
|
||||
# **deleteUser**
|
||||
> deleteUser(username)
|
||||
Delete user
|
||||
This can only be done by the logged in user.
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**username** | **String**| The name that needs to be deleted | [default to null]
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
<a name="getUserByName"></a>
|
||||
# **getUserByName**
|
||||
> User getUserByName(username)
|
||||
Get user by user name
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**username** | **String**| The name that needs to be fetched. Use user1 for testing. | [default to null]
|
||||
### Return type
|
||||
[**User**](User.md)
|
||||
### Authorization
|
||||
No authorization required
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="loginUser"></a>
|
||||
# **loginUser**
|
||||
> String loginUser(username, password)
|
||||
Logs user into the system
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**username** | **String**| The user name for login | [default to null]
|
||||
**password** | **String**| The password for login in clear text | [default to null]
|
||||
### Return type
|
||||
[**String**](string.md)
|
||||
### Authorization
|
||||
No authorization required
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
<a name="logoutUser"></a>
|
||||
# **logoutUser**
|
||||
> logoutUser()
|
||||
Logs out current logged in user session
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
<a name="updateUser"></a>
|
||||
# **updateUser**
|
||||
> updateUser(username, user)
|
||||
Updated user
|
||||
This can only be done by the logged in user.
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**username** | **String**| name that need to be deleted | [default to null]
|
||||
**user** | [**User**](User.md)| Updated user object |
|
||||
### Return type
|
||||
null (empty response body)
|
||||
### Authorization
|
||||
[api_key](../README.md#api_key)
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
@@ -0,0 +1,8 @@
|
||||
# .Models.ApiResponse
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | [**Integer**](integer.md) | | [optional] [default to null]
|
||||
**type** | [**String**](string.md) | | [optional] [default to null]
|
||||
**message** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,7 @@
|
||||
# .Models.Category
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# .Models.Order
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**petId** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**quantity** | [**Integer**](integer.md) | | [optional] [default to null]
|
||||
**shipDate** | [**Date**](DateTime.md) | | [optional] [default to null]
|
||||
**status** | [**String**](string.md) | Order Status | [optional] [default to null]
|
||||
**complete** | [**Boolean**](boolean.md) | | [optional] [default to false]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# .Models.Pet
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**category** | [**Category**](Category.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [default to null]
|
||||
**photoUrls** | [**List**](string.md) | | [default to null]
|
||||
**tags** | [**List**](Tag.md) | | [optional] [default to null]
|
||||
**status** | [**String**](string.md) | pet status in the store | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,7 @@
|
||||
# .Models.Tag
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,13 @@
|
||||
# .Models.User
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**username** | [**String**](string.md) | | [optional] [default to null]
|
||||
**firstName** | [**String**](string.md) | | [optional] [default to null]
|
||||
**lastName** | [**String**](string.md) | | [optional] [default to null]
|
||||
**email** | [**String**](string.md) | | [optional] [default to null]
|
||||
**password** | [**String**](string.md) | | [optional] [default to null]
|
||||
**phone** | [**String**](string.md) | | [optional] [default to null]
|
||||
**userStatus** | [**Integer**](integer.md) | User Status | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
28
samples/client/petstore/jetbrains-bkp/http/client/README.md
Normal file
28
samples/client/petstore/jetbrains-bkp/http/client/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# # Documentation for OpenAPI Petstore
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*PetApi* | [**addPet**](Apis/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
|
||||
*PetApi* | [**deletePet**](Apis/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
|
||||
*PetApi* | [**findPetsByStatus**](Apis/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
|
||||
*PetApi* | [**findPetsByTags**](Apis/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
|
||||
*PetApi* | [**getPetById**](Apis/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
|
||||
*PetApi* | [**updatePet**](Apis/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet
|
||||
*PetApi* | [**updatePetWithForm**](Apis/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
||||
*PetApi* | [**uploadFile**](Apis/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
||||
*StoreApi* | [**deleteOrder**](Apis/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
||||
*StoreApi* | [**getInventory**](Apis/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||
*StoreApi* | [**getOrderById**](Apis/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID
|
||||
*StoreApi* | [**placeOrder**](Apis/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
|
||||
*UserApi* | [**createUser**](Apis/UserApi.md#createuser) | **POST** /user | Create user
|
||||
*UserApi* | [**createUsersWithArrayInput**](Apis/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||
*UserApi* | [**createUsersWithListInput**](Apis/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
|
||||
*UserApi* | [**deleteUser**](Apis/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
|
||||
*UserApi* | [**getUserByName**](Apis/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
|
||||
*UserApi* | [**loginUser**](Apis/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system
|
||||
*UserApi* | [**logoutUser**](Apis/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
|
||||
*UserApi* | [**updateUser**](Apis/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
@@ -0,0 +1,10 @@
|
||||
Apis/PetApi.http
|
||||
Apis/StoreApi.http
|
||||
Apis/UserApi.http
|
||||
Models/ApiResponse.http
|
||||
Models/Category.http
|
||||
Models/Order.http
|
||||
Models/Pet.http
|
||||
Models/Tag.http
|
||||
Models/User.http
|
||||
README.md
|
||||
@@ -0,0 +1 @@
|
||||
6.3.0-SNAPSHOT
|
||||
@@ -0,0 +1,42 @@
|
||||
## PetApi
|
||||
|
||||
### Add a new pet to the store
|
||||
# addPet
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Deletes a pet
|
||||
# deletePet
|
||||
DELETE http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Finds Pets by status
|
||||
# findPetsByStatus
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Finds Pets by tags
|
||||
# findPetsByTags
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Find pet by ID
|
||||
# getPetById
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Update an existing pet
|
||||
# updatePet
|
||||
PUT http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Updates a pet in the store with form data
|
||||
# updatePetWithForm
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### uploads an image
|
||||
# uploadFile
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
## StoreApi
|
||||
|
||||
### Delete purchase order by ID
|
||||
# deleteOrder
|
||||
DELETE http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Returns pet inventories by status
|
||||
# getInventory
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Find purchase order by ID
|
||||
# getOrderById
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Place an order for a pet
|
||||
# placeOrder
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
## UserApi
|
||||
|
||||
### Create user
|
||||
# createUser
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Creates list of users with given input array
|
||||
# createUsersWithArrayInput
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Creates list of users with given input array
|
||||
# createUsersWithListInput
|
||||
POST http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Delete user
|
||||
# deleteUser
|
||||
DELETE http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Get user by user name
|
||||
# getUserByName
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Logs user into the system
|
||||
# loginUser
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Logs out current logged in user session
|
||||
# logoutUser
|
||||
GET http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
### Updated user
|
||||
# updateUser
|
||||
PUT http://petstore.swagger.io/v2
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
# .Models.ApiResponse
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | [**Integer**](integer.md) | | [optional] [default to null]
|
||||
**type** | [**String**](string.md) | | [optional] [default to null]
|
||||
**message** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,7 @@
|
||||
# .Models.Category
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# .Models.Order
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**petId** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**quantity** | [**Integer**](integer.md) | | [optional] [default to null]
|
||||
**shipDate** | [**Date**](DateTime.md) | | [optional] [default to null]
|
||||
**status** | [**String**](string.md) | Order Status | [optional] [default to null]
|
||||
**complete** | [**Boolean**](boolean.md) | | [optional] [default to false]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,11 @@
|
||||
# .Models.Pet
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**category** | [**Category**](Category.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [default to null]
|
||||
**photoUrls** | [**List**](string.md) | | [default to null]
|
||||
**tags** | [**List**](Tag.md) | | [optional] [default to null]
|
||||
**status** | [**String**](string.md) | pet status in the store | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,7 @@
|
||||
# .Models.Tag
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**name** | [**String**](string.md) | | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@@ -0,0 +1,13 @@
|
||||
# .Models.User
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | [**Long**](long.md) | | [optional] [default to null]
|
||||
**username** | [**String**](string.md) | | [optional] [default to null]
|
||||
**firstName** | [**String**](string.md) | | [optional] [default to null]
|
||||
**lastName** | [**String**](string.md) | | [optional] [default to null]
|
||||
**email** | [**String**](string.md) | | [optional] [default to null]
|
||||
**password** | [**String**](string.md) | | [optional] [default to null]
|
||||
**phone** | [**String**](string.md) | | [optional] [default to null]
|
||||
**userStatus** | [**Integer**](integer.md) | User Status | [optional] [default to null]
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
28
samples/client/petstore/jetbrains/http/client/README.md
Normal file
28
samples/client/petstore/jetbrains/http/client/README.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# # Documentation for OpenAPI Petstore
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*PetApi* | [**addPet**](Apis/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
|
||||
*PetApi* | [**deletePet**](Apis/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
|
||||
*PetApi* | [**findPetsByStatus**](Apis/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
|
||||
*PetApi* | [**findPetsByTags**](Apis/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
|
||||
*PetApi* | [**getPetById**](Apis/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
|
||||
*PetApi* | [**updatePet**](Apis/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet
|
||||
*PetApi* | [**updatePetWithForm**](Apis/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
||||
*PetApi* | [**uploadFile**](Apis/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
||||
*StoreApi* | [**deleteOrder**](Apis/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
||||
*StoreApi* | [**getInventory**](Apis/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||
*StoreApi* | [**getOrderById**](Apis/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID
|
||||
*StoreApi* | [**placeOrder**](Apis/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
|
||||
*UserApi* | [**createUser**](Apis/UserApi.md#createuser) | **POST** /user | Create user
|
||||
*UserApi* | [**createUsersWithArrayInput**](Apis/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||
*UserApi* | [**createUsersWithListInput**](Apis/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
|
||||
*UserApi* | [**deleteUser**](Apis/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
|
||||
*UserApi* | [**getUserByName**](Apis/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
|
||||
*UserApi* | [**loginUser**](Apis/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system
|
||||
*UserApi* | [**logoutUser**](Apis/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
|
||||
*UserApi* | [**updateUser**](Apis/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
Reference in New Issue
Block a user