loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/petstore/c/docs/StoreAPI.md
Ernesto Fernández b7c7ed087f
Fix a few issues with the C generator (part 4) (#20289) 
* [C] Deal with binary api parameters

With this change, the bodyParameters array can also be binary, so pass
its length around instead of relying on strlen().

* [C] Fix a few remaining enum issues

* [C] Install headers and include any_type.h header

* [C] Don't require C++ to compile C code

* [C] Test binary bodies and path enums in schemas

* Update samples

---------

Co-authored-by: Sam Bingner <sam@corellium.com>
2024-12-13 02:01:04 +08:00

5.5 KiB
Raw Blame History

StoreAPI

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

Method HTTP request Description
StoreAPI_deleteOrder DELETE /store/order/{orderId} Delete purchase order by ID
StoreAPI_getInventory GET /store/inventory Returns pet inventories by status
StoreAPI_getOrderById GET /store/order/{orderId} Find purchase order by ID
StoreAPI_placeOrder POST /store/order Place an order for a pet
StoreAPI_sendFeedback POST /store/feedback Send us a feedback message
StoreAPI_sendRating POST /store/rating/{rating} How would you rate our service?

StoreAPI_deleteOrder

// Delete purchase order by ID
//
// 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);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
orderId char * ID of the order 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]

StoreAPI_getInventory

// Returns pet inventories by status
//
// Returns a map of status codes to quantities
//
list_t* StoreAPI_getInventory(apiClient_t *apiClient);

Parameters

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

Return type

list_t*

Authorization

api_key

HTTP request headers

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

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

StoreAPI_getOrderById

// Find purchase order by ID
//
// For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
//
order_t* StoreAPI_getOrderById(apiClient_t *apiClient, long orderId);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
orderId long ID of pet that needs to be fetched

Return type

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

StoreAPI_placeOrder

// Place an order for a pet
//
order_t* StoreAPI_placeOrder(apiClient_t *apiClient, order_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body order_t * order placed for purchasing the pet

Return type

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

StoreAPI_sendFeedback

// Send us a feedback message
//
char* StoreAPI_sendFeedback(apiClient_t *apiClient, char *feedback);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
feedback char * The feedback message to send

Return type

char*

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

StoreAPI_sendRating

// How would you rate our service?
//
char* StoreAPI_sendRating(apiClient_t *apiClient, openapi_petstore_sendRating_rating_e rating);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
rating openapi_petstore_sendRating_rating_e The rating to submit

Return type

char*

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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