loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-15 06:00:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/samples/client/petstore/c/docs/UserAPI.md
William Cheng 0204bf4ae2 Squashed commit of the following: 
commit c5a0d0f7394aa742fa336fff7e7c1d3049761868
Merge: 8c4991ba3ed f8ff8c87609
Author: William Cheng <wing328hk@gmail.com>
Date:   Tue Aug 17 18:28:12 2021 +0800

    Merge branch 'mustache-linting' of https://github.com/NathanBaulch/openapi-generator into NathanBaulch-mustache-linting

commit f8ff8c87609b1ca36fa26fb8474806999638195e
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:12:47 2021 +1000

    Reorder tags that handle missing values

commit f5d8a33709d6a3f846a9fe4520b78c3d637051d9
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:08:59 2021 +1000

    Use dot notation where possible

commit 493d14921e2333f3ae19ef6fc89318b7e263a80c
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:10:49 2021 +1000

    Remove empty tags

commit 32480dc53f48227d55531b94e307d72671373737
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 10:41:58 2021 +1000

    Remove redundant sections

commit a8edabd722c34aa094b4aeb11c22664529c3a219
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Wed Aug 4 22:02:22 2021 +1000

    Trim extra EOF new lines

commit e89bd7458e3594bf0d30e580bc9408e45b018a57
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Wed Aug 4 21:59:26 2021 +1000

    Trim trailing whitespace
2021-08-17 18:37:51 +08:00

7.2 KiB
Raw Blame History

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_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_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]