forked from loafle/openapi-generator-original
[Julia] Fix docstring parameter formatting with backticks (#22190)
* [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
This commit is contained in:
98
BACKTICK_PLAN.md
Normal file
98
BACKTICK_PLAN.md
Normal file
@@ -0,0 +1,98 @@
|
||||
# Plan: Add Backticks to All Julia Template Documentation
|
||||
|
||||
## Summary
|
||||
Add backticks to all identifiers (parameter names, type names, function names, property names) in Julia template documentation to prevent markdown from misinterpreting underscores as italic formatting.
|
||||
|
||||
## Files Already Fixed ✅
|
||||
1. **julia-client/api.mustache** - Docstrings in generated Julia code (DONE)
|
||||
2. **julia-client/partial_model_doc_oneof.mustache** - Already has backticks
|
||||
3. **julia-client/partial_model_doc_anyof.mustache** - Already has backticks
|
||||
4. **julia-server/partial_model_doc_oneof.mustache** - Already has backticks
|
||||
5. **julia-server/partial_model_doc_anyof.mustache** - Already has backticks
|
||||
|
||||
## Files Needing Changes
|
||||
|
||||
### Priority 1: Markdown API Documentation
|
||||
|
||||
#### 1. julia-client/api_doc.mustache
|
||||
**Issue**: Function signatures and parameter tables don't use backticks
|
||||
|
||||
**Changes needed**:
|
||||
- Line 14: Function signature - wrap `operationId`, `paramName`, `dataType`, `returnType` in backticks
|
||||
- Line 15: Streaming signature - same as above
|
||||
- Line 25: Parameter name `{{paramName}}` → `` `{{paramName}}` ``
|
||||
- Line 26: Data types - add backticks around type names
|
||||
- Line 32: Optional parameter name - add backticks
|
||||
- Line 35-36: Return type - add backticks
|
||||
|
||||
#### 2. julia-server/api_doc.mustache
|
||||
**Issue**: Same as client version
|
||||
|
||||
**Changes needed**:
|
||||
- Line 14: Function signature - wrap `operationId`, `paramName`, `dataType`, `returnType` in backticks
|
||||
- Line 25: Parameter name - add backticks
|
||||
- Line 25: Data types - add backticks
|
||||
- Line 31: Optional parameter name - add backticks
|
||||
- Line 35: Return type - add backticks
|
||||
|
||||
### Priority 2: Markdown Model Documentation
|
||||
|
||||
#### 3. julia-client/model_doc.mustache
|
||||
**Issue**: Property names and types in tables don't use backticks
|
||||
|
||||
**Changes needed**:
|
||||
- Line 13: `**{{name}}**` → `` **`{{name}}`** `` (property names)
|
||||
- Line 13: Type names - wrap `{{dataType}}` in backticks
|
||||
|
||||
#### 4. julia-server/model_doc.mustache
|
||||
**Issue**: Same as client version
|
||||
|
||||
**Changes needed**:
|
||||
- Same as julia-client/model_doc.mustache
|
||||
|
||||
### Priority 3: README Documentation (Optional)
|
||||
|
||||
#### 5. julia-client/README.mustache
|
||||
**Issue**: Identifiers in tables could use backticks for consistency
|
||||
|
||||
**Changes needed** (optional):
|
||||
- Line 32: `` *{{classname}}* `` → `` *`{{classname}}`* ``
|
||||
- Line 32: `` **{{operationId}}** `` → `` **`{{operationId}}`** ``
|
||||
- Line 37: `` {{{classname}}} `` → `` `{{{classname}}}` ``
|
||||
|
||||
#### 6. julia-server/README.mustache
|
||||
**Issue**: Same as client version (if exists)
|
||||
|
||||
## Implementation Strategy
|
||||
|
||||
### Phase 1: API Documentation (High Impact)
|
||||
1. Fix julia-client/api_doc.mustache
|
||||
2. Fix julia-server/api_doc.mustache
|
||||
3. Test with sample regeneration
|
||||
|
||||
### Phase 2: Model Documentation (High Impact)
|
||||
1. Fix julia-client/model_doc.mustache
|
||||
2. Fix julia-server/model_doc.mustache
|
||||
3. Test with sample regeneration
|
||||
|
||||
### Phase 3: README (Low Impact)
|
||||
1. Fix README.mustache files (optional enhancement)
|
||||
2. Final test with sample regeneration
|
||||
|
||||
## Testing Checklist
|
||||
|
||||
After each change:
|
||||
- [ ] Build openapi-generator
|
||||
- [ ] Regenerate Julia client samples: `./bin/generate-samples.sh ./bin/configs/julia-client*`
|
||||
- [ ] Regenerate Julia server samples: `./bin/generate-samples.sh ./bin/configs/julia-server*`
|
||||
- [ ] Verify backticks appear correctly in generated markdown files
|
||||
- [ ] Commit changes with descriptive message
|
||||
|
||||
## Expected Outcome
|
||||
|
||||
All generated markdown documentation will have identifiers wrapped in backticks:
|
||||
- `` `pet_id`::`Int64` `` instead of `pet_id::Int64`
|
||||
- `` `Custom_Type` `` instead of `Custom_Type`
|
||||
- `` `update_pet_with_form` `` instead of `update_pet_with_form`
|
||||
|
||||
This prevents markdown processors from treating underscores as italic markers.
|
||||
@@ -89,10 +89,10 @@ end
|
||||
{{/summary.length}}{{#notes.length}}{{{notes}}}
|
||||
|
||||
{{/notes.length}}Params:
|
||||
{{#allParams}}- {{paramName}}::{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}{{#required}} (required){{/required}}
|
||||
{{#allParams}}- `{{paramName}}`::{{#isBinary}}{{#isFile}}`{{dataType}}`{{/isFile}}{{^isFile}}`Vector{UInt8}`{{/isFile}}{{/isBinary}}{{^isBinary}}`{{dataType}}`{{/isBinary}}{{#required}} (required){{/required}}
|
||||
{{/allParams}}
|
||||
|
||||
Return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Nothing{{/returnType}}, OpenAPI.Clients.ApiResponse
|
||||
Return: {{#returnType}}`{{returnType}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function {{operationId}}(_api::{{classname}}{{#allParams}}{{#required}}, {{paramName}}::{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}{{/required}}{{/allParams}};{{#allParams}}{{^required}} {{paramName}}=nothing,{{/required}}{{/allParams}} _mediaType=nothing)
|
||||
_ctx = _oacinternal_{{operationId}}(_api{{#allParams}}{{#required}}, {{paramName}}{{/required}}{{/allParams}};{{#allParams}}{{^required}} {{paramName}}={{paramName}},{{/required}}{{/allParams}} _mediaType=_mediaType)
|
||||
|
||||
@@ -11,8 +11,8 @@ Method | HTTP request | Description
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
# **{{{operationId}}}**
|
||||
> {{operationId}}(_api::{{classname}}{{#allParams}}{{#required}}, {{paramName}}::{{dataType}}{{/required}}{{/allParams}};{{#allParams}}{{^required}} {{paramName}}=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> {{#returnType}}{{{.}}}{{/returnType}}{{^returnType}}Nothing{{/returnType}}, OpenAPI.Clients.ApiResponse <br/>
|
||||
> {{operationId}}(_api::{{classname}}, response_stream::Channel{{#allParams}}{{#required}}, {{paramName}}::{{dataType}}{{/required}}{{/allParams}};{{#allParams}}{{^required}} {{paramName}}=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> Channel{ {{#returnType}}{{{.}}}{{/returnType}}{{^returnType}}Nothing{{/returnType}} }, OpenAPI.Clients.ApiResponse
|
||||
> `{{operationId}}`(_api::`{{classname}}`{{#allParams}}{{#required}}, `{{paramName}}`::`{{dataType}}`{{/required}}{{/allParams}};{{#allParams}}{{^required}} `{{paramName}}`=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> {{#returnType}}`{{{.}}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `{{operationId}}`(_api::`{{classname}}`, response_stream::`Channel`{{#allParams}}{{#required}}, `{{paramName}}`::`{{dataType}}`{{/required}}{{/allParams}};{{#allParams}}{{^required}} `{{paramName}}`=nothing,{{/required}}{{/allParams}} _mediaType=nothing) -> `Channel`{ {{#returnType}}`{{{.}}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}} }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
{{{summary}}}{{#notes}}
|
||||
|
||||
@@ -22,18 +22,18 @@ Method | HTTP request | Description
|
||||
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **{{classname}}** | API context | {{/-last}}{{/allParams}}{{#allParams}}{{#required}}
|
||||
**{{paramName}}** | {{#isPrimitiveType}}**{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{#isFile}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isFile}}{{/isPrimitiveType}} | {{description}} |{{/required}}{{/allParams}}{{#hasOptionalParams}}
|
||||
**_api** | **`{{classname}}`** | API context | {{/-last}}{{/allParams}}{{#allParams}}{{#required}}
|
||||
**`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}} | {{description}} |{{/required}}{{/allParams}}{{#hasOptionalParams}}
|
||||
|
||||
### Optional Parameters
|
||||
{{#allParams}}{{#-last}}
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}}{{^required}}
|
||||
**{{paramName}}** | {{#isPrimitiveType}}**{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{#isFile}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^isBinary}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}}{{/isBinary}}{{/required}}{{/allParams}}{{/hasOptionalParams}}
|
||||
**`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}{{#isFile}}{{dataType}}{{/isFile}}{{^isFile}}Vector{UInt8}{{/isFile}}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}} | {{description}} | {{^isBinary}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}}{{/isBinary}}{{/required}}{{/allParams}}{{/hasOptionalParams}}
|
||||
|
||||
### Return type
|
||||
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}Nothing{{/returnType}}
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**`{{{returnType}}}`**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**`{{{returnType}}}`**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isDateTime}}**{{{dataType}}}**{{/isDateTime}}{{^isDateTime}}[**{{^isContainer}}*{{/isContainer}}{{{dataType}}}**]({{complexType}}.md){{/isDateTime}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{#vars}}**`{{name}}`** | {{#isPrimitiveType}}**`{{{dataType}}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isDateTime}}**`{{{dataType}}}`**{{/isDateTime}}{{^isDateTime}}[**`{{^isContainer}}*{{/isContainer}}{{{dataType}}}`**]({{complexType}}.md){{/isDateTime}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{/vars}}
|
||||
{{/anyOf}}{{/oneOf}}
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
# **{{{operationId}}}**
|
||||
> {{operationId}}(req::HTTP.Request{{#allParams}}{{#required}}, {{paramName}}::{{#dataType}}{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}{{/dataType}}{{/required}}{{/allParams}};{{#allParams}}{{^required}} {{paramName}}=nothing,{{/required}}{{/allParams}}) -> {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}Nothing{{/returnType}}
|
||||
> `{{operationId}}`(req::`HTTP.Request`{{#allParams}}{{#required}}, `{{paramName}}`::`{{#dataType}}{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}{{/dataType}}`{{/required}}{{/allParams}};{{#allParams}}{{^required}} `{{paramName}}`=nothing,{{/required}}{{/allParams}}) -> {{#returnType}}`{{returnType}}`{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}
|
||||
|
||||
{{{summary}}}{{#notes}}
|
||||
|
||||
@@ -21,18 +21,18 @@ Method | HTTP request | Description
|
||||
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object | {{/-last}}{{/allParams}}{{#allParams}}{{#required}}
|
||||
**{{paramName}}** | {{#isPrimitiveType}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{#isFile}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{/required}}{{/allParams}}{{#hasOptionalParams}}
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object | {{/-last}}{{/allParams}}{{#allParams}}{{#required}}
|
||||
**`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{/required}}{{/allParams}}{{#hasOptionalParams}}
|
||||
|
||||
### Optional Parameters
|
||||
{{#allParams}}{{#-last}}
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}{{#allParams}}{{^required}}
|
||||
**{{paramName}}** | {{#isPrimitiveType}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{#isFile}}**{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}**{{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^isBinary}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}}{{/isBinary}}{{/required}}{{/allParams}}{{/hasOptionalParams}}
|
||||
**`{{paramName}}`** | {{#isPrimitiveType}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**`{{dataType}}`**]({{baseType}}.md){{/isFile}}{{#isFile}}**`{{#isBinary}}Vector{UInt8}{{/isBinary}}{{^isBinary}}{{dataType}}{{/isBinary}}`**{{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^isBinary}}{{#defaultValue}}[default to {{.}}]{{/defaultValue}}{{/isBinary}}{{/required}}{{/allParams}}{{/hasOptionalParams}}
|
||||
|
||||
### Return type
|
||||
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}Nothing{{/returnType}}
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**`{{{returnType}}}`**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**`{{{returnType}}}`**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}`Nothing`{{/returnType}}
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isDateTime}}**{{{dataType}}}**{{/isDateTime}}{{^isDateTime}}[**{{^isContainer}}*{{/isContainer}}{{{dataType}}}**]({{complexType}}.md){{/isDateTime}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{#vars}}**`{{name}}`** | {{#isPrimitiveType}}**`{{{dataType}}}`**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isDateTime}}**`{{{dataType}}}`**{{/isDateTime}}{{^isDateTime}}[**`{{^isContainer}}*{{/isContainer}}{{{dataType}}}`**]({{complexType}}.md){{/isDateTime}}{{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{/vars}}
|
||||
{{/anyOf}}{{/oneOf}}
|
||||
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **Int64** | | [optional] [default to nothing]
|
||||
**type** | **String** | | [optional] [default to nothing]
|
||||
**message** | **String** | | [optional] [default to nothing]
|
||||
**`code`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`type`** | **`String`** | | [optional] [default to nothing]
|
||||
**`message`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**name** | **String** | | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -8,8 +8,8 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **uuid_default_value**
|
||||
> uuid_default_value(_api::FakeApi, uuid_parameter::String; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> uuid_default_value(_api::FakeApi, response_stream::Channel, uuid_parameter::String; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `uuid_default_value`(_api::`FakeApi`, `uuid_parameter`::`String`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `uuid_default_value`(_api::`FakeApi`, response_stream::`Channel`, `uuid_parameter`::`String`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
test uuid default value
|
||||
|
||||
@@ -19,12 +19,12 @@ test uuid default value
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **FakeApi** | API context |
|
||||
**uuid_parameter** | **String** | test uuid default value |
|
||||
**_api** | **`FakeApi`** | API context |
|
||||
**`uuid_parameter`** | **`String`** | test uuid default value |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**mappedProperty** | **Int64** | | [optional] [default to nothing]
|
||||
**uuid_default_value** | **String** | | [optional] [default to nothing]
|
||||
**`mappedProperty`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`uuid_default_value`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**petId** | **Int64** | | [optional] [default to nothing]
|
||||
**quantity** | **Int64** | | [optional] [default to nothing]
|
||||
**shipDate** | **ZonedDateTime** | | [optional] [default to nothing]
|
||||
**status** | **String** | Order Status | [optional] [default to nothing]
|
||||
**complete** | **Bool** | | [optional] [default to false]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`petId`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`quantity`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`shipDate`** | **`ZonedDateTime`** | | [optional] [default to nothing]
|
||||
**`status`** | **`String`** | Order Status | [optional] [default to nothing]
|
||||
**`complete`** | **`Bool`** | | [optional] [default to false]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**category** | [***Category**](Category.md) | | [optional] [default to nothing]
|
||||
**name** | **String** | | [default to nothing]
|
||||
**photoUrls** | **Vector{String}** | | [default to nothing]
|
||||
**tags** | [**Vector{Tag}**](Tag.md) | | [optional] [default to nothing]
|
||||
**status** | **String** | pet status in the store | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`category`** | [**`*Category`**](Category.md) | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [default to nothing]
|
||||
**`photoUrls`** | **`Vector{String}`** | | [default to nothing]
|
||||
**`tags`** | [**`Vector{Tag}`**](Tag.md) | | [optional] [default to nothing]
|
||||
**`status`** | **`String`** | pet status in the store | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -15,8 +15,8 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **add_pet**
|
||||
> add_pet(_api::PetApi, pet::Pet; _mediaType=nothing) -> Pet, OpenAPI.Clients.ApiResponse <br/>
|
||||
> add_pet(_api::PetApi, response_stream::Channel, pet::Pet; _mediaType=nothing) -> Channel{ Pet }, OpenAPI.Clients.ApiResponse
|
||||
> `add_pet`(_api::`PetApi`, `pet`::`Pet`; _mediaType=nothing) -> `Pet`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `add_pet`(_api::`PetApi`, response_stream::`Channel`, `pet`::`Pet`; _mediaType=nothing) -> `Channel`{ `Pet` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Add a new pet to the store
|
||||
|
||||
@@ -26,12 +26,12 @@ Add a new pet to the store
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet** | [**Pet**](Pet.md) | Pet object that needs to be added to the store |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`pet`** | [**`Pet`**](Pet.md) | Pet object that needs to be added to the store |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -45,8 +45,8 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_pet**
|
||||
> delete_pet(_api::PetApi, pet_id::Int64; api_key=nothing, _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> delete_pet(_api::PetApi, response_stream::Channel, pet_id::Int64; api_key=nothing, _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `delete_pet`(_api::`PetApi`, `pet_id`::`Int64`; `api_key`=nothing, _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `delete_pet`(_api::`PetApi`, response_stream::`Channel`, `pet_id`::`Int64`; `api_key`=nothing, _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Deletes a pet
|
||||
|
||||
@@ -56,18 +56,18 @@ Deletes a pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet_id** | **Int64** | Pet id to delete |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`pet_id`** | **`Int64`** | Pet id to delete |
|
||||
|
||||
### Optional Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**api_key** | **String** | | [default to nothing]
|
||||
**`api_key`** | **`String`** | | [default to nothing]
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -81,8 +81,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **find_pets_by_status**
|
||||
> find_pets_by_status(_api::PetApi, status::Vector{String}; _mediaType=nothing) -> Vector{Pet}, OpenAPI.Clients.ApiResponse <br/>
|
||||
> find_pets_by_status(_api::PetApi, response_stream::Channel, status::Vector{String}; _mediaType=nothing) -> Channel{ Vector{Pet} }, OpenAPI.Clients.ApiResponse
|
||||
> `find_pets_by_status`(_api::`PetApi`, `status`::`Vector{String}`; _mediaType=nothing) -> `Vector{Pet}`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `find_pets_by_status`(_api::`PetApi`, response_stream::`Channel`, `status`::`Vector{String}`; _mediaType=nothing) -> `Channel`{ `Vector{Pet}` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Finds Pets by status
|
||||
|
||||
@@ -92,12 +92,12 @@ Multiple status values can be provided with comma separated strings
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**status** | [**Vector{String}**](String.md) | Status values that need to be considered for filter |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`status`** | [**`Vector{String}`**](String.md) | Status values that need to be considered for filter |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Vector{Pet}**](Pet.md)
|
||||
[**`Vector{Pet}`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -111,8 +111,8 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **find_pets_by_tags**
|
||||
> find_pets_by_tags(_api::PetApi, tags::Vector{String}; _mediaType=nothing) -> Vector{Pet}, OpenAPI.Clients.ApiResponse <br/>
|
||||
> find_pets_by_tags(_api::PetApi, response_stream::Channel, tags::Vector{String}; _mediaType=nothing) -> Channel{ Vector{Pet} }, OpenAPI.Clients.ApiResponse
|
||||
> `find_pets_by_tags`(_api::`PetApi`, `tags`::`Vector{String}`; _mediaType=nothing) -> `Vector{Pet}`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `find_pets_by_tags`(_api::`PetApi`, response_stream::`Channel`, `tags`::`Vector{String}`; _mediaType=nothing) -> `Channel`{ `Vector{Pet}` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Finds Pets by tags
|
||||
|
||||
@@ -122,12 +122,12 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**tags** | [**Vector{String}**](String.md) | Tags to filter by |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`tags`** | [**`Vector{String}`**](String.md) | Tags to filter by |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Vector{Pet}**](Pet.md)
|
||||
[**`Vector{Pet}`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -141,8 +141,8 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_pet_by_id**
|
||||
> get_pet_by_id(_api::PetApi, pet_id::Int64; _mediaType=nothing) -> Pet, OpenAPI.Clients.ApiResponse <br/>
|
||||
> get_pet_by_id(_api::PetApi, response_stream::Channel, pet_id::Int64; _mediaType=nothing) -> Channel{ Pet }, OpenAPI.Clients.ApiResponse
|
||||
> `get_pet_by_id`(_api::`PetApi`, `pet_id`::`Int64`; _mediaType=nothing) -> `Pet`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `get_pet_by_id`(_api::`PetApi`, response_stream::`Channel`, `pet_id`::`Int64`; _mediaType=nothing) -> `Channel`{ `Pet` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Find pet by ID
|
||||
|
||||
@@ -152,12 +152,12 @@ Returns a single pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet_id** | **Int64** | ID of pet to return |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`pet_id`** | **`Int64`** | ID of pet to return |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -171,8 +171,8 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_pet**
|
||||
> update_pet(_api::PetApi, pet::Pet; _mediaType=nothing) -> Pet, OpenAPI.Clients.ApiResponse <br/>
|
||||
> update_pet(_api::PetApi, response_stream::Channel, pet::Pet; _mediaType=nothing) -> Channel{ Pet }, OpenAPI.Clients.ApiResponse
|
||||
> `update_pet`(_api::`PetApi`, `pet`::`Pet`; _mediaType=nothing) -> `Pet`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `update_pet`(_api::`PetApi`, response_stream::`Channel`, `pet`::`Pet`; _mediaType=nothing) -> `Channel`{ `Pet` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Update an existing pet
|
||||
|
||||
@@ -182,12 +182,12 @@ Update an existing pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet** | [**Pet**](Pet.md) | Pet object that needs to be added to the store |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`pet`** | [**`Pet`**](Pet.md) | Pet object that needs to be added to the store |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -201,8 +201,8 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_pet_with_form**
|
||||
> update_pet_with_form(_api::PetApi, pet_id::Int64; name=nothing, status=nothing, _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> update_pet_with_form(_api::PetApi, response_stream::Channel, pet_id::Int64; name=nothing, status=nothing, _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `update_pet_with_form`(_api::`PetApi`, `pet_id`::`Int64`; `name`=nothing, `status`=nothing, _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `update_pet_with_form`(_api::`PetApi`, response_stream::`Channel`, `pet_id`::`Int64`; `name`=nothing, `status`=nothing, _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Updates a pet in the store with form data
|
||||
|
||||
@@ -212,19 +212,19 @@ Updates a pet in the store with form data
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet_id** | **Int64** | ID of pet that needs to be updated |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`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]
|
||||
**`name`** | **`String`** | Updated name of the pet | [default to nothing]
|
||||
**`status`** | **`String`** | Updated status of the pet | [default to nothing]
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -238,8 +238,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **upload_file**
|
||||
> upload_file(_api::PetApi, pet_id::Int64; additional_metadata=nothing, file=nothing, _mediaType=nothing) -> ApiResponse, OpenAPI.Clients.ApiResponse <br/>
|
||||
> upload_file(_api::PetApi, response_stream::Channel, pet_id::Int64; additional_metadata=nothing, file=nothing, _mediaType=nothing) -> Channel{ ApiResponse }, OpenAPI.Clients.ApiResponse
|
||||
> `upload_file`(_api::`PetApi`, `pet_id`::`Int64`; `additional_metadata`=nothing, `file`=nothing, _mediaType=nothing) -> `ApiResponse`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `upload_file`(_api::`PetApi`, response_stream::`Channel`, `pet_id`::`Int64`; `additional_metadata`=nothing, `file`=nothing, _mediaType=nothing) -> `Channel`{ `ApiResponse` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
uploads an image
|
||||
|
||||
@@ -249,19 +249,19 @@ uploads an image
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **PetApi** | API context |
|
||||
**pet_id** | **Int64** | ID of pet to update |
|
||||
**_api** | **`PetApi`** | API context |
|
||||
**`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** | **String** | file to upload |
|
||||
**`additional_metadata`** | **`String`** | Additional data to pass to server | [default to nothing]
|
||||
**`file`** | **`String`** | file to upload |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ApiResponse**](ApiResponse.md)
|
||||
[**`ApiResponse`**](ApiResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -11,8 +11,8 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **delete_order**
|
||||
> delete_order(_api::StoreApi, order_id::String; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> delete_order(_api::StoreApi, response_stream::Channel, order_id::String; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `delete_order`(_api::`StoreApi`, `order_id`::`String`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `delete_order`(_api::`StoreApi`, response_stream::`Channel`, `order_id`::`String`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Delete purchase order by ID
|
||||
|
||||
@@ -22,12 +22,12 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **StoreApi** | API context |
|
||||
**order_id** | **String** | ID of the order that needs to be deleted |
|
||||
**_api** | **`StoreApi`** | API context |
|
||||
**`order_id`** | **`String`** | ID of the order that needs to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -41,8 +41,8 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_inventory**
|
||||
> get_inventory(_api::StoreApi; _mediaType=nothing) -> Dict{String, Int64}, OpenAPI.Clients.ApiResponse <br/>
|
||||
> get_inventory(_api::StoreApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Dict{String, Int64} }, OpenAPI.Clients.ApiResponse
|
||||
> `get_inventory`(_api::`StoreApi`; _mediaType=nothing) -> `Dict{String, Int64}`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `get_inventory`(_api::`StoreApi`, response_stream::`Channel`; _mediaType=nothing) -> `Channel`{ `Dict{String, Int64}` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Returns pet inventories by status
|
||||
|
||||
@@ -53,7 +53,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**Dict{String, Int64}**
|
||||
**`Dict{String, Int64}`**
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -67,8 +67,8 @@ This endpoint does not need any parameter.
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_order_by_id**
|
||||
> get_order_by_id(_api::StoreApi, order_id::Int64; _mediaType=nothing) -> Order, OpenAPI.Clients.ApiResponse <br/>
|
||||
> get_order_by_id(_api::StoreApi, response_stream::Channel, order_id::Int64; _mediaType=nothing) -> Channel{ Order }, OpenAPI.Clients.ApiResponse
|
||||
> `get_order_by_id`(_api::`StoreApi`, `order_id`::`Int64`; _mediaType=nothing) -> `Order`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `get_order_by_id`(_api::`StoreApi`, response_stream::`Channel`, `order_id`::`Int64`; _mediaType=nothing) -> `Channel`{ `Order` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Find purchase order by ID
|
||||
|
||||
@@ -78,12 +78,12 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **StoreApi** | API context |
|
||||
**order_id** | **Int64** | ID of pet that needs to be fetched |
|
||||
**_api** | **`StoreApi`** | API context |
|
||||
**`order_id`** | **`Int64`** | ID of pet that needs to be fetched |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Order**](Order.md)
|
||||
[**`Order`**](Order.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -97,8 +97,8 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **place_order**
|
||||
> place_order(_api::StoreApi, order::Order; _mediaType=nothing) -> Order, OpenAPI.Clients.ApiResponse <br/>
|
||||
> place_order(_api::StoreApi, response_stream::Channel, order::Order; _mediaType=nothing) -> Channel{ Order }, OpenAPI.Clients.ApiResponse
|
||||
> `place_order`(_api::`StoreApi`, `order`::`Order`; _mediaType=nothing) -> `Order`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `place_order`(_api::`StoreApi`, response_stream::`Channel`, `order`::`Order`; _mediaType=nothing) -> `Channel`{ `Order` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Place an order for a pet
|
||||
|
||||
@@ -108,12 +108,12 @@ Place an order for a pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **StoreApi** | API context |
|
||||
**order** | [**Order**](Order.md) | order placed for purchasing the pet |
|
||||
**_api** | **`StoreApi`** | API context |
|
||||
**`order`** | [**`Order`**](Order.md) | order placed for purchasing the pet |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Order**](Order.md)
|
||||
[**`Order`**](Order.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**name** | **String** | | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**username** | **String** | | [optional] [default to nothing]
|
||||
**firstName** | **String** | | [optional] [default to nothing]
|
||||
**lastName** | **String** | | [optional] [default to nothing]
|
||||
**email** | **String** | | [optional] [default to nothing]
|
||||
**password** | **String** | | [optional] [default to nothing]
|
||||
**phone** | **String** | | [optional] [default to nothing]
|
||||
**userStatus** | **Int64** | User Status | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`username`** | **`String`** | | [optional] [default to nothing]
|
||||
**`firstName`** | **`String`** | | [optional] [default to nothing]
|
||||
**`lastName`** | **`String`** | | [optional] [default to nothing]
|
||||
**`email`** | **`String`** | | [optional] [default to nothing]
|
||||
**`password`** | **`String`** | | [optional] [default to nothing]
|
||||
**`phone`** | **`String`** | | [optional] [default to nothing]
|
||||
**`userStatus`** | **`Int64`** | User Status | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -15,8 +15,8 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **create_user**
|
||||
> create_user(_api::UserApi, user::User; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> create_user(_api::UserApi, response_stream::Channel, user::User; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `create_user`(_api::`UserApi`, `user`::`User`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `create_user`(_api::`UserApi`, response_stream::`Channel`, `user`::`User`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Create user
|
||||
|
||||
@@ -26,12 +26,12 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**user** | [**User**](User.md) | Created user object |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`user`** | [**`User`**](User.md) | Created user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -45,8 +45,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_users_with_array_input**
|
||||
> create_users_with_array_input(_api::UserApi, user::Vector{User}; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> create_users_with_array_input(_api::UserApi, response_stream::Channel, user::Vector{User}; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `create_users_with_array_input`(_api::`UserApi`, `user`::`Vector{User}`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `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
|
||||
|
||||
@@ -56,12 +56,12 @@ Creates list of users with given input array
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**user** | [**Vector{User}**](User.md) | List of user object |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`user`** | [**`Vector{User}`**](User.md) | List of user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -75,8 +75,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_users_with_list_input**
|
||||
> create_users_with_list_input(_api::UserApi, user::Vector{User}; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> create_users_with_list_input(_api::UserApi, response_stream::Channel, user::Vector{User}; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `create_users_with_list_input`(_api::`UserApi`, `user`::`Vector{User}`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `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
|
||||
|
||||
@@ -86,12 +86,12 @@ Creates list of users with given input array
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**user** | [**Vector{User}**](User.md) | List of user object |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`user`** | [**`Vector{User}`**](User.md) | List of user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -105,8 +105,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_user**
|
||||
> delete_user(_api::UserApi, username::String; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> delete_user(_api::UserApi, response_stream::Channel, username::String; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `delete_user`(_api::`UserApi`, `username`::`String`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `delete_user`(_api::`UserApi`, response_stream::`Channel`, `username`::`String`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Delete user
|
||||
|
||||
@@ -116,12 +116,12 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**username** | **String** | The name that needs to be deleted |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`username`** | **`String`** | The name that needs to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -135,8 +135,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_user_by_name**
|
||||
> get_user_by_name(_api::UserApi, username::String; _mediaType=nothing) -> User, OpenAPI.Clients.ApiResponse <br/>
|
||||
> get_user_by_name(_api::UserApi, response_stream::Channel, username::String; _mediaType=nothing) -> Channel{ User }, OpenAPI.Clients.ApiResponse
|
||||
> `get_user_by_name`(_api::`UserApi`, `username`::`String`; _mediaType=nothing) -> `User`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `get_user_by_name`(_api::`UserApi`, response_stream::`Channel`, `username`::`String`; _mediaType=nothing) -> `Channel`{ `User` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Get user by user name
|
||||
|
||||
@@ -146,12 +146,12 @@ Get user by user name
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**username** | **String** | The name that needs to be fetched. Use user1 for testing. |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`username`** | **`String`** | The name that needs to be fetched. Use user1 for testing. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**User**](User.md)
|
||||
[**`User`**](User.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -165,8 +165,8 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **login_user**
|
||||
> login_user(_api::UserApi, username::String, password::String; _mediaType=nothing) -> String, OpenAPI.Clients.ApiResponse <br/>
|
||||
> login_user(_api::UserApi, response_stream::Channel, username::String, password::String; _mediaType=nothing) -> Channel{ String }, OpenAPI.Clients.ApiResponse
|
||||
> `login_user`(_api::`UserApi`, `username`::`String`, `password`::`String`; _mediaType=nothing) -> `String`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `login_user`(_api::`UserApi`, response_stream::`Channel`, `username`::`String`, `password`::`String`; _mediaType=nothing) -> `Channel`{ `String` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Logs user into the system
|
||||
|
||||
@@ -176,13 +176,13 @@ Logs user into the system
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**username** | **String** | The user name for login |
|
||||
**password** | **String** | The password for login in clear text |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`username`** | **`String`** | The user name for login |
|
||||
**`password`** | **`String`** | The password for login in clear text |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
**`String`**
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -196,8 +196,8 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **logout_user**
|
||||
> logout_user(_api::UserApi; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> logout_user(_api::UserApi, response_stream::Channel; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `logout_user`(_api::`UserApi`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `logout_user`(_api::`UserApi`, response_stream::`Channel`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Logs out current logged in user session
|
||||
|
||||
@@ -208,7 +208,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -222,8 +222,8 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_user**
|
||||
> update_user(_api::UserApi, username::String, user::User; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
|
||||
> update_user(_api::UserApi, response_stream::Channel, username::String, user::User; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
|
||||
> `update_user`(_api::`UserApi`, `username`::`String`, `user`::`User`; _mediaType=nothing) -> `Nothing`, `OpenAPI.Clients.ApiResponse` <br/>
|
||||
> `update_user`(_api::`UserApi`, response_stream::`Channel`, `username`::`String`, `user`::`User`; _mediaType=nothing) -> `Channel`{ `Nothing` }, `OpenAPI.Clients.ApiResponse`
|
||||
|
||||
Updated user
|
||||
|
||||
@@ -233,13 +233,13 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**_api** | **UserApi** | API context |
|
||||
**username** | **String** | name that need to be deleted |
|
||||
**user** | [**User**](User.md) | Updated user object |
|
||||
**_api** | **`UserApi`** | API context |
|
||||
**`username`** | **`String`** | name that need to be deleted |
|
||||
**`user`** | [**`User`**](User.md) | Updated user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -29,9 +29,9 @@ end
|
||||
test uuid default value
|
||||
|
||||
Params:
|
||||
- uuid_parameter::String (required)
|
||||
- `uuid_parameter`::`String` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function uuid_default_value(_api::FakeApi, uuid_parameter::String; _mediaType=nothing)
|
||||
_ctx = _oacinternal_uuid_default_value(_api, uuid_parameter; _mediaType=_mediaType)
|
||||
|
||||
@@ -28,9 +28,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- pet::Pet (required)
|
||||
- `pet`::`Pet` (required)
|
||||
|
||||
Return: Pet, OpenAPI.Clients.ApiResponse
|
||||
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function add_pet(_api::PetApi, pet::Pet; _mediaType=nothing)
|
||||
_ctx = _oacinternal_add_pet(_api, pet; _mediaType=_mediaType)
|
||||
@@ -60,10 +60,10 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- pet_id::Int64 (required)
|
||||
- api_key::String
|
||||
- `pet_id`::`Int64` (required)
|
||||
- `api_key`::`String`
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function delete_pet(_api::PetApi, pet_id::Int64; api_key=nothing, _mediaType=nothing)
|
||||
_ctx = _oacinternal_delete_pet(_api, pet_id; api_key=api_key, _mediaType=_mediaType)
|
||||
@@ -93,9 +93,9 @@ end
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
Params:
|
||||
- status::Vector{String} (required)
|
||||
- `status`::`Vector{String}` (required)
|
||||
|
||||
Return: Vector{Pet}, OpenAPI.Clients.ApiResponse
|
||||
Return: `Vector{Pet}`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function find_pets_by_status(_api::PetApi, status::Vector{String}; _mediaType=nothing)
|
||||
_ctx = _oacinternal_find_pets_by_status(_api, status; _mediaType=_mediaType)
|
||||
@@ -125,9 +125,9 @@ end
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
Params:
|
||||
- tags::Vector{String} (required)
|
||||
- `tags`::`Vector{String}` (required)
|
||||
|
||||
Return: Vector{Pet}, OpenAPI.Clients.ApiResponse
|
||||
Return: `Vector{Pet}`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function find_pets_by_tags(_api::PetApi, tags::Vector{String}; _mediaType=nothing)
|
||||
_ctx = _oacinternal_find_pets_by_tags(_api, tags; _mediaType=_mediaType)
|
||||
@@ -158,9 +158,9 @@ end
|
||||
Returns a single pet
|
||||
|
||||
Params:
|
||||
- pet_id::Int64 (required)
|
||||
- `pet_id`::`Int64` (required)
|
||||
|
||||
Return: Pet, OpenAPI.Clients.ApiResponse
|
||||
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function get_pet_by_id(_api::PetApi, pet_id::Int64; _mediaType=nothing)
|
||||
_ctx = _oacinternal_get_pet_by_id(_api, pet_id; _mediaType=_mediaType)
|
||||
@@ -191,9 +191,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- pet::Pet (required)
|
||||
- `pet`::`Pet` (required)
|
||||
|
||||
Return: Pet, OpenAPI.Clients.ApiResponse
|
||||
Return: `Pet`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function update_pet(_api::PetApi, pet::Pet; _mediaType=nothing)
|
||||
_ctx = _oacinternal_update_pet(_api, pet; _mediaType=_mediaType)
|
||||
@@ -224,11 +224,11 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- pet_id::Int64 (required)
|
||||
- name::String
|
||||
- status::String
|
||||
- `pet_id`::`Int64` (required)
|
||||
- `name`::`String`
|
||||
- `status`::`String`
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function update_pet_with_form(_api::PetApi, pet_id::Int64; name=nothing, status=nothing, _mediaType=nothing)
|
||||
_ctx = _oacinternal_update_pet_with_form(_api, pet_id; name=name, status=status, _mediaType=_mediaType)
|
||||
@@ -259,11 +259,11 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- pet_id::Int64 (required)
|
||||
- additional_metadata::String
|
||||
- file::String
|
||||
- `pet_id`::`Int64` (required)
|
||||
- `additional_metadata`::`String`
|
||||
- `file`::`String`
|
||||
|
||||
Return: ApiResponse, OpenAPI.Clients.ApiResponse
|
||||
Return: `ApiResponse`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function upload_file(_api::PetApi, pet_id::Int64; additional_metadata=nothing, file=nothing, _mediaType=nothing)
|
||||
_ctx = _oacinternal_upload_file(_api, pet_id; additional_metadata=additional_metadata, file=file, _mediaType=_mediaType)
|
||||
|
||||
@@ -29,9 +29,9 @@ end
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
Params:
|
||||
- order_id::String (required)
|
||||
- `order_id`::`String` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function delete_order(_api::StoreApi, order_id::String; _mediaType=nothing)
|
||||
_ctx = _oacinternal_delete_order(_api, order_id; _mediaType=_mediaType)
|
||||
@@ -60,7 +60,7 @@ Returns a map of status codes to quantities
|
||||
|
||||
Params:
|
||||
|
||||
Return: Dict{String, Int64}, OpenAPI.Clients.ApiResponse
|
||||
Return: `Dict{String, Int64}`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function get_inventory(_api::StoreApi; _mediaType=nothing)
|
||||
_ctx = _oacinternal_get_inventory(_api; _mediaType=_mediaType)
|
||||
@@ -94,9 +94,9 @@ end
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
|
||||
|
||||
Params:
|
||||
- order_id::Int64 (required)
|
||||
- `order_id`::`Int64` (required)
|
||||
|
||||
Return: Order, OpenAPI.Clients.ApiResponse
|
||||
Return: `Order`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function get_order_by_id(_api::StoreApi, order_id::Int64; _mediaType=nothing)
|
||||
_ctx = _oacinternal_get_order_by_id(_api, order_id; _mediaType=_mediaType)
|
||||
@@ -125,9 +125,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- order::Order (required)
|
||||
- `order`::`Order` (required)
|
||||
|
||||
Return: Order, OpenAPI.Clients.ApiResponse
|
||||
Return: `Order`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function place_order(_api::StoreApi, order::Order; _mediaType=nothing)
|
||||
_ctx = _oacinternal_place_order(_api, order; _mediaType=_mediaType)
|
||||
|
||||
@@ -27,9 +27,9 @@ end
|
||||
This can only be done by the logged in user.
|
||||
|
||||
Params:
|
||||
- user::User (required)
|
||||
- `user`::`User` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function create_user(_api::UserApi, user::User; _mediaType=nothing)
|
||||
_ctx = _oacinternal_create_user(_api, user; _mediaType=_mediaType)
|
||||
@@ -57,9 +57,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- user::Vector{User} (required)
|
||||
- `user`::`Vector{User}` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function create_users_with_array_input(_api::UserApi, user::Vector{User}; _mediaType=nothing)
|
||||
_ctx = _oacinternal_create_users_with_array_input(_api, user; _mediaType=_mediaType)
|
||||
@@ -87,9 +87,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- user::Vector{User} (required)
|
||||
- `user`::`Vector{User}` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function create_users_with_list_input(_api::UserApi, user::Vector{User}; _mediaType=nothing)
|
||||
_ctx = _oacinternal_create_users_with_list_input(_api, user; _mediaType=_mediaType)
|
||||
@@ -119,9 +119,9 @@ end
|
||||
This can only be done by the logged in user.
|
||||
|
||||
Params:
|
||||
- username::String (required)
|
||||
- `username`::`String` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function delete_user(_api::UserApi, username::String; _mediaType=nothing)
|
||||
_ctx = _oacinternal_delete_user(_api, username; _mediaType=_mediaType)
|
||||
@@ -152,9 +152,9 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- username::String (required)
|
||||
- `username`::`String` (required)
|
||||
|
||||
Return: User, OpenAPI.Clients.ApiResponse
|
||||
Return: `User`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function get_user_by_name(_api::UserApi, username::String; _mediaType=nothing)
|
||||
_ctx = _oacinternal_get_user_by_name(_api, username; _mediaType=_mediaType)
|
||||
@@ -187,10 +187,10 @@ end
|
||||
|
||||
|
||||
Params:
|
||||
- username::String (required)
|
||||
- password::String (required)
|
||||
- `username`::`String` (required)
|
||||
- `password`::`String` (required)
|
||||
|
||||
Return: String, OpenAPI.Clients.ApiResponse
|
||||
Return: `String`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function login_user(_api::UserApi, username::String, password::String; _mediaType=nothing)
|
||||
_ctx = _oacinternal_login_user(_api, username, password; _mediaType=_mediaType)
|
||||
@@ -219,7 +219,7 @@ end
|
||||
|
||||
Params:
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function logout_user(_api::UserApi; _mediaType=nothing)
|
||||
_ctx = _oacinternal_logout_user(_api; _mediaType=_mediaType)
|
||||
@@ -249,10 +249,10 @@ end
|
||||
This can only be done by the logged in user.
|
||||
|
||||
Params:
|
||||
- username::String (required)
|
||||
- user::User (required)
|
||||
- `username`::`String` (required)
|
||||
- `user`::`User` (required)
|
||||
|
||||
Return: Nothing, OpenAPI.Clients.ApiResponse
|
||||
Return: `Nothing`, `OpenAPI.Clients.ApiResponse`
|
||||
"""
|
||||
function update_user(_api::UserApi, username::String, user::User; _mediaType=nothing)
|
||||
_ctx = _oacinternal_update_user(_api, username, user; _mediaType=_mediaType)
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**another_property** | **Int64** | | [optional] [default to nothing]
|
||||
**uuid_default_value** | **String** | | [optional] [default to nothing]
|
||||
**`another_property`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`uuid_default_value`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **Int64** | | [optional] [default to nothing]
|
||||
**type** | **String** | | [optional] [default to nothing]
|
||||
**message** | **String** | | [optional] [default to nothing]
|
||||
**`code`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`type`** | **`String`** | | [optional] [default to nothing]
|
||||
**`message`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**name** | **String** | | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -8,7 +8,7 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **uuid_default_value**
|
||||
> uuid_default_value(req::HTTP.Request, uuid_parameter::String;) -> Nothing
|
||||
> `uuid_default_value`(req::`HTTP.Request`, `uuid_parameter`::`String`;) -> `Nothing`
|
||||
|
||||
test uuid default value
|
||||
|
||||
@@ -18,12 +18,12 @@ test uuid default value
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**uuid_parameter** | **String**| test uuid default value |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`uuid_parameter`** | **`String`**| test uuid default value |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**petId** | **Int64** | | [optional] [default to nothing]
|
||||
**quantity** | **Int64** | | [optional] [default to nothing]
|
||||
**shipDate** | **ZonedDateTime** | | [optional] [default to nothing]
|
||||
**status** | **String** | Order Status | [optional] [default to nothing]
|
||||
**complete** | **Bool** | | [optional] [default to false]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`petId`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`quantity`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`shipDate`** | **`ZonedDateTime`** | | [optional] [default to nothing]
|
||||
**`status`** | **`String`** | Order Status | [optional] [default to nothing]
|
||||
**`complete`** | **`Bool`** | | [optional] [default to false]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**category** | [***Category**](Category.md) | | [optional] [default to nothing]
|
||||
**name** | **String** | | [default to nothing]
|
||||
**photoUrls** | **Vector{String}** | | [default to nothing]
|
||||
**tags** | [**Vector{Tag}**](Tag.md) | | [optional] [default to nothing]
|
||||
**status** | **String** | pet status in the store | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`category`** | [**`*Category`**](Category.md) | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [default to nothing]
|
||||
**`photoUrls`** | **`Vector{String}`** | | [default to nothing]
|
||||
**`tags`** | [**`Vector{Tag}`**](Tag.md) | | [optional] [default to nothing]
|
||||
**`status`** | **`String`** | pet status in the store | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **add_pet**
|
||||
> add_pet(req::HTTP.Request, pet::Pet;) -> Pet
|
||||
> `add_pet`(req::`HTTP.Request`, `pet`::`Pet`;) -> `Pet`
|
||||
|
||||
Add a new pet to the store
|
||||
|
||||
@@ -25,12 +25,12 @@ Add a new pet to the store
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`pet`** | [**`Pet`**](Pet.md)| Pet object that needs to be added to the store |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -44,7 +44,7 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_pet**
|
||||
> delete_pet(req::HTTP.Request, pet_id::Int64; api_key=nothing,) -> Nothing
|
||||
> `delete_pet`(req::`HTTP.Request`, `pet_id`::`Int64`; `api_key`=nothing,) -> `Nothing`
|
||||
|
||||
Deletes a pet
|
||||
|
||||
@@ -54,18 +54,18 @@ Deletes a pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet_id** | **Int64**| Pet id to delete |
|
||||
**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]
|
||||
**`api_key`** | **`String`**| | [default to nothing]
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -79,7 +79,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **find_pets_by_status**
|
||||
> find_pets_by_status(req::HTTP.Request, status::Vector{String};) -> Vector{Pet}
|
||||
> `find_pets_by_status`(req::`HTTP.Request`, `status`::`Vector{String}`;) -> `Vector{Pet}`
|
||||
|
||||
Finds Pets by status
|
||||
|
||||
@@ -89,12 +89,12 @@ Multiple status values can be provided with comma separated strings
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**status** | [**Vector{String}**](String.md)| Status values that need to be considered for filter |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`status`** | [**`Vector{String}`**](String.md)| Status values that need to be considered for filter |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Vector{Pet}**](Pet.md)
|
||||
[**`Vector{Pet}`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -108,7 +108,7 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **find_pets_by_tags**
|
||||
> find_pets_by_tags(req::HTTP.Request, tags::Vector{String};) -> Vector{Pet}
|
||||
> `find_pets_by_tags`(req::`HTTP.Request`, `tags`::`Vector{String}`;) -> `Vector{Pet}`
|
||||
|
||||
Finds Pets by tags
|
||||
|
||||
@@ -118,12 +118,12 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**tags** | [**Vector{String}**](String.md)| Tags to filter by |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`tags`** | [**`Vector{String}`**](String.md)| Tags to filter by |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Vector{Pet}**](Pet.md)
|
||||
[**`Vector{Pet}`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -137,7 +137,7 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_pet_by_id**
|
||||
> get_pet_by_id(req::HTTP.Request, pet_id::Int64;) -> Pet
|
||||
> `get_pet_by_id`(req::`HTTP.Request`, `pet_id`::`Int64`;) -> `Pet`
|
||||
|
||||
Find pet by ID
|
||||
|
||||
@@ -147,12 +147,12 @@ Returns a single pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet_id** | **Int64**| ID of pet to return |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`pet_id`** | **`Int64`**| ID of pet to return |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -166,7 +166,7 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_pet**
|
||||
> update_pet(req::HTTP.Request, pet::Pet;) -> Pet
|
||||
> `update_pet`(req::`HTTP.Request`, `pet`::`Pet`;) -> `Pet`
|
||||
|
||||
Update an existing pet
|
||||
|
||||
@@ -176,12 +176,12 @@ Update an existing pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`pet`** | [**`Pet`**](Pet.md)| Pet object that needs to be added to the store |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Pet**](Pet.md)
|
||||
[**`Pet`**](Pet.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -195,7 +195,7 @@ Name | Type | Description | Notes
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_pet_with_form**
|
||||
> update_pet_with_form(req::HTTP.Request, pet_id::Int64; name=nothing, status=nothing,) -> Nothing
|
||||
> `update_pet_with_form`(req::`HTTP.Request`, `pet_id`::`Int64`; `name`=nothing, `status`=nothing,) -> `Nothing`
|
||||
|
||||
Updates a pet in the store with form data
|
||||
|
||||
@@ -205,19 +205,19 @@ Updates a pet in the store with form data
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet_id** | **Int64**| ID of pet that needs to be updated |
|
||||
**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]
|
||||
**`name`** | **`String`**| Updated name of the pet | [default to nothing]
|
||||
**`status`** | **`String`**| Updated status of the pet | [default to nothing]
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -231,7 +231,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **upload_file**
|
||||
> upload_file(req::HTTP.Request, pet_id::Int64; additional_metadata=nothing, file=nothing,) -> ApiResponse
|
||||
> `upload_file`(req::`HTTP.Request`, `pet_id`::`Int64`; `additional_metadata`=nothing, `file`=nothing,) -> `ApiResponse`
|
||||
|
||||
uploads an image
|
||||
|
||||
@@ -241,19 +241,19 @@ uploads an image
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**pet_id** | **Int64**| ID of pet to update |
|
||||
**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 |
|
||||
**`additional_metadata`** | **`String`**| Additional data to pass to server | [default to nothing]
|
||||
**`file`** | **`Vector{UInt8}`**| file to upload |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ApiResponse**](ApiResponse.md)
|
||||
[**`ApiResponse`**](ApiResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **delete_order**
|
||||
> delete_order(req::HTTP.Request, order_id::String;) -> Nothing
|
||||
> `delete_order`(req::`HTTP.Request`, `order_id`::`String`;) -> `Nothing`
|
||||
|
||||
Delete purchase order by ID
|
||||
|
||||
@@ -21,12 +21,12 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**order_id** | **String**| ID of the order that needs to be deleted |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`order_id`** | **`String`**| ID of the order that needs to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -40,7 +40,7 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_inventory**
|
||||
> get_inventory(req::HTTP.Request;) -> Dict{String, Int64}
|
||||
> `get_inventory`(req::`HTTP.Request`;) -> `Dict{String, Int64}`
|
||||
|
||||
Returns pet inventories by status
|
||||
|
||||
@@ -51,7 +51,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
**Dict{String, Int64}**
|
||||
**`Dict{String, Int64}`**
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -65,7 +65,7 @@ This endpoint does not need any parameter.
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_order_by_id**
|
||||
> get_order_by_id(req::HTTP.Request, order_id::Int64;) -> Order
|
||||
> `get_order_by_id`(req::`HTTP.Request`, `order_id`::`Int64`;) -> `Order`
|
||||
|
||||
Find purchase order by ID
|
||||
|
||||
@@ -75,12 +75,12 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**order_id** | **Int64**| ID of pet that needs to be fetched |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`order_id`** | **`Int64`**| ID of pet that needs to be fetched |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Order**](Order.md)
|
||||
[**`Order`**](Order.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -94,7 +94,7 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **place_order**
|
||||
> place_order(req::HTTP.Request, order::Order;) -> Order
|
||||
> `place_order`(req::`HTTP.Request`, `order`::`Order`;) -> `Order`
|
||||
|
||||
Place an order for a pet
|
||||
|
||||
@@ -104,12 +104,12 @@ Place an order for a pet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**order** | [**Order**](Order.md)| order placed for purchasing the pet |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`order`** | [**`Order`**](Order.md)| order placed for purchasing the pet |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Order**](Order.md)
|
||||
[**`Order`**](Order.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
@@ -4,8 +4,8 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**name** | **String** | | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`name`** | **`String`** | | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -4,14 +4,14 @@
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **Int64** | | [optional] [default to nothing]
|
||||
**username** | **String** | | [optional] [default to nothing]
|
||||
**firstName** | **String** | | [optional] [default to nothing]
|
||||
**lastName** | **String** | | [optional] [default to nothing]
|
||||
**email** | **String** | | [optional] [default to nothing]
|
||||
**password** | **String** | | [optional] [default to nothing]
|
||||
**phone** | **String** | | [optional] [default to nothing]
|
||||
**userStatus** | **Int64** | User Status | [optional] [default to nothing]
|
||||
**`id`** | **`Int64`** | | [optional] [default to nothing]
|
||||
**`username`** | **`String`** | | [optional] [default to nothing]
|
||||
**`firstName`** | **`String`** | | [optional] [default to nothing]
|
||||
**`lastName`** | **`String`** | | [optional] [default to nothing]
|
||||
**`email`** | **`String`** | | [optional] [default to nothing]
|
||||
**`password`** | **`String`** | | [optional] [default to nothing]
|
||||
**`phone`** | **`String`** | | [optional] [default to nothing]
|
||||
**`userStatus`** | **`Int64`** | User Status | [optional] [default to nothing]
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
# **create_user**
|
||||
> create_user(req::HTTP.Request, user::User;) -> Nothing
|
||||
> `create_user`(req::`HTTP.Request`, `user`::`User`;) -> `Nothing`
|
||||
|
||||
Create user
|
||||
|
||||
@@ -25,12 +25,12 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**user** | [**User**](User.md)| Created user object |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`user`** | [**`User`**](User.md)| Created user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -44,7 +44,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_users_with_array_input**
|
||||
> create_users_with_array_input(req::HTTP.Request, user::Vector{User};) -> Nothing
|
||||
> `create_users_with_array_input`(req::`HTTP.Request`, `user`::`Vector{User}`;) -> `Nothing`
|
||||
|
||||
Creates list of users with given input array
|
||||
|
||||
@@ -54,12 +54,12 @@ Creates list of users with given input array
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**user** | [**Vector{User}**](User.md)| List of user object |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`user`** | [**`Vector{User}`**](User.md)| List of user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -73,7 +73,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **create_users_with_list_input**
|
||||
> create_users_with_list_input(req::HTTP.Request, user::Vector{User};) -> Nothing
|
||||
> `create_users_with_list_input`(req::`HTTP.Request`, `user`::`Vector{User}`;) -> `Nothing`
|
||||
|
||||
Creates list of users with given input array
|
||||
|
||||
@@ -83,12 +83,12 @@ Creates list of users with given input array
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**user** | [**Vector{User}**](User.md)| List of user object |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`user`** | [**`Vector{User}`**](User.md)| List of user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -102,7 +102,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **delete_user**
|
||||
> delete_user(req::HTTP.Request, username::String;) -> Nothing
|
||||
> `delete_user`(req::`HTTP.Request`, `username`::`String`;) -> `Nothing`
|
||||
|
||||
Delete user
|
||||
|
||||
@@ -112,12 +112,12 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**username** | **String**| The name that needs to be deleted |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`username`** | **`String`**| The name that needs to be deleted |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -131,7 +131,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **get_user_by_name**
|
||||
> get_user_by_name(req::HTTP.Request, username::String;) -> User
|
||||
> `get_user_by_name`(req::`HTTP.Request`, `username`::`String`;) -> `User`
|
||||
|
||||
Get user by user name
|
||||
|
||||
@@ -141,12 +141,12 @@ Get user by user name
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**username** | **String**| The name that needs to be fetched. Use user1 for testing. |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`username`** | **`String`**| The name that needs to be fetched. Use user1 for testing. |
|
||||
|
||||
### Return type
|
||||
|
||||
[**User**](User.md)
|
||||
[**`User`**](User.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -160,7 +160,7 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **login_user**
|
||||
> login_user(req::HTTP.Request, username::String, password::String;) -> String
|
||||
> `login_user`(req::`HTTP.Request`, `username`::`String`, `password`::`String`;) -> `String`
|
||||
|
||||
Logs user into the system
|
||||
|
||||
@@ -170,13 +170,13 @@ Logs user into the system
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**username** | **String**| The user name for login |
|
||||
**password** | **String**| The password for login in clear text |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`username`** | **`String`**| The user name for login |
|
||||
**`password`** | **`String`**| The password for login in clear text |
|
||||
|
||||
### Return type
|
||||
|
||||
**String**
|
||||
**`String`**
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -190,7 +190,7 @@ No authorization required
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **logout_user**
|
||||
> logout_user(req::HTTP.Request;) -> Nothing
|
||||
> `logout_user`(req::`HTTP.Request`;) -> `Nothing`
|
||||
|
||||
Logs out current logged in user session
|
||||
|
||||
@@ -201,7 +201,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
@@ -215,7 +215,7 @@ Nothing
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **update_user**
|
||||
> update_user(req::HTTP.Request, username::String, user::User;) -> Nothing
|
||||
> `update_user`(req::`HTTP.Request`, `username`::`String`, `user`::`User`;) -> `Nothing`
|
||||
|
||||
Updated user
|
||||
|
||||
@@ -225,13 +225,13 @@ This can only be done by the logged in user.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**req** | **HTTP.Request** | The HTTP Request object |
|
||||
**username** | **String**| name that need to be deleted |
|
||||
**user** | [**User**](User.md)| Updated user object |
|
||||
**req** | **`HTTP.Request`** | The HTTP Request object |
|
||||
**`username`** | **`String`**| name that need to be deleted |
|
||||
**`user`** | [**`User`**](User.md)| Updated user object |
|
||||
|
||||
### Return type
|
||||
|
||||
Nothing
|
||||
`Nothing`
|
||||
|
||||
### Authorization
|
||||
|
||||
|
||||
Reference in New Issue
Block a user