Skip to content

Commit

Permalink
[C][Client] Update the API doc after some data types of parameters ar…
Browse files Browse the repository at this point in the history
…e changed from "int" to "int *" (#17540)
  • Loading branch information
ityuhui committed Jan 6, 2024
1 parent 0d4c9fb commit 742c2c4
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions samples/client/petstore/c/docs/PetAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/c/docs/StoreAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions samples/client/petstore/c/docs/UserAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 742c2c4

Please sign in to comment.