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

[C][Client] Update the API doc after some data types of parameters are changed from "int" to "int *" (#17540)

Browse Source
This commit is contained in:
Hui Yu 2024-01-06 19:04:36 +08:00 committed by GitHub
parent 0d4c9fb2c3
commit 742c2c48e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/openapi-generator/src/main/resources/C-libcurl/api_doc.mustache vendored
View File

@ -20,7 +20,7 @@ Method | HTTP request | Description
// {{{.}}} // {{{.}}}
// //
{{/notes}} {{/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 ### Parameters

14
samples/client/petstore/c/docs/PetAPI.md
View File

@ -18,7 +18,7 @@ Method | HTTP request | Description
```c ```c
// Add a new pet to the store // 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 ### Parameters
@ -46,7 +46,7 @@ void
```c ```c
// Deletes a pet // 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 ### Parameters
@ -77,7 +77,7 @@ void
// //
// Multiple status values can be provided with comma separated strings // 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 ### Parameters
@ -108,7 +108,7 @@ Name | Type | Description | Notes
// //
// Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. // 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 ### Parameters
@ -168,7 +168,7 @@ Name | Type | Description | Notes
```c ```c
// Update an existing pet // Update an existing pet
// //
void PetAPI_updatePet(apiClient_t *apiClient, pet_t * body); void PetAPI_updatePet(apiClient_t *apiClient, pet_t *body);
``` ```
### Parameters ### Parameters
@ -196,7 +196,7 @@ void
```c ```c
// Updates a pet in the store with form data // 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 ### Parameters
@ -226,7 +226,7 @@ void
```c ```c
// uploads an image // 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 ### Parameters

4
samples/client/petstore/c/docs/StoreAPI.md
View File

@ -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 // 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 ### Parameters
@ -108,7 +108,7 @@ No authorization required
```c ```c
// Place an order for a pet // 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 ### Parameters

16
samples/client/petstore/c/docs/UserAPI.md
View File

@ -21,7 +21,7 @@ Method | HTTP request | Description
// //
// This can only be done by the logged in user. // 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 ### Parameters
@ -49,7 +49,7 @@ No authorization required
```c ```c
// Creates list of users with given input array // 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 ### Parameters
@ -77,7 +77,7 @@ No authorization required
```c ```c
// Creates list of users with given input array // 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 ### Parameters
@ -107,7 +107,7 @@ No authorization required
// //
// This can only be done by the logged in user. // 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 ### Parameters
@ -135,7 +135,7 @@ No authorization required
```c ```c
// Get user by user name // Get user by user name
// //
user_t* UserAPI_getUserByName(apiClient_t *apiClient, char * username); user_t* UserAPI_getUserByName(apiClient_t *apiClient, char *username);
``` ```
### Parameters ### Parameters
@ -164,7 +164,7 @@ No authorization required
```c ```c
// Logs user into the system // 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 ### Parameters
@ -224,7 +224,7 @@ No authorization required
// //
// This can test integer and boolean query parameters in API. // 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 ### Parameters
@ -255,7 +255,7 @@ No authorization required
// //
// This can only be done by the logged in user. // 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 ### Parameters