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
8.2 KiB
UserApi
All URIs are relative to http://petstore.swagger.io/v2
| Method | HTTP request | Description |
|---|---|---|
| create_user | POST /user | Create user |
| create_users_with_array_input | POST /user/createWithArray | Creates list of users with given input array |
| create_users_with_list_input | POST /user/createWithList | Creates list of users with given input array |
| delete_user | DELETE /user/{username} | Delete user |
| get_user_by_name | GET /user/{username} | Get user by user name |
| login_user | GET /user/login | Logs user into the system |
| logout_user | GET /user/logout | Logs out current logged in user session |
| update_user | PUT /user/{username} | Updated user |
create_user
create_user(_api::UserApi,user::User; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
create_user(_api::UserApi, response_stream::Channel,user::User; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Create user
This can only be done by the logged in user.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
user |
User |
Created user object |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_array_input
create_users_with_array_input(_api::UserApi,user::Vector{User}; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
create_users_with_array_input(_api::UserApi, response_stream::Channel,user::Vector{User}; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Creates list of users with given input array
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
user |
Vector{User} |
List of user object |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_list_input
create_users_with_list_input(_api::UserApi,user::Vector{User}; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
create_users_with_list_input(_api::UserApi, response_stream::Channel,user::Vector{User}; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Creates list of users with given input array
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
user |
Vector{User} |
List of user object |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_user
delete_user(_api::UserApi,username::String; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
delete_user(_api::UserApi, response_stream::Channel,username::String; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Delete user
This can only be done by the logged in user.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
username |
String |
The name that needs to be deleted |
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]
get_user_by_name
get_user_by_name(_api::UserApi,username::String; _mediaType=nothing) ->User,OpenAPI.Clients.ApiResponse
get_user_by_name(_api::UserApi, response_stream::Channel,username::String; _mediaType=nothing) ->Channel{User},OpenAPI.Clients.ApiResponse
Get user by user name
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
username |
String |
The name that needs to be fetched. Use user1 for testing. |
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]
login_user
login_user(_api::UserApi,username::String,password::String; _mediaType=nothing) ->String,OpenAPI.Clients.ApiResponse
login_user(_api::UserApi, response_stream::Channel,username::String,password::String; _mediaType=nothing) ->Channel{String},OpenAPI.Clients.ApiResponse
Logs user into the system
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
username |
String |
The user name for login | |
password |
String |
The password for login in clear text |
Return type
String
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]
logout_user
logout_user(_api::UserApi; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
logout_user(_api::UserApi, response_stream::Channel; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Logs out current logged in user session
Required Parameters
This endpoint does not need any parameter.
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]
update_user
update_user(_api::UserApi,username::String,user::User; _mediaType=nothing) ->Nothing,OpenAPI.Clients.ApiResponse
update_user(_api::UserApi, response_stream::Channel,username::String,user::User; _mediaType=nothing) ->Channel{Nothing},OpenAPI.Clients.ApiResponse
Updated user
This can only be done by the logged in user.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| _api | UserApi |
API context | |
username |
String |
name that need to be deleted | |
user |
User |
Updated user object |
Return type
Nothing
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]