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
7.8 KiB
PetApi
All URIs are relative to http://petstore.swagger.io/v2
| Method | HTTP request | Description |
|---|---|---|
| add_pet | POST /pet | Add a new pet to the store |
| delete_pet | DELETE /pet/{petId} | Deletes a pet |
| find_pets_by_status | GET /pet/findByStatus | Finds Pets by status |
| find_pets_by_tags | GET /pet/findByTags | Finds Pets by tags |
| get_pet_by_id | GET /pet/{petId} | Find pet by ID |
| update_pet | PUT /pet | Update an existing pet |
| update_pet_with_form | POST /pet/{petId} | Updates a pet in the store with form data |
| upload_file | POST /pet/{petId}/uploadImage | uploads an image |
add_pet
add_pet(req::HTTP.Request,pet::Pet;) ->Pet
Add a new pet to the store
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet |
Pet |
Pet object that needs to be added to the store |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/xml
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_pet
delete_pet(req::HTTP.Request,pet_id::Int64;api_key=nothing,) ->Nothing
Deletes a pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet_id |
Int64 |
Pet id to delete |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
api_key |
String |
[default to nothing] |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
find_pets_by_status
find_pets_by_status(req::HTTP.Request,status::Vector{String};) ->Vector{Pet}
Finds Pets by status
Multiple status values can be provided with comma separated strings
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
status |
Vector{String} |
Status values that need to be considered for filter |
Return type
Authorization
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]
find_pets_by_tags
find_pets_by_tags(req::HTTP.Request,tags::Vector{String};) ->Vector{Pet}
Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
tags |
Vector{String} |
Tags to filter by |
Return type
Authorization
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]
get_pet_by_id
get_pet_by_id(req::HTTP.Request,pet_id::Int64;) ->Pet
Find pet by ID
Returns a single pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet_id |
Int64 |
ID of pet to return |
Return type
Authorization
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]
update_pet
update_pet(req::HTTP.Request,pet::Pet;) ->Pet
Update an existing pet
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet |
Pet |
Pet object that needs to be added to the store |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, application/xml
- Accept: application/xml, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_pet_with_form
update_pet_with_form(req::HTTP.Request,pet_id::Int64;name=nothing,status=nothing,) ->Nothing
Updates a pet in the store with form data
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet_id |
Int64 |
ID of pet that needs to be updated |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
name |
String |
Updated name of the pet | [default to nothing] |
status |
String |
Updated status of the pet | [default to nothing] |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: application/x-www-form-urlencoded
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upload_file
upload_file(req::HTTP.Request,pet_id::Int64;additional_metadata=nothing,file=nothing,) ->ApiResponse
uploads an image
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| req | HTTP.Request |
The HTTP Request object | |
pet_id |
Int64 |
ID of pet to update |
Optional Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
additional_metadata |
String |
Additional data to pass to server | [default to nothing] |
file |
Vector{UInt8} |
file to upload |
Return type
Authorization
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]