Skip to content

Commit a3c8189

Browse files
committed
Regenerate Julia client samples with backticked docstrings
1 parent 4aea651 commit a3c8189

4 files changed

Lines changed: 47 additions & 47 deletions

File tree

samples/client/petstore/julia/src/apis/api_FakeApi.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ end
2929
test uuid default value
3030
3131
Params:
32-
- uuid_parameter::String (required)
32+
- `uuid_parameter`::`String` (required)
3333
34-
Return: Nothing, OpenAPI.Clients.ApiResponse
34+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
3535
"""
3636
function uuid_default_value(_api::FakeApi, uuid_parameter::String; _mediaType=nothing)
3737
_ctx = _oacinternal_uuid_default_value(_api, uuid_parameter; _mediaType=_mediaType)

samples/client/petstore/julia/src/apis/api_PetApi.jl

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ end
2828
2929
3030
Params:
31-
- pet::Pet (required)
31+
- `pet`::`Pet` (required)
3232
33-
Return: Pet, OpenAPI.Clients.ApiResponse
33+
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
3434
"""
3535
function add_pet(_api::PetApi, pet::Pet; _mediaType=nothing)
3636
_ctx = _oacinternal_add_pet(_api, pet; _mediaType=_mediaType)
@@ -60,10 +60,10 @@ end
6060
6161
6262
Params:
63-
- pet_id::Int64 (required)
64-
- api_key::String
63+
- `pet_id`::`Int64` (required)
64+
- `api_key`::`String`
6565
66-
Return: Nothing, OpenAPI.Clients.ApiResponse
66+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
6767
"""
6868
function delete_pet(_api::PetApi, pet_id::Int64; api_key=nothing, _mediaType=nothing)
6969
_ctx = _oacinternal_delete_pet(_api, pet_id; api_key=api_key, _mediaType=_mediaType)
@@ -93,9 +93,9 @@ end
9393
Multiple status values can be provided with comma separated strings
9494
9595
Params:
96-
- status::Vector{String} (required)
96+
- `status`::`Vector{String}` (required)
9797
98-
Return: Vector{Pet}, OpenAPI.Clients.ApiResponse
98+
Return: `Vector{Pet}`, `OpenAPI.Clients.ApiResponse`
9999
"""
100100
function find_pets_by_status(_api::PetApi, status::Vector{String}; _mediaType=nothing)
101101
_ctx = _oacinternal_find_pets_by_status(_api, status; _mediaType=_mediaType)
@@ -125,9 +125,9 @@ end
125125
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
126126
127127
Params:
128-
- tags::Vector{String} (required)
128+
- `tags`::`Vector{String}` (required)
129129
130-
Return: Vector{Pet}, OpenAPI.Clients.ApiResponse
130+
Return: `Vector{Pet}`, `OpenAPI.Clients.ApiResponse`
131131
"""
132132
function find_pets_by_tags(_api::PetApi, tags::Vector{String}; _mediaType=nothing)
133133
_ctx = _oacinternal_find_pets_by_tags(_api, tags; _mediaType=_mediaType)
@@ -158,9 +158,9 @@ end
158158
Returns a single pet
159159
160160
Params:
161-
- pet_id::Int64 (required)
161+
- `pet_id`::`Int64` (required)
162162
163-
Return: Pet, OpenAPI.Clients.ApiResponse
163+
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
164164
"""
165165
function get_pet_by_id(_api::PetApi, pet_id::Int64; _mediaType=nothing)
166166
_ctx = _oacinternal_get_pet_by_id(_api, pet_id; _mediaType=_mediaType)
@@ -191,9 +191,9 @@ end
191191
192192
193193
Params:
194-
- pet::Pet (required)
194+
- `pet`::`Pet` (required)
195195
196-
Return: Pet, OpenAPI.Clients.ApiResponse
196+
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
197197
"""
198198
function update_pet(_api::PetApi, pet::Pet; _mediaType=nothing)
199199
_ctx = _oacinternal_update_pet(_api, pet; _mediaType=_mediaType)
@@ -224,11 +224,11 @@ end
224224
225225
226226
Params:
227-
- pet_id::Int64 (required)
228-
- name::String
229-
- status::String
227+
- `pet_id`::`Int64` (required)
228+
- `name`::`String`
229+
- `status`::`String`
230230
231-
Return: Nothing, OpenAPI.Clients.ApiResponse
231+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
232232
"""
233233
function update_pet_with_form(_api::PetApi, pet_id::Int64; name=nothing, status=nothing, _mediaType=nothing)
234234
_ctx = _oacinternal_update_pet_with_form(_api, pet_id; name=name, status=status, _mediaType=_mediaType)
@@ -259,11 +259,11 @@ end
259259
260260
261261
Params:
262-
- pet_id::Int64 (required)
263-
- additional_metadata::String
264-
- file::String
262+
- `pet_id`::`Int64` (required)
263+
- `additional_metadata`::`String`
264+
- `file`::`String`
265265
266-
Return: ApiResponse, OpenAPI.Clients.ApiResponse
266+
Return: `ApiResponse`, `OpenAPI.Clients.ApiResponse`
267267
"""
268268
function upload_file(_api::PetApi, pet_id::Int64; additional_metadata=nothing, file=nothing, _mediaType=nothing)
269269
_ctx = _oacinternal_upload_file(_api, pet_id; additional_metadata=additional_metadata, file=file, _mediaType=_mediaType)

samples/client/petstore/julia/src/apis/api_StoreApi.jl

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ end
2929
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
3030
3131
Params:
32-
- order_id::String (required)
32+
- `order_id`::`String` (required)
3333
34-
Return: Nothing, OpenAPI.Clients.ApiResponse
34+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
3535
"""
3636
function delete_order(_api::StoreApi, order_id::String; _mediaType=nothing)
3737
_ctx = _oacinternal_delete_order(_api, order_id; _mediaType=_mediaType)
@@ -60,7 +60,7 @@ Returns a map of status codes to quantities
6060
6161
Params:
6262
63-
Return: Dict{String, Int64}, OpenAPI.Clients.ApiResponse
63+
Return: `Dict{String, Int64}`, `OpenAPI.Clients.ApiResponse`
6464
"""
6565
function get_inventory(_api::StoreApi; _mediaType=nothing)
6666
_ctx = _oacinternal_get_inventory(_api; _mediaType=_mediaType)
@@ -94,9 +94,9 @@ end
9494
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
9595
9696
Params:
97-
- order_id::Int64 (required)
97+
- `order_id`::`Int64` (required)
9898
99-
Return: Order, OpenAPI.Clients.ApiResponse
99+
Return: `Order`, `OpenAPI.Clients.ApiResponse`
100100
"""
101101
function get_order_by_id(_api::StoreApi, order_id::Int64; _mediaType=nothing)
102102
_ctx = _oacinternal_get_order_by_id(_api, order_id; _mediaType=_mediaType)
@@ -125,9 +125,9 @@ end
125125
126126
127127
Params:
128-
- order::Order (required)
128+
- `order`::`Order` (required)
129129
130-
Return: Order, OpenAPI.Clients.ApiResponse
130+
Return: `Order`, `OpenAPI.Clients.ApiResponse`
131131
"""
132132
function place_order(_api::StoreApi, order::Order; _mediaType=nothing)
133133
_ctx = _oacinternal_place_order(_api, order; _mediaType=_mediaType)

samples/client/petstore/julia/src/apis/api_UserApi.jl

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ end
2727
This can only be done by the logged in user.
2828
2929
Params:
30-
- user::User (required)
30+
- `user`::`User` (required)
3131
32-
Return: Nothing, OpenAPI.Clients.ApiResponse
32+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
3333
"""
3434
function create_user(_api::UserApi, user::User; _mediaType=nothing)
3535
_ctx = _oacinternal_create_user(_api, user; _mediaType=_mediaType)
@@ -57,9 +57,9 @@ end
5757
5858
5959
Params:
60-
- user::Vector{User} (required)
60+
- `user`::`Vector{User}` (required)
6161
62-
Return: Nothing, OpenAPI.Clients.ApiResponse
62+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
6363
"""
6464
function create_users_with_array_input(_api::UserApi, user::Vector{User}; _mediaType=nothing)
6565
_ctx = _oacinternal_create_users_with_array_input(_api, user; _mediaType=_mediaType)
@@ -87,9 +87,9 @@ end
8787
8888
8989
Params:
90-
- user::Vector{User} (required)
90+
- `user`::`Vector{User}` (required)
9191
92-
Return: Nothing, OpenAPI.Clients.ApiResponse
92+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
9393
"""
9494
function create_users_with_list_input(_api::UserApi, user::Vector{User}; _mediaType=nothing)
9595
_ctx = _oacinternal_create_users_with_list_input(_api, user; _mediaType=_mediaType)
@@ -119,9 +119,9 @@ end
119119
This can only be done by the logged in user.
120120
121121
Params:
122-
- username::String (required)
122+
- `username`::`String` (required)
123123
124-
Return: Nothing, OpenAPI.Clients.ApiResponse
124+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
125125
"""
126126
function delete_user(_api::UserApi, username::String; _mediaType=nothing)
127127
_ctx = _oacinternal_delete_user(_api, username; _mediaType=_mediaType)
@@ -152,9 +152,9 @@ end
152152
153153
154154
Params:
155-
- username::String (required)
155+
- `username`::`String` (required)
156156
157-
Return: User, OpenAPI.Clients.ApiResponse
157+
Return: `User`, `OpenAPI.Clients.ApiResponse`
158158
"""
159159
function get_user_by_name(_api::UserApi, username::String; _mediaType=nothing)
160160
_ctx = _oacinternal_get_user_by_name(_api, username; _mediaType=_mediaType)
@@ -187,10 +187,10 @@ end
187187
188188
189189
Params:
190-
- username::String (required)
191-
- password::String (required)
190+
- `username`::`String` (required)
191+
- `password`::`String` (required)
192192
193-
Return: String, OpenAPI.Clients.ApiResponse
193+
Return: `String`, `OpenAPI.Clients.ApiResponse`
194194
"""
195195
function login_user(_api::UserApi, username::String, password::String; _mediaType=nothing)
196196
_ctx = _oacinternal_login_user(_api, username, password; _mediaType=_mediaType)
@@ -219,7 +219,7 @@ end
219219
220220
Params:
221221
222-
Return: Nothing, OpenAPI.Clients.ApiResponse
222+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
223223
"""
224224
function logout_user(_api::UserApi; _mediaType=nothing)
225225
_ctx = _oacinternal_logout_user(_api; _mediaType=_mediaType)
@@ -249,10 +249,10 @@ end
249249
This can only be done by the logged in user.
250250
251251
Params:
252-
- username::String (required)
253-
- user::User (required)
252+
- `username`::`String` (required)
253+
- `user`::`User` (required)
254254
255-
Return: Nothing, OpenAPI.Clients.ApiResponse
255+
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
256256
"""
257257
function update_user(_api::UserApi, username::String, user::User; _mediaType=nothing)
258258
_ctx = _oacinternal_update_user(_api, username, user; _mediaType=_mediaType)

0 commit comments

Comments
 (0)