openapi-generator/samples/client/petstore/c/docs/UserAPI.md

UserAPI

All URIs are relative to http://petstore.swagger.io/v2

Method	HTTP request	Description
UserAPI_createUser	POST /user	Create user
UserAPI_createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserAPI_createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserAPI_deleteUser	DELETE /user/{username}	Delete user
UserAPI_getUserByName	GET /user/{username}	Get user by user name
UserAPI_loginUser	GET /user/login	Logs user into the system
UserAPI_logoutUser	GET /user/logout	Logs out current logged in user session
UserAPI_testIntAndBool	GET /user/testIntAndBool	test integer and boolean query parameters in API
UserAPI_updateUser	PUT /user/{username}	Updated user

UserAPI_createUser

// Create user
//
// This can only be done by the logged in user.
//
void UserAPI_createUser(apiClient_t *apiClient, user_t * body);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
body	user_t *	Created user object

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_createUsersWithArrayInput

// Creates list of users with given input array
//
void UserAPI_createUsersWithArrayInput(apiClient_t *apiClient, list_t * body);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
body	list_t *	List of user object

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_createUsersWithListInput

// Creates list of users with given input array
//
void UserAPI_createUsersWithListInput(apiClient_t *apiClient, list_t * body);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
body	list_t *	List of user object

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_deleteUser

// Delete user
//
// This can only be done by the logged in user.
//
void UserAPI_deleteUser(apiClient_t *apiClient, char * username);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
username	char *	The name that needs to be deleted

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_getUserByName

// Get user by user name
//
user_t* UserAPI_getUserByName(apiClient_t *apiClient, char * username);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
username	char *	The name that needs to be fetched. Use user1 for testing.

Return type

user_t *

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_loginUser

// Logs user into the system
//
char* UserAPI_loginUser(apiClient_t *apiClient, char * username, char * password);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
username	char *	The user name for login
password	char *	The password for login in clear text

Return type

char*

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_logoutUser

// Logs out current logged in user session
//
void UserAPI_logoutUser(apiClient_t *apiClient);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_testIntAndBool

// 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);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
keep	int	Whether to keep user data after deletion	[optional]
keepDay	int	how many days user data is kept after deletion	[optional]

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserAPI_updateUser

// Updated user
//
// This can only be done by the logged in user.
//
void UserAPI_updateUser(apiClient_t *apiClient, char * username, user_t * body);

Parameters

Name	Type	Description	Notes
apiClient	apiClient_t *	context containing the client configuration
username	char *	name that need to be deleted
body	user_t *	Updated user object

Return type

void

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]