mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-07-03 06:00:52 +00:00
[C][Client] Update the API doc after some data types of parameters are changed from "int" to "int *" (#17540)
This commit is contained in:
parent
0d4c9fb2c3
commit
742c2c48e7
@ -20,7 +20,7 @@ Method | HTTP request | Description
|
||||
// {{{.}}}
|
||||
//
|
||||
{{/notes}}
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}{{#returnSimpleType}}{{{.}}}*{{/returnSimpleType}}{{^returnSimpleType}}{{#isArray}}{{{.}}}_t*{{/isArray}}{{#isMap}}{{{.}}}{{/isMap}}{{/returnSimpleType}}{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{{.}}}_t*{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void{{/returnType}} {{{classname}}}_{{{operationId}}}(apiClient_t *apiClient{{#allParams}}, {{#isPrimitiveType}}{{#isNumber}}{{{dataType}}}{{/isNumber}}{{#isLong}}{{{dataType}}}{{/isLong}}{{#isInteger}}{{{dataType}}}{{/isInteger}}{{#isDouble}}{{{dataType}}}{{/isDouble}}{{#isFloat}}{{{dataType}}}{{/isFloat}}{{#isBoolean}}{{dataType}}{{/isBoolean}}{{#isEnum}}{{#isString}}{{projectName}}_{{operationId}}_{{baseName}}_e{{/isString}}{{/isEnum}}{{^isEnum}}{{#isString}}{{{dataType}}} *{{/isString}}{{/isEnum}}{{#isByteArray}}{{{dataType}}} *{{/isByteArray}}{{#isDate}}{{{dataType}}}{{/isDate}}{{#isDateTime}}{{{dataType}}}{{/isDateTime}}{{#isFile}}{{{dataType}}}{{/isFile}}{{#isFreeFormObject}}{{dataType}}_t *{{/isFreeFormObject}}{{/isPrimitiveType}}{{^isArray}}{{^isPrimitiveType}}{{#isModel}}{{#isEnum}}{{datatypeWithEnum}}_e{{/isEnum}}{{^isEnum}}{{{dataType}}}_t *{{/isEnum}}{{/isModel}}{{^isModel}}{{#isEnum}}{{datatypeWithEnum}}_e{{/isEnum}}{{/isModel}}{{#isUuid}}{{dataType}} *{{/isUuid}}{{#isEmail}}{{dataType}}{{/isEmail}}{{/isPrimitiveType}}{{/isArray}}{{#isContainer}}{{#isArray}}{{dataType}}_t *{{/isArray}}{{#isMap}}{{dataType}}{{/isMap}}{{/isContainer}} {{{paramName}}}{{/allParams}});
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}{{#returnSimpleType}}{{{.}}}*{{/returnSimpleType}}{{^returnSimpleType}}{{#isArray}}{{{.}}}_t*{{/isArray}}{{#isMap}}{{{.}}}{{/isMap}}{{/returnSimpleType}}{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{{.}}}_t*{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void{{/returnType}} {{{classname}}}_{{{operationId}}}(apiClient_t *apiClient{{#allParams}}, {{#isPrimitiveType}}{{#isNumber}}{{{dataType}}} {{/isNumber}}{{#isLong}}{{{dataType}}} {{/isLong}}{{#isInteger}}{{{dataType}}} *{{/isInteger}}{{#isDouble}}{{{dataType}}} {{/isDouble}}{{#isFloat}}{{{dataType}}} {{/isFloat}}{{#isBoolean}}{{dataType}} *{{/isBoolean}}{{#isEnum}}{{#isString}}{{projectName}}_{{operationId}}_{{baseName}}_e {{/isString}}{{/isEnum}}{{^isEnum}}{{#isString}}{{{dataType}}} *{{/isString}}{{/isEnum}}{{#isByteArray}}{{{dataType}}} *{{/isByteArray}}{{#isDate}}{{{dataType}}} {{/isDate}}{{#isDateTime}}{{{dataType}}} {{/isDateTime}}{{#isFile}}{{{dataType}}} {{/isFile}}{{#isFreeFormObject}}{{dataType}}_t *{{/isFreeFormObject}}{{/isPrimitiveType}}{{^isArray}}{{^isPrimitiveType}}{{#isModel}}{{#isEnum}}{{datatypeWithEnum}}_e {{/isEnum}}{{^isEnum}}{{{dataType}}}_t *{{/isEnum}}{{/isModel}}{{^isModel}}{{#isEnum}}{{datatypeWithEnum}}_e {{/isEnum}}{{/isModel}}{{#isUuid}}{{dataType}} *{{/isUuid}}{{#isEmail}}{{dataType}} {{/isEmail}}{{/isPrimitiveType}}{{/isArray}}{{#isContainer}}{{#isArray}}{{dataType}}_t *{{/isArray}}{{#isMap}}{{dataType}} {{/isMap}}{{/isContainer}}{{{paramName}}}{{/allParams}});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
@ -18,7 +18,7 @@ Method | HTTP request | Description
|
||||
```c
|
||||
// Add a new pet to the store
|
||||
//
|
||||
void PetAPI_addPet(apiClient_t *apiClient, pet_t * body);
|
||||
void PetAPI_addPet(apiClient_t *apiClient, pet_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -46,7 +46,7 @@ void
|
||||
```c
|
||||
// Deletes a pet
|
||||
//
|
||||
void PetAPI_deletePet(apiClient_t *apiClient, long petId, char * api_key);
|
||||
void PetAPI_deletePet(apiClient_t *apiClient, long petId, char *api_key);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -77,7 +77,7 @@ void
|
||||
//
|
||||
// Multiple status values can be provided with comma separated strings
|
||||
//
|
||||
list_t* PetAPI_findPetsByStatus(apiClient_t *apiClient, list_t * status);
|
||||
list_t* PetAPI_findPetsByStatus(apiClient_t *apiClient, list_t *status);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -108,7 +108,7 @@ Name | Type | Description | Notes
|
||||
//
|
||||
// Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
//
|
||||
list_t* PetAPI_findPetsByTags(apiClient_t *apiClient, list_t * tags);
|
||||
list_t* PetAPI_findPetsByTags(apiClient_t *apiClient, list_t *tags);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -168,7 +168,7 @@ Name | Type | Description | Notes
|
||||
```c
|
||||
// Update an existing pet
|
||||
//
|
||||
void PetAPI_updatePet(apiClient_t *apiClient, pet_t * body);
|
||||
void PetAPI_updatePet(apiClient_t *apiClient, pet_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -196,7 +196,7 @@ void
|
||||
```c
|
||||
// Updates a pet in the store with form data
|
||||
//
|
||||
void PetAPI_updatePetWithForm(apiClient_t *apiClient, long petId, char * name, char * status);
|
||||
void PetAPI_updatePetWithForm(apiClient_t *apiClient, long petId, char *name, char *status);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -226,7 +226,7 @@ void
|
||||
```c
|
||||
// uploads an image
|
||||
//
|
||||
api_response_t* PetAPI_uploadFile(apiClient_t *apiClient, long petId, char * additionalMetadata, binary_t* file);
|
||||
api_response_t* PetAPI_uploadFile(apiClient_t *apiClient, long petId, char *additionalMetadata, binary_t* file);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
@ -16,7 +16,7 @@ Method | HTTP request | Description
|
||||
//
|
||||
// For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
//
|
||||
void StoreAPI_deleteOrder(apiClient_t *apiClient, char * orderId);
|
||||
void StoreAPI_deleteOrder(apiClient_t *apiClient, char *orderId);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -108,7 +108,7 @@ No authorization required
|
||||
```c
|
||||
// Place an order for a pet
|
||||
//
|
||||
order_t* StoreAPI_placeOrder(apiClient_t *apiClient, order_t * body);
|
||||
order_t* StoreAPI_placeOrder(apiClient_t *apiClient, order_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
@ -21,7 +21,7 @@ Method | HTTP request | Description
|
||||
//
|
||||
// This can only be done by the logged in user.
|
||||
//
|
||||
void UserAPI_createUser(apiClient_t *apiClient, user_t * body);
|
||||
void UserAPI_createUser(apiClient_t *apiClient, user_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -49,7 +49,7 @@ No authorization required
|
||||
```c
|
||||
// Creates list of users with given input array
|
||||
//
|
||||
void UserAPI_createUsersWithArrayInput(apiClient_t *apiClient, list_t * body);
|
||||
void UserAPI_createUsersWithArrayInput(apiClient_t *apiClient, list_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -77,7 +77,7 @@ No authorization required
|
||||
```c
|
||||
// Creates list of users with given input array
|
||||
//
|
||||
void UserAPI_createUsersWithListInput(apiClient_t *apiClient, list_t * body);
|
||||
void UserAPI_createUsersWithListInput(apiClient_t *apiClient, list_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -107,7 +107,7 @@ No authorization required
|
||||
//
|
||||
// This can only be done by the logged in user.
|
||||
//
|
||||
void UserAPI_deleteUser(apiClient_t *apiClient, char * username);
|
||||
void UserAPI_deleteUser(apiClient_t *apiClient, char *username);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -135,7 +135,7 @@ No authorization required
|
||||
```c
|
||||
// Get user by user name
|
||||
//
|
||||
user_t* UserAPI_getUserByName(apiClient_t *apiClient, char * username);
|
||||
user_t* UserAPI_getUserByName(apiClient_t *apiClient, char *username);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -164,7 +164,7 @@ No authorization required
|
||||
```c
|
||||
// Logs user into the system
|
||||
//
|
||||
char* UserAPI_loginUser(apiClient_t *apiClient, char * username, char * password);
|
||||
char* UserAPI_loginUser(apiClient_t *apiClient, char *username, char *password);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -224,7 +224,7 @@ No authorization required
|
||||
//
|
||||
// This can test integer and boolean query parameters in API.
|
||||
//
|
||||
void UserAPI_testIntAndBool(apiClient_t *apiClient, int keep, int keepDay);
|
||||
void UserAPI_testIntAndBool(apiClient_t *apiClient, int *keep, int *keepDay);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
@ -255,7 +255,7 @@ No authorization required
|
||||
//
|
||||
// This can only be done by the logged in user.
|
||||
//
|
||||
void UserAPI_updateUser(apiClient_t *apiClient, char * username, user_t * body);
|
||||
void UserAPI_updateUser(apiClient_t *apiClient, char *username, user_t *body);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
Loading…
x
Reference in New Issue
Block a user