57d12811ef
* [Julia] Fix docstring parameter formatting with backticks Wrap parameter names in backticks in generated Julia client docstrings to prevent markdown from misinterpreting underscores as italic formatting. This fixes an issue where parameter names like `pet_id`, `api_key`, and `additional_metadata` would render incorrectly in documentation, with underscores being treated as markdown italic markers instead of literal characters. Related issue: JuliaComputing/OpenAPI.jl#72 * Also wrap data types and return types in backticks * Regenerate Julia client samples with backticked docstrings * [Julia] Add backticks to all markdown documentation templates Extend backtick formatting to markdown documentation templates for both Julia client and server generators. This ensures consistent markdown rendering of identifiers with underscores. Changes: - julia-client/api_doc.mustache: Add backticks to function signatures, parameter names, types, and return types in markdown API docs - julia-server/api_doc.mustache: Same changes for server API docs - julia-client/model_doc.mustache: Add backticks to property names and types in markdown model documentation - julia-server/model_doc.mustache: Same changes for server model docs All generated markdown files now properly display identifiers like `pet_id`, `Custom_Type`, `update_pet_with_form` with literal underscores instead of broken italic formatting. Related to JuliaComputing/OpenAPI.jl#72
3.5 KiB
StoreApi
All URIs are relative to http://petstore.swagger.io/v2
| Method | HTTP request | Description |
|---|---|---|
| delete_order | DELETE /store/order/{orderId} | Delete purchase order by ID |
| get_inventory | GET /store/inventory | Returns pet inventories by status |
| get_order_by_id | GET /store/order/{orderId} | Find purchase order by ID |
| place_order | POST /store/order | Place an order for a pet |
delete_order
delete_order(req::HTTP.Request,order_id::String;) ->Nothing
Delete purchase order by ID
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
order_id |
String |
ID of the order that needs to be deleted |
Return type
Nothing
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]
get_inventory
get_inventory(req::HTTP.Request;) ->Dict{String, Int64}
Returns pet inventories by status
Returns a map of status codes to quantities
Required Parameters
This endpoint does not need any parameter.
Return type
Dict{String, Int64}
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_order_by_id
get_order_by_id(req::HTTP.Request,order_id::Int64;) ->Order
Find purchase order by ID
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
order_id |
Int64 |
ID of pet that needs to be fetched |
Return type
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]
place_order
place_order(req::HTTP.Request,order::Order;) ->Order
Place an order for a pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
order |
Order |
order placed for purchasing the pet |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: application/json
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]