[dart][dart-dio] Update docs for dart-dio-next (#9584)

* remove deprecated author field from all pubspec templates
* improve dart-dio-next readme/markdown documentation
* add a lot of dart-doc to model and API classes
This commit is contained in:
Peter Leibiger 2021-05-27 04:58:37 +02:00 committed by GitHub
parent 62a52bf1e8
commit 6edbc91eeb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
78 changed files with 1107 additions and 452 deletions

View File

@ -2,8 +2,6 @@ name: {{pubName}}
version: {{pubVersion}} version: {{pubVersion}}
description: {{pubDescription}} description: {{pubDescription}}
homepage: {{pubHomepage}} homepage: {{pubHomepage}}
authors:
- '{{{pubAuthor}}} <{{{pubAuthorEmail}}}>'
environment: environment:
sdk: '>=2.7.0 <3.0.0' sdk: '>=2.7.0 <3.0.0'

View File

@ -60,9 +60,9 @@ Please follow the [installation procedure](#installation--usage) and then run th
import 'package:{{pubName}}/{{pubName}}.dart'; import 'package:{{pubName}}/{{pubName}}.dart';
{{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}} {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}
final api = {{classname}}(); final api = {{clientName}}().get{{classname}}();
{{#allParams}} {{#allParams}}
final {{paramName}} = {{#isArray}}[{{/isArray}}{{#isBodyParam}}{{dataType}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isArray}}]{{/isArray}}; // {{{dataType}}} | {{{description}}} final {{{dataType}}} {{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}}
{{/allParams}} {{/allParams}}
try { try {
@ -82,7 +82,7 @@ All URIs are relative to *{{basePath}}*
Class | Method | HTTP request | Description Class | Method | HTTP request | Description
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}[*{{classname}}*]({{modelDocPath}}{{{classname}}}.md) | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
## Documentation For Models ## Documentation For Models

View File

@ -19,9 +19,29 @@ class {{classname}} {
const {{classname}}(this._dio{{#useBuiltValue}}, this._serializers{{/useBuiltValue}}); const {{classname}}(this._dio{{#useBuiltValue}}, this._serializers{{/useBuiltValue}});
{{#operation}} {{#operation}}
/// {{{summary}}} /// {{#summary}}{{.}}{{/summary}}{{^summary}}{{nickname}}{{/summary}}
/// {{notes}}
/// ///
/// {{{notes}}} /// Parameters:
{{#allParams}}
/// * [{{paramName}}] {{#description}}- {{{.}}}{{/description}}
{{/allParams}}
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]{{#returnType}} containing a [Response] with a [{{{returnType}}}] as data{{/returnType}}
/// Throws [DioError] if API call or serialization fails
{{#externalDocs}}
/// {{description}}
/// Also see [{{summary}} Documentation]({{url}})
{{/externalDocs}}
{{#isDeprecated}}
@Deprecated('This operation has been deprecated')
{{/isDeprecated}}
Future<Response<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>> {{nickname}}({ {{#allParams}}{{#isPathParam}} Future<Response<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}>> {{nickname}}({ {{#allParams}}{{#isPathParam}}
required {{{dataType}}} {{paramName}},{{/isPathParam}}{{#isQueryParam}} required {{{dataType}}} {{paramName}},{{/isPathParam}}{{#isQueryParam}}
{{#required}}required {{/required}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}},{{/isQueryParam}}{{#isHeaderParam}} {{#required}}required {{/required}}{{{dataType}}}{{^required}}?{{/required}} {{paramName}},{{/isQueryParam}}{{#isHeaderParam}}

View File

@ -45,17 +45,17 @@ import 'package:{{pubName}}/api.dart';
{{/authMethods}} {{/authMethods}}
{{/hasAuthMethods}} {{/hasAuthMethods}}
var api_instance = new {{classname}}(); final api = {{clientName}}().get{{classname}}();
{{#allParams}} {{#allParams}}
var {{paramName}} = {{#isArray}}[{{/isArray}}{{#isBodyParam}}new {{{dataType}}}(){{/isBodyParam}}{{^isBodyParam}}{{{example}}}{{/isBodyParam}}{{#isArray}}]{{/isArray}}; // {{{dataType}}} | {{{description}}} final {{{dataType}}} {{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}}
{{/allParams}} {{/allParams}}
try { try {
{{#returnType}}var result = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}}); {{#returnType}}final response = {{/returnType}}api.{{{operationId}}}({{#allParams}}{{paramName}}{{^-last}}, {{/-last}}{{/allParams}});
{{#returnType}} {{#returnType}}
print(result); print(response);
{{/returnType}} {{/returnType}}
} catch (e) { } catch on DioError (e) {
print('Exception when calling {{classname}}->{{operationId}}: $e\n'); print('Exception when calling {{classname}}->{{operationId}}: $e\n');
} }
``` ```
@ -64,12 +64,12 @@ try {
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{{dataType}}}**]({{baseType}}.md){{/isPrimitiveType}}| {{{description}}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{{defaultValue}}}]{{/defaultValue}} {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{baseType}}.md){{/isPrimitiveType}}| {{{description}}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{{defaultValue}}}]{{/defaultValue}}
{{/allParams}} {{/allParams}}
### Return type ### Return type
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
### Authorization ### Authorization

View File

@ -8,7 +8,7 @@ import 'package:{{pubName}}/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{{dataType}}}**]({{complexType}}.md){{/isPrimitiveType}} | {{{description}}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{defaultValue}}}]{{/defaultValue}} {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{{description}}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{defaultValue}}}]{{/defaultValue}}
{{/vars}} {{/vars}}
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -2,8 +2,6 @@ name: {{pubName}}
version: {{pubVersion}} version: {{pubVersion}}
description: {{pubDescription}} description: {{pubDescription}}
homepage: {{pubHomepage}} homepage: {{pubHomepage}}
authors:
- '{{{pubAuthor}}} <{{{pubAuthorEmail}}}>'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'

View File

@ -7,8 +7,18 @@ part '{{classFilename}}.g.dart';
Classes with polymorphism or composition may generate unused imports, Classes with polymorphism or composition may generate unused imports,
these need to be ignored for said classes so that there are no lint errors. these need to be ignored for said classes so that there are no lint errors.
}} }}
{{#parentModel}}// ignore_for_file: unused_import{{/parentModel}} {{#parentModel}}
// ignore_for_file: unused_import
{{/parentModel}}
/// {{#description}}{{{.}}}{{/description}}{{^description}}{{classname}}{{/description}}
{{#hasVars}}
///
/// Properties:
{{#allVars}}
/// * [{{{name}}}] {{#description}}- {{{.}}}{{/description}}
{{/allVars}}
{{/hasVars}}
abstract class {{classname}} implements Built<{{classname}}, {{classname}}Builder> { abstract class {{classname}} implements Built<{{classname}}, {{classname}}Builder> {
{{#vars}} {{#vars}}
{{#description}} {{#description}}

View File

@ -5,8 +5,6 @@
name: '{{{pubName}}}' name: '{{{pubName}}}'
version: '{{{pubVersion}}}' version: '{{{pubVersion}}}'
description: '{{{pubDescription}}}' description: '{{{pubDescription}}}'
authors:
- '{{{pubAuthor}}} <{{{pubAuthorEmail}}}>'
homepage: '{{{pubHomepage}}}' homepage: '{{{pubHomepage}}}'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'

View File

@ -46,8 +46,8 @@ Please follow the [installation procedure](#installation--usage) and then run th
import 'package:openapi/openapi.dart'; import 'package:openapi/openapi.dart';
final api = AnotherFakeApi(); final api = Openapi().getAnotherFakeApi();
final modelClient = ModelClient(); // ModelClient | client model final ModelClient modelClient = ; // ModelClient | client model
try { try {
final response = await api.call123testSpecialTags(modelClient); final response = await api.call123testSpecialTags(modelClient);
@ -64,46 +64,46 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
Class | Method | HTTP request | Description Class | Method | HTTP request | Description
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
*AnotherFakeApi* | [**call123testSpecialTags**](doc/AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags [*AnotherFakeApi*](doc/AnotherFakeApi.md) | [**call123testSpecialTags**](doc/AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags
*DefaultApi* | [**fooGet**](doc/DefaultApi.md#fooget) | **GET** /foo | [*DefaultApi*](doc/DefaultApi.md) | [**fooGet**](doc/DefaultApi.md#fooget) | **GET** /foo |
*FakeApi* | [**fakeHealthGet**](doc/FakeApi.md#fakehealthget) | **GET** /fake/health | Health check endpoint [*FakeApi*](doc/FakeApi.md) | [**fakeHealthGet**](doc/FakeApi.md#fakehealthget) | **GET** /fake/health | Health check endpoint
*FakeApi* | [**fakeHttpSignatureTest**](doc/FakeApi.md#fakehttpsignaturetest) | **GET** /fake/http-signature-test | test http signature authentication [*FakeApi*](doc/FakeApi.md) | [**fakeHttpSignatureTest**](doc/FakeApi.md#fakehttpsignaturetest) | **GET** /fake/http-signature-test | test http signature authentication
*FakeApi* | [**fakeOuterBooleanSerialize**](doc/FakeApi.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | [*FakeApi*](doc/FakeApi.md) | [**fakeOuterBooleanSerialize**](doc/FakeApi.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean |
*FakeApi* | [**fakeOuterCompositeSerialize**](doc/FakeApi.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite | [*FakeApi*](doc/FakeApi.md) | [**fakeOuterCompositeSerialize**](doc/FakeApi.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite |
*FakeApi* | [**fakeOuterNumberSerialize**](doc/FakeApi.md#fakeouternumberserialize) | **POST** /fake/outer/number | [*FakeApi*](doc/FakeApi.md) | [**fakeOuterNumberSerialize**](doc/FakeApi.md#fakeouternumberserialize) | **POST** /fake/outer/number |
*FakeApi* | [**fakeOuterStringSerialize**](doc/FakeApi.md#fakeouterstringserialize) | **POST** /fake/outer/string | [*FakeApi*](doc/FakeApi.md) | [**fakeOuterStringSerialize**](doc/FakeApi.md#fakeouterstringserialize) | **POST** /fake/outer/string |
*FakeApi* | [**fakePropertyEnumIntegerSerialize**](doc/FakeApi.md#fakepropertyenumintegerserialize) | **POST** /fake/property/enum-int | [*FakeApi*](doc/FakeApi.md) | [**fakePropertyEnumIntegerSerialize**](doc/FakeApi.md#fakepropertyenumintegerserialize) | **POST** /fake/property/enum-int |
*FakeApi* | [**testBodyWithFileSchema**](doc/FakeApi.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | [*FakeApi*](doc/FakeApi.md) | [**testBodyWithFileSchema**](doc/FakeApi.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema |
*FakeApi* | [**testBodyWithQueryParams**](doc/FakeApi.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | [*FakeApi*](doc/FakeApi.md) | [**testBodyWithQueryParams**](doc/FakeApi.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params |
*FakeApi* | [**testClientModel**](doc/FakeApi.md#testclientmodel) | **PATCH** /fake | To test \&quot;client\&quot; model [*FakeApi*](doc/FakeApi.md) | [**testClientModel**](doc/FakeApi.md#testclientmodel) | **PATCH** /fake | To test \&quot;client\&quot; model
*FakeApi* | [**testEndpointParameters**](doc/FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 [*FakeApi*](doc/FakeApi.md) | [**testEndpointParameters**](doc/FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
*FakeApi* | [**testEnumParameters**](doc/FakeApi.md#testenumparameters) | **GET** /fake | To test enum parameters [*FakeApi*](doc/FakeApi.md) | [**testEnumParameters**](doc/FakeApi.md#testenumparameters) | **GET** /fake | To test enum parameters
*FakeApi* | [**testGroupParameters**](doc/FakeApi.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) [*FakeApi*](doc/FakeApi.md) | [**testGroupParameters**](doc/FakeApi.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)
*FakeApi* | [**testInlineAdditionalProperties**](doc/FakeApi.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties [*FakeApi*](doc/FakeApi.md) | [**testInlineAdditionalProperties**](doc/FakeApi.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties
*FakeApi* | [**testJsonFormData**](doc/FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data [*FakeApi*](doc/FakeApi.md) | [**testJsonFormData**](doc/FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data
*FakeApi* | [**testQueryParameterCollectionFormat**](doc/FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-paramters | [*FakeApi*](doc/FakeApi.md) | [**testQueryParameterCollectionFormat**](doc/FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-paramters |
*FakeClassnameTags123Api* | [**testClassname**](doc/FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case [*FakeClassnameTags123Api*](doc/FakeClassnameTags123Api.md) | [**testClassname**](doc/FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case
*PetApi* | [**addPet**](doc/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store [*PetApi*](doc/PetApi.md) | [**addPet**](doc/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
*PetApi* | [**deletePet**](doc/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet [*PetApi*](doc/PetApi.md) | [**deletePet**](doc/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
*PetApi* | [**findPetsByStatus**](doc/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status [*PetApi*](doc/PetApi.md) | [**findPetsByStatus**](doc/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
*PetApi* | [**findPetsByTags**](doc/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags [*PetApi*](doc/PetApi.md) | [**findPetsByTags**](doc/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
*PetApi* | [**getPetById**](doc/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID [*PetApi*](doc/PetApi.md) | [**getPetById**](doc/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
*PetApi* | [**updatePet**](doc/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet [*PetApi*](doc/PetApi.md) | [**updatePet**](doc/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet
*PetApi* | [**updatePetWithForm**](doc/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data [*PetApi*](doc/PetApi.md) | [**updatePetWithForm**](doc/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
*PetApi* | [**uploadFile**](doc/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image [*PetApi*](doc/PetApi.md) | [**uploadFile**](doc/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
*PetApi* | [**uploadFileWithRequiredFile**](doc/PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) [*PetApi*](doc/PetApi.md) | [**uploadFileWithRequiredFile**](doc/PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
*StoreApi* | [**deleteOrder**](doc/StoreApi.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID [*StoreApi*](doc/StoreApi.md) | [**deleteOrder**](doc/StoreApi.md#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID
*StoreApi* | [**getInventory**](doc/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status [*StoreApi*](doc/StoreApi.md) | [**getInventory**](doc/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
*StoreApi* | [**getOrderById**](doc/StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID [*StoreApi*](doc/StoreApi.md) | [**getOrderById**](doc/StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID
*StoreApi* | [**placeOrder**](doc/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet [*StoreApi*](doc/StoreApi.md) | [**placeOrder**](doc/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
*UserApi* | [**createUser**](doc/UserApi.md#createuser) | **POST** /user | Create user [*UserApi*](doc/UserApi.md) | [**createUser**](doc/UserApi.md#createuser) | **POST** /user | Create user
*UserApi* | [**createUsersWithArrayInput**](doc/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array [*UserApi*](doc/UserApi.md) | [**createUsersWithArrayInput**](doc/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
*UserApi* | [**createUsersWithListInput**](doc/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array [*UserApi*](doc/UserApi.md) | [**createUsersWithListInput**](doc/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
*UserApi* | [**deleteUser**](doc/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user [*UserApi*](doc/UserApi.md) | [**deleteUser**](doc/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
*UserApi* | [**getUserByName**](doc/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name [*UserApi*](doc/UserApi.md) | [**getUserByName**](doc/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
*UserApi* | [**loginUser**](doc/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system [*UserApi*](doc/UserApi.md) | [**loginUser**](doc/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system
*UserApi* | [**logoutUser**](doc/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session [*UserApi*](doc/UserApi.md) | [**logoutUser**](doc/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
*UserApi* | [**updateUser**](doc/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user [*UserApi*](doc/UserApi.md) | [**updateUser**](doc/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
## Documentation For Models ## Documentation For Models

View File

@ -8,8 +8,8 @@ import 'package:openapi/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**mapProperty** | **BuiltMap<String, String>** | | [optional] **mapProperty** | **BuiltMap&lt;String, String&gt;** | | [optional]
**mapOfMapProperty** | [**BuiltMap<String, BuiltMap<String, String>>**](BuiltMap.md) | | [optional] **mapOfMapProperty** | [**BuiltMap&lt;String, BuiltMap&lt;String, String&gt;&gt;**](BuiltMap.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -23,13 +23,13 @@ To test special tags and operation ID starting with number
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new AnotherFakeApi(); final api = Openapi().getAnotherFakeApi();
var modelClient = new ModelClient(); // ModelClient | client model final ModelClient modelClient = ; // ModelClient | client model
try { try {
var result = api_instance.call123testSpecialTags(modelClient); final response = api.call123testSpecialTags(modelClient);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling AnotherFakeApi->call123testSpecialTags: $e\n'); print('Exception when calling AnotherFakeApi->call123testSpecialTags: $e\n');
} }
``` ```

View File

@ -8,7 +8,7 @@ import 'package:openapi/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**arrayArrayNumber** | [**BuiltList<BuiltList<num>>**](BuiltList.md) | | [optional] **arrayArrayNumber** | [**BuiltList&lt;BuiltList&lt;num&gt;&gt;**](BuiltList.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,7 +8,7 @@ import 'package:openapi/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**arrayNumber** | **BuiltList<num>** | | [optional] **arrayNumber** | **BuiltList&lt;num&gt;** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,9 +8,9 @@ import 'package:openapi/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**arrayOfString** | **BuiltList<String>** | | [optional] **arrayOfString** | **BuiltList&lt;String&gt;** | | [optional]
**arrayArrayOfInteger** | [**BuiltList<BuiltList<int>>**](BuiltList.md) | | [optional] **arrayArrayOfInteger** | [**BuiltList&lt;BuiltList&lt;int&gt;&gt;**](BuiltList.md) | | [optional]
**arrayArrayOfModel** | [**BuiltList<BuiltList<ReadOnlyFirst>>**](BuiltList.md) | | [optional] **arrayArrayOfModel** | [**BuiltList&lt;BuiltList&lt;ReadOnlyFirst&gt;&gt;**](BuiltList.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -21,12 +21,12 @@ Method | HTTP request | Description
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new DefaultApi(); final api = Openapi().getDefaultApi();
try { try {
var result = api_instance.fooGet(); final response = api.fooGet();
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling DefaultApi->fooGet: $e\n'); print('Exception when calling DefaultApi->fooGet: $e\n');
} }
``` ```

View File

@ -9,7 +9,7 @@ import 'package:openapi/api.dart';
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**justSymbol** | **String** | | [optional] **justSymbol** | **String** | | [optional]
**arrayEnum** | **BuiltList<String>** | | [optional] **arrayEnum** | **BuiltList&lt;String&gt;** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -36,12 +36,12 @@ Health check endpoint
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
try { try {
var result = api_instance.fakeHealthGet(); final response = api.fakeHealthGet();
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeHealthGet: $e\n'); print('Exception when calling FakeApi->fakeHealthGet: $e\n');
} }
``` ```
@ -76,14 +76,14 @@ import 'package:openapi/api.dart';
//defaultApiClient.getAuthentication<HttpBasicAuth>('http_signature_test').username = 'YOUR_USERNAME' //defaultApiClient.getAuthentication<HttpBasicAuth>('http_signature_test').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('http_signature_test').password = 'YOUR_PASSWORD'; //defaultApiClient.getAuthentication<HttpBasicAuth>('http_signature_test').password = 'YOUR_PASSWORD';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var pet = new Pet(); // Pet | Pet object that needs to be added to the store final Pet pet = ; // Pet | Pet object that needs to be added to the store
var query1 = query1_example; // String | query parameter final String query1 = query1_example; // String | query parameter
var header1 = header1_example; // String | header parameter final String header1 = header1_example; // String | header parameter
try { try {
api_instance.fakeHttpSignatureTest(pet, query1, header1); api.fakeHttpSignatureTest(pet, query1, header1);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeHttpSignatureTest: $e\n'); print('Exception when calling FakeApi->fakeHttpSignatureTest: $e\n');
} }
``` ```
@ -122,13 +122,13 @@ Test serialization of outer boolean types
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var body = new bool(); // bool | Input boolean as post body final bool body = true; // bool | Input boolean as post body
try { try {
var result = api_instance.fakeOuterBooleanSerialize(body); final response = api.fakeOuterBooleanSerialize(body);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeOuterBooleanSerialize: $e\n'); print('Exception when calling FakeApi->fakeOuterBooleanSerialize: $e\n');
} }
``` ```
@ -165,13 +165,13 @@ Test serialization of object with outer number type
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var outerComposite = new OuterComposite(); // OuterComposite | Input composite as post body final OuterComposite outerComposite = ; // OuterComposite | Input composite as post body
try { try {
var result = api_instance.fakeOuterCompositeSerialize(outerComposite); final response = api.fakeOuterCompositeSerialize(outerComposite);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeOuterCompositeSerialize: $e\n'); print('Exception when calling FakeApi->fakeOuterCompositeSerialize: $e\n');
} }
``` ```
@ -208,13 +208,13 @@ Test serialization of outer number types
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var body = new num(); // num | Input number as post body final num body = 8.14; // num | Input number as post body
try { try {
var result = api_instance.fakeOuterNumberSerialize(body); final response = api.fakeOuterNumberSerialize(body);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeOuterNumberSerialize: $e\n'); print('Exception when calling FakeApi->fakeOuterNumberSerialize: $e\n');
} }
``` ```
@ -251,13 +251,13 @@ Test serialization of outer string types
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var body = new String(); // String | Input string as post body final String body = body_example; // String | Input string as post body
try { try {
var result = api_instance.fakeOuterStringSerialize(body); final response = api.fakeOuterStringSerialize(body);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakeOuterStringSerialize: $e\n'); print('Exception when calling FakeApi->fakeOuterStringSerialize: $e\n');
} }
``` ```
@ -294,13 +294,13 @@ Test serialization of enum (int) properties with examples
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var outerObjectWithEnumProperty = new OuterObjectWithEnumProperty(); // OuterObjectWithEnumProperty | Input enum (int) as post body final OuterObjectWithEnumProperty outerObjectWithEnumProperty = ; // OuterObjectWithEnumProperty | Input enum (int) as post body
try { try {
var result = api_instance.fakePropertyEnumIntegerSerialize(outerObjectWithEnumProperty); final response = api.fakePropertyEnumIntegerSerialize(outerObjectWithEnumProperty);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->fakePropertyEnumIntegerSerialize: $e\n'); print('Exception when calling FakeApi->fakePropertyEnumIntegerSerialize: $e\n');
} }
``` ```
@ -337,12 +337,12 @@ For this test, the body for this request much reference a schema named `File`.
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var fileSchemaTestClass = new FileSchemaTestClass(); // FileSchemaTestClass | final FileSchemaTestClass fileSchemaTestClass = ; // FileSchemaTestClass |
try { try {
api_instance.testBodyWithFileSchema(fileSchemaTestClass); api.testBodyWithFileSchema(fileSchemaTestClass);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testBodyWithFileSchema: $e\n'); print('Exception when calling FakeApi->testBodyWithFileSchema: $e\n');
} }
``` ```
@ -377,13 +377,13 @@ No authorization required
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var query = query_example; // String | final String query = query_example; // String |
var user = new User(); // User | final User user = ; // User |
try { try {
api_instance.testBodyWithQueryParams(query, user); api.testBodyWithQueryParams(query, user);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testBodyWithQueryParams: $e\n'); print('Exception when calling FakeApi->testBodyWithQueryParams: $e\n');
} }
``` ```
@ -421,13 +421,13 @@ To test \"client\" model
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var modelClient = new ModelClient(); // ModelClient | client model final ModelClient modelClient = ; // ModelClient | client model
try { try {
var result = api_instance.testClientModel(modelClient); final response = api.testClientModel(modelClient);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testClientModel: $e\n'); print('Exception when calling FakeApi->testClientModel: $e\n');
} }
``` ```
@ -467,25 +467,25 @@ import 'package:openapi/api.dart';
//defaultApiClient.getAuthentication<HttpBasicAuth>('http_basic_test').username = 'YOUR_USERNAME' //defaultApiClient.getAuthentication<HttpBasicAuth>('http_basic_test').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('http_basic_test').password = 'YOUR_PASSWORD'; //defaultApiClient.getAuthentication<HttpBasicAuth>('http_basic_test').password = 'YOUR_PASSWORD';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var number = 8.14; // num | None final num number = 8.14; // num | None
var double_ = 1.2; // double | None final double double_ = 1.2; // double | None
var patternWithoutDelimiter = patternWithoutDelimiter_example; // String | None final String patternWithoutDelimiter = patternWithoutDelimiter_example; // String | None
var byte = BYTE_ARRAY_DATA_HERE; // String | None final String byte = BYTE_ARRAY_DATA_HERE; // String | None
var integer = 56; // int | None final int integer = 56; // int | None
var int32 = 56; // int | None final int int32 = 56; // int | None
var int64 = 789; // int | None final int int64 = 789; // int | None
var float = 3.4; // double | None final double float = 3.4; // double | None
var string = string_example; // String | None final String string = string_example; // String | None
var binary = BINARY_DATA_HERE; // Uint8List | None final Uint8List binary = BINARY_DATA_HERE; // Uint8List | None
var date = 2013-10-20; // Date | None final Date date = 2013-10-20; // Date | None
var dateTime = 2013-10-20T19:20:30+01:00; // DateTime | None final DateTime dateTime = 2013-10-20T19:20:30+01:00; // DateTime | None
var password = password_example; // String | None final String password = password_example; // String | None
var callback = callback_example; // String | None final String callback = callback_example; // String | None
try { try {
api_instance.testEndpointParameters(number, double_, patternWithoutDelimiter, byte, integer, int32, int64, float, string, binary, date, dateTime, password, callback); api.testEndpointParameters(number, double_, patternWithoutDelimiter, byte, integer, int32, int64, float, string, binary, date, dateTime, password, callback);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testEndpointParameters: $e\n'); print('Exception when calling FakeApi->testEndpointParameters: $e\n');
} }
``` ```
@ -535,19 +535,19 @@ To test enum parameters
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var enumHeaderStringArray = []; // BuiltList<String> | Header parameter enum test (string array) final BuiltList<String> enumHeaderStringArray = ; // BuiltList<String> | Header parameter enum test (string array)
var enumHeaderString = enumHeaderString_example; // String | Header parameter enum test (string) final String enumHeaderString = enumHeaderString_example; // String | Header parameter enum test (string)
var enumQueryStringArray = []; // BuiltList<String> | Query parameter enum test (string array) final BuiltList<String> enumQueryStringArray = ; // BuiltList<String> | Query parameter enum test (string array)
var enumQueryString = enumQueryString_example; // String | Query parameter enum test (string) final String enumQueryString = enumQueryString_example; // String | Query parameter enum test (string)
var enumQueryInteger = 56; // int | Query parameter enum test (double) final int enumQueryInteger = 56; // int | Query parameter enum test (double)
var enumQueryDouble = 1.2; // double | Query parameter enum test (double) final double enumQueryDouble = 1.2; // double | Query parameter enum test (double)
var enumFormStringArray = [enumFormStringArray_example]; // BuiltList<String> | Form parameter enum test (string array) final BuiltList<String> enumFormStringArray = enumFormStringArray_example; // BuiltList<String> | Form parameter enum test (string array)
var enumFormString = enumFormString_example; // String | Form parameter enum test (string) final String enumFormString = enumFormString_example; // String | Form parameter enum test (string)
try { try {
api_instance.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString); api.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testEnumParameters: $e\n'); print('Exception when calling FakeApi->testEnumParameters: $e\n');
} }
``` ```
@ -556,13 +556,13 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**enumHeaderStringArray** | [**BuiltList<String>**](String.md)| Header parameter enum test (string array) | [optional] **enumHeaderStringArray** | [**BuiltList&lt;String&gt;**](String.md)| Header parameter enum test (string array) | [optional]
**enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to '-efg'] **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to '-efg']
**enumQueryStringArray** | [**BuiltList<String>**](String.md)| Query parameter enum test (string array) | [optional] **enumQueryStringArray** | [**BuiltList&lt;String&gt;**](String.md)| Query parameter enum test (string array) | [optional]
**enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to '-efg'] **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to '-efg']
**enumQueryInteger** | **int**| Query parameter enum test (double) | [optional] **enumQueryInteger** | **int**| Query parameter enum test (double) | [optional]
**enumQueryDouble** | **double**| Query parameter enum test (double) | [optional] **enumQueryDouble** | **double**| Query parameter enum test (double) | [optional]
**enumFormStringArray** | [**BuiltList<String>**](String.md)| Form parameter enum test (string array) | [optional] [default to '$'] **enumFormStringArray** | [**BuiltList&lt;String&gt;**](String.md)| Form parameter enum test (string array) | [optional] [default to '$']
**enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to '-efg'] **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to '-efg']
### Return type ### Return type
@ -594,17 +594,17 @@ import 'package:openapi/api.dart';
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearer_test').username = 'YOUR_USERNAME' //defaultApiClient.getAuthentication<HttpBasicAuth>('bearer_test').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('bearer_test').password = 'YOUR_PASSWORD'; //defaultApiClient.getAuthentication<HttpBasicAuth>('bearer_test').password = 'YOUR_PASSWORD';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var requiredStringGroup = 56; // int | Required String in group parameters final int requiredStringGroup = 56; // int | Required String in group parameters
var requiredBooleanGroup = true; // bool | Required Boolean in group parameters final bool requiredBooleanGroup = true; // bool | Required Boolean in group parameters
var requiredInt64Group = 789; // int | Required Integer in group parameters final int requiredInt64Group = 789; // int | Required Integer in group parameters
var stringGroup = 56; // int | String in group parameters final int stringGroup = 56; // int | String in group parameters
var booleanGroup = true; // bool | Boolean in group parameters final bool booleanGroup = true; // bool | Boolean in group parameters
var int64Group = 789; // int | Integer in group parameters final int int64Group = 789; // int | Integer in group parameters
try { try {
api_instance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group); api.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testGroupParameters: $e\n'); print('Exception when calling FakeApi->testGroupParameters: $e\n');
} }
``` ```
@ -644,12 +644,12 @@ test inline additionalProperties
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var requestBody = new BuiltMap<String, String>(); // BuiltMap<String, String> | request body final BuiltMap<String, String> requestBody = ; // BuiltMap<String, String> | request body
try { try {
api_instance.testInlineAdditionalProperties(requestBody); api.testInlineAdditionalProperties(requestBody);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testInlineAdditionalProperties: $e\n'); print('Exception when calling FakeApi->testInlineAdditionalProperties: $e\n');
} }
``` ```
@ -658,7 +658,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**requestBody** | [**BuiltMap<String, String>**](String.md)| request body | **requestBody** | [**BuiltMap&lt;String, String&gt;**](String.md)| request body |
### Return type ### Return type
@ -684,13 +684,13 @@ test json serialization of form data
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var param = param_example; // String | field1 final String param = param_example; // String | field1
var param2 = param2_example; // String | field2 final String param2 = param2_example; // String | field2
try { try {
api_instance.testJsonFormData(param, param2); api.testJsonFormData(param, param2);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testJsonFormData: $e\n'); print('Exception when calling FakeApi->testJsonFormData: $e\n');
} }
``` ```
@ -728,16 +728,16 @@ To test the collection format in query parameters
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new FakeApi(); final api = Openapi().getFakeApi();
var pipe = []; // BuiltList<String> | final BuiltList<String> pipe = ; // BuiltList<String> |
var ioutil = []; // BuiltList<String> | final BuiltList<String> ioutil = ; // BuiltList<String> |
var http = []; // BuiltList<String> | final BuiltList<String> http = ; // BuiltList<String> |
var url = []; // BuiltList<String> | final BuiltList<String> url = ; // BuiltList<String> |
var context = []; // BuiltList<String> | final BuiltList<String> context = ; // BuiltList<String> |
try { try {
api_instance.testQueryParameterCollectionFormat(pipe, ioutil, http, url, context); api.testQueryParameterCollectionFormat(pipe, ioutil, http, url, context);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeApi->testQueryParameterCollectionFormat: $e\n'); print('Exception when calling FakeApi->testQueryParameterCollectionFormat: $e\n');
} }
``` ```
@ -746,11 +746,11 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**pipe** | [**BuiltList<String>**](String.md)| | **pipe** | [**BuiltList&lt;String&gt;**](String.md)| |
**ioutil** | [**BuiltList<String>**](String.md)| | **ioutil** | [**BuiltList&lt;String&gt;**](String.md)| |
**http** | [**BuiltList<String>**](String.md)| | **http** | [**BuiltList&lt;String&gt;**](String.md)| |
**url** | [**BuiltList<String>**](String.md)| | **url** | [**BuiltList&lt;String&gt;**](String.md)| |
**context** | [**BuiltList<String>**](String.md)| | **context** | [**BuiltList&lt;String&gt;**](String.md)| |
### Return type ### Return type

View File

@ -27,13 +27,13 @@ import 'package:openapi/api.dart';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed // uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key_query').apiKeyPrefix = 'Bearer'; //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key_query').apiKeyPrefix = 'Bearer';
var api_instance = new FakeClassnameTags123Api(); final api = Openapi().getFakeClassnameTags123Api();
var modelClient = new ModelClient(); // ModelClient | client model final ModelClient modelClient = ; // ModelClient | client model
try { try {
var result = api_instance.testClassname(modelClient); final response = api.testClassname(modelClient);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling FakeClassnameTags123Api->testClassname: $e\n'); print('Exception when calling FakeClassnameTags123Api->testClassname: $e\n');
} }
``` ```

View File

@ -9,7 +9,7 @@ import 'package:openapi/api.dart';
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**file** | [**ModelFile**](ModelFile.md) | | [optional] **file** | [**ModelFile**](ModelFile.md) | | [optional]
**files** | [**BuiltList<ModelFile>**](ModelFile.md) | | [optional] **files** | [**BuiltList&lt;ModelFile&gt;**](ModelFile.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -8,10 +8,10 @@ import 'package:openapi/api.dart';
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**mapMapOfString** | [**BuiltMap<String, BuiltMap<String, String>>**](BuiltMap.md) | | [optional] **mapMapOfString** | [**BuiltMap&lt;String, BuiltMap&lt;String, String&gt;&gt;**](BuiltMap.md) | | [optional]
**mapOfEnumString** | **BuiltMap<String, String>** | | [optional] **mapOfEnumString** | **BuiltMap&lt;String, String&gt;** | | [optional]
**directMap** | **BuiltMap<String, bool>** | | [optional] **directMap** | **BuiltMap&lt;String, bool&gt;** | | [optional]
**indirectMap** | **BuiltMap<String, bool>** | | [optional] **indirectMap** | **BuiltMap&lt;String, bool&gt;** | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -10,7 +10,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**uuid** | **String** | | [optional] **uuid** | **String** | | [optional]
**dateTime** | [**DateTime**](DateTime.md) | | [optional] **dateTime** | [**DateTime**](DateTime.md) | | [optional]
**map** | [**BuiltMap<String, Animal>**](Animal.md) | | [optional] **map** | [**BuiltMap&lt;String, Animal&gt;**](Animal.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -14,12 +14,12 @@ Name | Type | Description | Notes
**stringProp** | **String** | | [optional] **stringProp** | **String** | | [optional]
**dateProp** | [**Date**](Date.md) | | [optional] **dateProp** | [**Date**](Date.md) | | [optional]
**datetimeProp** | [**DateTime**](DateTime.md) | | [optional] **datetimeProp** | [**DateTime**](DateTime.md) | | [optional]
**arrayNullableProp** | [**BuiltList<JsonObject>**](JsonObject.md) | | [optional] **arrayNullableProp** | [**BuiltList&lt;JsonObject&gt;**](JsonObject.md) | | [optional]
**arrayAndItemsNullableProp** | [**BuiltList<JsonObject>**](JsonObject.md) | | [optional] **arrayAndItemsNullableProp** | [**BuiltList&lt;JsonObject&gt;**](JsonObject.md) | | [optional]
**arrayItemsNullable** | [**BuiltList<JsonObject>**](JsonObject.md) | | [optional] **arrayItemsNullable** | [**BuiltList&lt;JsonObject&gt;**](JsonObject.md) | | [optional]
**objectNullableProp** | [**BuiltMap<String, JsonObject>**](JsonObject.md) | | [optional] **objectNullableProp** | [**BuiltMap&lt;String, JsonObject&gt;**](JsonObject.md) | | [optional]
**objectAndItemsNullableProp** | [**BuiltMap<String, JsonObject>**](JsonObject.md) | | [optional] **objectAndItemsNullableProp** | [**BuiltMap&lt;String, JsonObject&gt;**](JsonObject.md) | | [optional]
**objectItemsNullable** | [**BuiltMap<String, JsonObject>**](JsonObject.md) | | [optional] **objectItemsNullable** | [**BuiltMap&lt;String, JsonObject&gt;**](JsonObject.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -11,8 +11,8 @@ Name | Type | Description | Notes
**id** | **int** | | [optional] **id** | **int** | | [optional]
**category** | [**Category**](Category.md) | | [optional] **category** | [**Category**](Category.md) | | [optional]
**name** | **String** | | **name** | **String** | |
**photoUrls** | **BuiltSet<String>** | | **photoUrls** | **BuiltSet&lt;String&gt;** | |
**tags** | [**BuiltList<Tag>**](Tag.md) | | [optional] **tags** | [**BuiltList&lt;Tag&gt;**](Tag.md) | | [optional]
**status** | **String** | pet status in the store | [optional] **status** | **String** | pet status in the store | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -31,12 +31,12 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var pet = new Pet(); // Pet | Pet object that needs to be added to the store final Pet pet = ; // Pet | Pet object that needs to be added to the store
try { try {
api_instance.addPet(pet); api.addPet(pet);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->addPet: $e\n'); print('Exception when calling PetApi->addPet: $e\n');
} }
``` ```
@ -73,13 +73,13 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var petId = 789; // int | Pet id to delete final int petId = 789; // int | Pet id to delete
var apiKey = apiKey_example; // String | final String apiKey = apiKey_example; // String |
try { try {
api_instance.deletePet(petId, apiKey); api.deletePet(petId, apiKey);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->deletePet: $e\n'); print('Exception when calling PetApi->deletePet: $e\n');
} }
``` ```
@ -119,13 +119,13 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var status = []; // BuiltList<String> | Status values that need to be considered for filter final BuiltList<String> status = ; // BuiltList<String> | Status values that need to be considered for filter
try { try {
var result = api_instance.findPetsByStatus(status); final response = api.findPetsByStatus(status);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->findPetsByStatus: $e\n'); print('Exception when calling PetApi->findPetsByStatus: $e\n');
} }
``` ```
@ -134,11 +134,11 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**status** | [**BuiltList<String>**](String.md)| Status values that need to be considered for filter | **status** | [**BuiltList&lt;String&gt;**](String.md)| Status values that need to be considered for filter |
### Return type ### Return type
[**BuiltList<Pet>**](Pet.md) [**BuiltList&lt;Pet&gt;**](Pet.md)
### Authorization ### Authorization
@ -164,13 +164,13 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var tags = []; // BuiltSet<String> | Tags to filter by final BuiltSet<String> tags = ; // BuiltSet<String> | Tags to filter by
try { try {
var result = api_instance.findPetsByTags(tags); final response = api.findPetsByTags(tags);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->findPetsByTags: $e\n'); print('Exception when calling PetApi->findPetsByTags: $e\n');
} }
``` ```
@ -179,11 +179,11 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**tags** | [**BuiltSet<String>**](String.md)| Tags to filter by | **tags** | [**BuiltSet&lt;String&gt;**](String.md)| Tags to filter by |
### Return type ### Return type
[**BuiltSet<Pet>**](Pet.md) [**BuiltSet&lt;Pet&gt;**](Pet.md)
### Authorization ### Authorization
@ -211,13 +211,13 @@ import 'package:openapi/api.dart';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed // uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer'; //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var petId = 789; // int | ID of pet to return final int petId = 789; // int | ID of pet to return
try { try {
var result = api_instance.getPetById(petId); final response = api.getPetById(petId);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->getPetById: $e\n'); print('Exception when calling PetApi->getPetById: $e\n');
} }
``` ```
@ -254,12 +254,12 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var pet = new Pet(); // Pet | Pet object that needs to be added to the store final Pet pet = ; // Pet | Pet object that needs to be added to the store
try { try {
api_instance.updatePet(pet); api.updatePet(pet);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->updatePet: $e\n'); print('Exception when calling PetApi->updatePet: $e\n');
} }
``` ```
@ -296,14 +296,14 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var petId = 789; // int | ID of pet that needs to be updated final int petId = 789; // int | ID of pet that needs to be updated
var name = name_example; // String | Updated name of the pet final String name = name_example; // String | Updated name of the pet
var status = status_example; // String | Updated status of the pet final String status = status_example; // String | Updated status of the pet
try { try {
api_instance.updatePetWithForm(petId, name, status); api.updatePetWithForm(petId, name, status);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->updatePetWithForm: $e\n'); print('Exception when calling PetApi->updatePetWithForm: $e\n');
} }
``` ```
@ -342,15 +342,15 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var petId = 789; // int | ID of pet to update final int petId = 789; // int | ID of pet to update
var additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server final String additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server
var file = BINARY_DATA_HERE; // MultipartFile | file to upload final MultipartFile file = BINARY_DATA_HERE; // MultipartFile | file to upload
try { try {
var result = api_instance.uploadFile(petId, additionalMetadata, file); final response = api.uploadFile(petId, additionalMetadata, file);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->uploadFile: $e\n'); print('Exception when calling PetApi->uploadFile: $e\n');
} }
``` ```
@ -389,15 +389,15 @@ import 'package:openapi/api.dart';
// TODO Configure OAuth2 access token for authorization: petstore_auth // TODO Configure OAuth2 access token for authorization: petstore_auth
//defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN'; //defaultApiClient.getAuthentication<OAuth>('petstore_auth').accessToken = 'YOUR_ACCESS_TOKEN';
var api_instance = new PetApi(); final api = Openapi().getPetApi();
var petId = 789; // int | ID of pet to update final int petId = 789; // int | ID of pet to update
var requiredFile = BINARY_DATA_HERE; // MultipartFile | file to upload final MultipartFile requiredFile = BINARY_DATA_HERE; // MultipartFile | file to upload
var additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server final String additionalMetadata = additionalMetadata_example; // String | Additional data to pass to server
try { try {
var result = api_instance.uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); final response = api.uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling PetApi->uploadFileWithRequiredFile: $e\n'); print('Exception when calling PetApi->uploadFileWithRequiredFile: $e\n');
} }
``` ```

View File

@ -26,12 +26,12 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new StoreApi(); final api = Openapi().getStoreApi();
var orderId = orderId_example; // String | ID of the order that needs to be deleted final String orderId = orderId_example; // String | ID of the order that needs to be deleted
try { try {
api_instance.deleteOrder(orderId); api.deleteOrder(orderId);
} catch (e) { } catch on DioError (e) {
print('Exception when calling StoreApi->deleteOrder: $e\n'); print('Exception when calling StoreApi->deleteOrder: $e\n');
} }
``` ```
@ -72,12 +72,12 @@ import 'package:openapi/api.dart';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed // uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer'; //defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
var api_instance = new StoreApi(); final api = Openapi().getStoreApi();
try { try {
var result = api_instance.getInventory(); final response = api.getInventory();
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling StoreApi->getInventory: $e\n'); print('Exception when calling StoreApi->getInventory: $e\n');
} }
``` ```
@ -87,7 +87,7 @@ This endpoint does not need any parameter.
### Return type ### Return type
**BuiltMap<String, int>** **BuiltMap&lt;String, int&gt;**
### Authorization ### Authorization
@ -111,13 +111,13 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new StoreApi(); final api = Openapi().getStoreApi();
var orderId = 789; // int | ID of pet that needs to be fetched final int orderId = 789; // int | ID of pet that needs to be fetched
try { try {
var result = api_instance.getOrderById(orderId); final response = api.getOrderById(orderId);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling StoreApi->getOrderById: $e\n'); print('Exception when calling StoreApi->getOrderById: $e\n');
} }
``` ```
@ -152,13 +152,13 @@ Place an order for a pet
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new StoreApi(); final api = Openapi().getStoreApi();
var order = new Order(); // Order | order placed for purchasing the pet final Order order = ; // Order | order placed for purchasing the pet
try { try {
var result = api_instance.placeOrder(order); final response = api.placeOrder(order);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling StoreApi->placeOrder: $e\n'); print('Exception when calling StoreApi->placeOrder: $e\n');
} }
``` ```

View File

@ -30,12 +30,12 @@ This can only be done by the logged in user.
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var user = new User(); // User | Created user object final User user = ; // User | Created user object
try { try {
api_instance.createUser(user); api.createUser(user);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->createUser: $e\n'); print('Exception when calling UserApi->createUser: $e\n');
} }
``` ```
@ -70,12 +70,12 @@ Creates list of users with given input array
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var user = [new BuiltList<User>()]; // BuiltList<User> | List of user object final BuiltList<User> user = ; // BuiltList<User> | List of user object
try { try {
api_instance.createUsersWithArrayInput(user); api.createUsersWithArrayInput(user);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->createUsersWithArrayInput: $e\n'); print('Exception when calling UserApi->createUsersWithArrayInput: $e\n');
} }
``` ```
@ -84,7 +84,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**user** | [**BuiltList<User>**](User.md)| List of user object | **user** | [**BuiltList&lt;User&gt;**](User.md)| List of user object |
### Return type ### Return type
@ -110,12 +110,12 @@ Creates list of users with given input array
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var user = [new BuiltList<User>()]; // BuiltList<User> | List of user object final BuiltList<User> user = ; // BuiltList<User> | List of user object
try { try {
api_instance.createUsersWithListInput(user); api.createUsersWithListInput(user);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->createUsersWithListInput: $e\n'); print('Exception when calling UserApi->createUsersWithListInput: $e\n');
} }
``` ```
@ -124,7 +124,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**user** | [**BuiltList<User>**](User.md)| List of user object | **user** | [**BuiltList&lt;User&gt;**](User.md)| List of user object |
### Return type ### Return type
@ -152,12 +152,12 @@ This can only be done by the logged in user.
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var username = username_example; // String | The name that needs to be deleted final String username = username_example; // String | The name that needs to be deleted
try { try {
api_instance.deleteUser(username); api.deleteUser(username);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->deleteUser: $e\n'); print('Exception when calling UserApi->deleteUser: $e\n');
} }
``` ```
@ -192,13 +192,13 @@ Get user by user name
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var username = username_example; // String | The name that needs to be fetched. Use user1 for testing. final String username = username_example; // String | The name that needs to be fetched. Use user1 for testing.
try { try {
var result = api_instance.getUserByName(username); final response = api.getUserByName(username);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->getUserByName: $e\n'); print('Exception when calling UserApi->getUserByName: $e\n');
} }
``` ```
@ -233,14 +233,14 @@ Logs user into the system
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var username = username_example; // String | The user name for login final String username = username_example; // String | The user name for login
var password = password_example; // String | The password for login in clear text final String password = password_example; // String | The password for login in clear text
try { try {
var result = api_instance.loginUser(username, password); final response = api.loginUser(username, password);
print(result); print(response);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->loginUser: $e\n'); print('Exception when calling UserApi->loginUser: $e\n');
} }
``` ```
@ -276,11 +276,11 @@ Logs out current logged in user session
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
try { try {
api_instance.logoutUser(); api.logoutUser();
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->logoutUser: $e\n'); print('Exception when calling UserApi->logoutUser: $e\n');
} }
``` ```
@ -314,13 +314,13 @@ This can only be done by the logged in user.
```dart ```dart
import 'package:openapi/api.dart'; import 'package:openapi/api.dart';
var api_instance = new UserApi(); final api = Openapi().getUserApi();
var username = username_example; // String | name that need to be deleted final String username = username_example; // String | name that need to be deleted
var user = new User(); // User | Updated user object final User user = ; // User | Updated user object
try { try {
api_instance.updateUser(username, user); api.updateUser(username, user);
} catch (e) { } catch on DioError (e) {
print('Exception when calling UserApi->updateUser: $e\n'); print('Exception when calling UserApi->updateUser: $e\n');
} }
``` ```

View File

@ -18,8 +18,19 @@ class AnotherFakeApi {
const AnotherFakeApi(this._dio, this._serializers); const AnotherFakeApi(this._dio, this._serializers);
/// To test special tags /// To test special tags
///
/// To test special tags and operation ID starting with number /// To test special tags and operation ID starting with number
///
/// Parameters:
/// * [modelClient] - client model
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [ModelClient] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<ModelClient>> call123testSpecialTags({ Future<Response<ModelClient>> call123testSpecialTags({
required ModelClient modelClient, required ModelClient modelClient,
CancelToken? cancelToken, CancelToken? cancelToken,

View File

@ -17,9 +17,19 @@ class DefaultApi {
const DefaultApi(this._dio, this._serializers); const DefaultApi(this._dio, this._serializers);
/// fooGet
/// ///
/// ///
/// /// Parameters:
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [InlineResponseDefault] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<InlineResponseDefault>> fooGet({ Future<Response<InlineResponseDefault>> fooGet({
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,

View File

@ -28,8 +28,18 @@ class FakeApi {
const FakeApi(this._dio, this._serializers); const FakeApi(this._dio, this._serializers);
/// Health check endpoint /// Health check endpoint
///
/// ///
///
/// Parameters:
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [HealthCheckResult] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<HealthCheckResult>> fakeHealthGet({ Future<Response<HealthCheckResult>> fakeHealthGet({
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
@ -94,8 +104,21 @@ class FakeApi {
} }
/// test http signature authentication /// test http signature authentication
///
/// ///
///
/// Parameters:
/// * [pet] - Pet object that needs to be added to the store
/// * [query1] - query parameter
/// * [header1] - header parameter
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> fakeHttpSignatureTest({ Future<Response<void>> fakeHttpSignatureTest({
required Pet pet, required Pet pet,
String? query1, String? query1,
@ -162,9 +185,20 @@ class FakeApi {
return _response; return _response;
} }
/// /// fakeOuterBooleanSerialize
///
/// Test serialization of outer boolean types /// Test serialization of outer boolean types
///
/// Parameters:
/// * [body] - Input boolean as post body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [bool] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<bool>> fakeOuterBooleanSerialize({ Future<Response<bool>> fakeOuterBooleanSerialize({
bool? body, bool? body,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -244,9 +278,20 @@ class FakeApi {
); );
} }
/// /// fakeOuterCompositeSerialize
///
/// Test serialization of object with outer number type /// Test serialization of object with outer number type
///
/// Parameters:
/// * [outerComposite] - Input composite as post body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [OuterComposite] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<OuterComposite>> fakeOuterCompositeSerialize({ Future<Response<OuterComposite>> fakeOuterCompositeSerialize({
OuterComposite? outerComposite, OuterComposite? outerComposite,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -331,9 +376,20 @@ class FakeApi {
); );
} }
/// /// fakeOuterNumberSerialize
///
/// Test serialization of outer number types /// Test serialization of outer number types
///
/// Parameters:
/// * [body] - Input number as post body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [num] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<num>> fakeOuterNumberSerialize({ Future<Response<num>> fakeOuterNumberSerialize({
num? body, num? body,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -413,9 +469,20 @@ class FakeApi {
); );
} }
/// /// fakeOuterStringSerialize
///
/// Test serialization of outer string types /// Test serialization of outer string types
///
/// Parameters:
/// * [body] - Input string as post body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [String] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<String>> fakeOuterStringSerialize({ Future<Response<String>> fakeOuterStringSerialize({
String? body, String? body,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -495,9 +562,20 @@ class FakeApi {
); );
} }
/// /// fakePropertyEnumIntegerSerialize
///
/// Test serialization of enum (int) properties with examples /// Test serialization of enum (int) properties with examples
///
/// Parameters:
/// * [outerObjectWithEnumProperty] - Input enum (int) as post body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [OuterObjectWithEnumProperty] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<OuterObjectWithEnumProperty>> fakePropertyEnumIntegerSerialize({ Future<Response<OuterObjectWithEnumProperty>> fakePropertyEnumIntegerSerialize({
required OuterObjectWithEnumProperty outerObjectWithEnumProperty, required OuterObjectWithEnumProperty outerObjectWithEnumProperty,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -582,9 +660,20 @@ class FakeApi {
); );
} }
/// /// testBodyWithFileSchema
/// For this test, the body for this request much reference a schema named &#x60;File&#x60;.
/// ///
/// For this test, the body for this request much reference a schema named `File`. /// Parameters:
/// * [fileSchemaTestClass]
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testBodyWithFileSchema({ Future<Response<void>> testBodyWithFileSchema({
required FileSchemaTestClass fileSchemaTestClass, required FileSchemaTestClass fileSchemaTestClass,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -642,9 +731,21 @@ class FakeApi {
return _response; return _response;
} }
/// testBodyWithQueryParams
/// ///
/// ///
/// /// Parameters:
/// * [query]
/// * [user]
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testBodyWithQueryParams({ Future<Response<void>> testBodyWithQueryParams({
required String query, required String query,
required User user, required User user,
@ -704,9 +805,20 @@ class FakeApi {
return _response; return _response;
} }
/// To test \"client\" model /// To test \&quot;client\&quot; model
/// To test \&quot;client\&quot; model
/// ///
/// To test \"client\" model /// Parameters:
/// * [modelClient] - client model
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [ModelClient] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<ModelClient>> testClientModel({ Future<Response<ModelClient>> testClientModel({
required ModelClient modelClient, required ModelClient modelClient,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -792,8 +904,32 @@ class FakeApi {
} }
/// Fake endpoint for testing various parameters /// Fake endpoint for testing various parameters
///
/// Fake endpoint for testing various parameters /// Fake endpoint for testing various parameters
///
/// Parameters:
/// * [number] - None
/// * [double_] - None
/// * [patternWithoutDelimiter] - None
/// * [byte] - None
/// * [integer] - None
/// * [int32] - None
/// * [int64] - None
/// * [float] - None
/// * [string] - None
/// * [binary] - None
/// * [date] - None
/// * [dateTime] - None
/// * [password] - None
/// * [callback] - None
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testEndpointParameters({ Future<Response<void>> testEndpointParameters({
required num number, required num number,
required double double_, required double double_,
@ -884,8 +1020,26 @@ class FakeApi {
} }
/// To test enum parameters /// To test enum parameters
///
/// To test enum parameters /// To test enum parameters
///
/// Parameters:
/// * [enumHeaderStringArray] - Header parameter enum test (string array)
/// * [enumHeaderString] - Header parameter enum test (string)
/// * [enumQueryStringArray] - Query parameter enum test (string array)
/// * [enumQueryString] - Query parameter enum test (string)
/// * [enumQueryInteger] - Query parameter enum test (double)
/// * [enumQueryDouble] - Query parameter enum test (double)
/// * [enumFormStringArray] - Form parameter enum test (string array)
/// * [enumFormString] - Form parameter enum test (string)
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testEnumParameters({ Future<Response<void>> testEnumParameters({
BuiltList<String>? enumHeaderStringArray, BuiltList<String>? enumHeaderStringArray,
String? enumHeaderString, String? enumHeaderString,
@ -959,8 +1113,24 @@ class FakeApi {
} }
/// Fake endpoint to test group parameters (optional) /// Fake endpoint to test group parameters (optional)
///
/// Fake endpoint to test group parameters (optional) /// Fake endpoint to test group parameters (optional)
///
/// Parameters:
/// * [requiredStringGroup] - Required String in group parameters
/// * [requiredBooleanGroup] - Required Boolean in group parameters
/// * [requiredInt64Group] - Required Integer in group parameters
/// * [stringGroup] - String in group parameters
/// * [booleanGroup] - Boolean in group parameters
/// * [int64Group] - Integer in group parameters
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testGroupParameters({ Future<Response<void>> testGroupParameters({
required int requiredStringGroup, required int requiredStringGroup,
required bool requiredBooleanGroup, required bool requiredBooleanGroup,
@ -1015,8 +1185,19 @@ class FakeApi {
} }
/// test inline additionalProperties /// test inline additionalProperties
///
/// ///
///
/// Parameters:
/// * [requestBody] - request body
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testInlineAdditionalProperties({ Future<Response<void>> testInlineAdditionalProperties({
required BuiltMap<String, String> requestBody, required BuiltMap<String, String> requestBody,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -1075,8 +1256,20 @@ class FakeApi {
} }
/// test json serialization of form data /// test json serialization of form data
///
/// ///
///
/// Parameters:
/// * [param] - field1
/// * [param2] - field2
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testJsonFormData({ Future<Response<void>> testJsonFormData({
required String param, required String param,
required String param2, required String param2,
@ -1137,9 +1330,24 @@ class FakeApi {
return _response; return _response;
} }
/// /// testQueryParameterCollectionFormat
///
/// To test the collection format in query parameters /// To test the collection format in query parameters
///
/// Parameters:
/// * [pipe]
/// * [ioutil]
/// * [http]
/// * [url]
/// * [context]
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> testQueryParameterCollectionFormat({ Future<Response<void>> testQueryParameterCollectionFormat({
required BuiltList<String> pipe, required BuiltList<String> pipe,
required BuiltList<String> ioutil, required BuiltList<String> ioutil,

View File

@ -18,8 +18,19 @@ class FakeClassnameTags123Api {
const FakeClassnameTags123Api(this._dio, this._serializers); const FakeClassnameTags123Api(this._dio, this._serializers);
/// To test class name in snake case /// To test class name in snake case
///
/// To test class name in snake case /// To test class name in snake case
///
/// Parameters:
/// * [modelClient] - client model
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [ModelClient] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<ModelClient>> testClassname({ Future<Response<ModelClient>> testClassname({
required ModelClient modelClient, required ModelClient modelClient,
CancelToken? cancelToken, CancelToken? cancelToken,

View File

@ -21,8 +21,19 @@ class PetApi {
const PetApi(this._dio, this._serializers); const PetApi(this._dio, this._serializers);
/// Add a new pet to the store /// Add a new pet to the store
///
/// ///
///
/// Parameters:
/// * [pet] - Pet object that needs to be added to the store
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> addPet({ Future<Response<void>> addPet({
required Pet pet, required Pet pet,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -86,8 +97,20 @@ class PetApi {
} }
/// Deletes a pet /// Deletes a pet
///
/// ///
///
/// Parameters:
/// * [petId] - Pet id to delete
/// * [apiKey]
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> deletePet({ Future<Response<void>> deletePet({
required int petId, required int petId,
String? apiKey, String? apiKey,
@ -133,8 +156,19 @@ class PetApi {
} }
/// Finds Pets by status /// Finds Pets by status
///
/// Multiple status values can be provided with comma separated strings /// Multiple status values can be provided with comma separated strings
///
/// Parameters:
/// * [status] - Status values that need to be considered for filter
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [BuiltList<Pet>] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<BuiltList<Pet>>> findPetsByStatus({ Future<Response<BuiltList<Pet>>> findPetsByStatus({
required BuiltList<String> status, required BuiltList<String> status,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -206,8 +240,20 @@ class PetApi {
} }
/// Finds Pets by tags /// Finds Pets by tags
///
/// Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. /// Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
///
/// Parameters:
/// * [tags] - Tags to filter by
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [BuiltSet<Pet>] as data
/// Throws [DioError] if API call or serialization fails
@Deprecated('This operation has been deprecated')
Future<Response<BuiltSet<Pet>>> findPetsByTags({ Future<Response<BuiltSet<Pet>>> findPetsByTags({
required BuiltSet<String> tags, required BuiltSet<String> tags,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -279,8 +325,19 @@ class PetApi {
} }
/// Find pet by ID /// Find pet by ID
///
/// Returns a single pet /// Returns a single pet
///
/// Parameters:
/// * [petId] - ID of pet to return
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [Pet] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<Pet>> getPetById({ Future<Response<Pet>> getPetById({
required int petId, required int petId,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -353,8 +410,19 @@ class PetApi {
} }
/// Update an existing pet /// Update an existing pet
///
/// ///
///
/// Parameters:
/// * [pet] - Pet object that needs to be added to the store
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> updatePet({ Future<Response<void>> updatePet({
required Pet pet, required Pet pet,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -418,8 +486,21 @@ class PetApi {
} }
/// Updates a pet in the store with form data /// Updates a pet in the store with form data
///
/// ///
///
/// Parameters:
/// * [petId] - ID of pet that needs to be updated
/// * [name] - Updated name of the pet
/// * [status] - Updated status of the pet
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> updatePetWithForm({ Future<Response<void>> updatePetWithForm({
required int petId, required int petId,
String? name, String? name,
@ -487,8 +568,21 @@ class PetApi {
} }
/// uploads an image /// uploads an image
///
/// ///
///
/// Parameters:
/// * [petId] - ID of pet to update
/// * [additionalMetadata] - Additional data to pass to server
/// * [file] - file to upload
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [ApiResponse] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<ApiResponse>> uploadFile({ Future<Response<ApiResponse>> uploadFile({
required int petId, required int petId,
String? additionalMetadata, String? additionalMetadata,
@ -583,8 +677,21 @@ class PetApi {
} }
/// uploads an image (required) /// uploads an image (required)
///
/// ///
///
/// Parameters:
/// * [petId] - ID of pet to update
/// * [requiredFile] - file to upload
/// * [additionalMetadata] - Additional data to pass to server
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [ApiResponse] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<ApiResponse>> uploadFileWithRequiredFile({ Future<Response<ApiResponse>> uploadFileWithRequiredFile({
required int petId, required int petId,
required MultipartFile requiredFile, required MultipartFile requiredFile,

View File

@ -19,8 +19,19 @@ class StoreApi {
const StoreApi(this._dio, this._serializers); const StoreApi(this._dio, this._serializers);
/// Delete purchase order by ID /// Delete purchase order by ID
/// For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
/// ///
/// For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors /// Parameters:
/// * [orderId] - ID of the order that needs to be deleted
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> deleteOrder({ Future<Response<void>> deleteOrder({
required String orderId, required String orderId,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -59,8 +70,18 @@ class StoreApi {
} }
/// Returns pet inventories by status /// Returns pet inventories by status
///
/// Returns a map of status codes to quantities /// Returns a map of status codes to quantities
///
/// Parameters:
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [BuiltMap<String, int>] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<BuiltMap<String, int>>> getInventory({ Future<Response<BuiltMap<String, int>>> getInventory({
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
@ -132,8 +153,19 @@ class StoreApi {
} }
/// Find purchase order by ID /// Find purchase order by ID
/// For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
/// ///
/// For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions /// Parameters:
/// * [orderId] - ID of pet that needs to be fetched
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [Order] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<Order>> getOrderById({ Future<Response<Order>> getOrderById({
required int orderId, required int orderId,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -199,8 +231,19 @@ class StoreApi {
} }
/// Place an order for a pet /// Place an order for a pet
///
/// ///
///
/// Parameters:
/// * [order] - order placed for purchasing the pet
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [Order] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<Order>> placeOrder({ Future<Response<Order>> placeOrder({
required Order order, required Order order,
CancelToken? cancelToken, CancelToken? cancelToken,

View File

@ -19,8 +19,19 @@ class UserApi {
const UserApi(this._dio, this._serializers); const UserApi(this._dio, this._serializers);
/// Create user /// Create user
///
/// This can only be done by the logged in user. /// This can only be done by the logged in user.
///
/// Parameters:
/// * [user] - Created user object
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> createUser({ Future<Response<void>> createUser({
required User user, required User user,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -79,8 +90,19 @@ class UserApi {
} }
/// Creates list of users with given input array /// Creates list of users with given input array
///
/// ///
///
/// Parameters:
/// * [user] - List of user object
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> createUsersWithArrayInput({ Future<Response<void>> createUsersWithArrayInput({
required BuiltList<User> user, required BuiltList<User> user,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -139,8 +161,19 @@ class UserApi {
} }
/// Creates list of users with given input array /// Creates list of users with given input array
///
/// ///
///
/// Parameters:
/// * [user] - List of user object
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> createUsersWithListInput({ Future<Response<void>> createUsersWithListInput({
required BuiltList<User> user, required BuiltList<User> user,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -199,8 +232,19 @@ class UserApi {
} }
/// Delete user /// Delete user
///
/// This can only be done by the logged in user. /// This can only be done by the logged in user.
///
/// Parameters:
/// * [username] - The name that needs to be deleted
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> deleteUser({ Future<Response<void>> deleteUser({
required String username, required String username,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -239,8 +283,19 @@ class UserApi {
} }
/// Get user by user name /// Get user by user name
///
/// ///
///
/// Parameters:
/// * [username] - The name that needs to be fetched. Use user1 for testing.
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [User] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<User>> getUserByName({ Future<Response<User>> getUserByName({
required String username, required String username,
CancelToken? cancelToken, CancelToken? cancelToken,
@ -306,8 +361,20 @@ class UserApi {
} }
/// Logs user into the system /// Logs user into the system
///
/// ///
///
/// Parameters:
/// * [username] - The user name for login
/// * [password] - The password for login in clear text
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future] containing a [Response] with a [String] as data
/// Throws [DioError] if API call or serialization fails
Future<Response<String>> loginUser({ Future<Response<String>> loginUser({
required String username, required String username,
required String password, required String password,
@ -372,8 +439,18 @@ class UserApi {
} }
/// Logs out current logged in user session /// Logs out current logged in user session
///
/// ///
///
/// Parameters:
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> logoutUser({ Future<Response<void>> logoutUser({
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
@ -411,8 +488,20 @@ class UserApi {
} }
/// Updated user /// Updated user
///
/// This can only be done by the logged in user. /// This can only be done by the logged in user.
///
/// Parameters:
/// * [username] - name that need to be deleted
/// * [user] - Updated user object
/// * [cancelToken] - A [CancelToken] that can be used to cancel the operation
/// * [headers] - Can be used to add additional headers to the request
/// * [extras] - Can be used to add flags to the request
/// * [validateStatus] - A [ValidateStatus] callback that can be used to determine request success based on the HTTP status of the response
/// * [onSendProgress] - A [ProgressCallback] that can be used to get the send progress
/// * [onReceiveProgress] - A [ProgressCallback] that can be used to get the receive progress
///
/// Returns a [Future]
/// Throws [DioError] if API call or serialization fails
Future<Response<void>> updateUser({ Future<Response<void>> updateUser({
required String username, required String username,
required User user, required User user,

View File

@ -8,8 +8,11 @@ import 'package:built_value/serializer.dart';
part 'additional_properties_class.g.dart'; part 'additional_properties_class.g.dart';
/// AdditionalPropertiesClass
///
/// Properties:
/// * [mapProperty]
/// * [mapOfMapProperty]
abstract class AdditionalPropertiesClass implements Built<AdditionalPropertiesClass, AdditionalPropertiesClassBuilder> { abstract class AdditionalPropertiesClass implements Built<AdditionalPropertiesClass, AdditionalPropertiesClassBuilder> {
@BuiltValueField(wireName: r'map_property') @BuiltValueField(wireName: r'map_property')
BuiltMap<String, String>? get mapProperty; BuiltMap<String, String>? get mapProperty;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'animal.g.dart'; part 'animal.g.dart';
/// Animal
///
/// Properties:
/// * [className]
/// * [color]
abstract class Animal implements Built<Animal, AnimalBuilder> { abstract class Animal implements Built<Animal, AnimalBuilder> {
@BuiltValueField(wireName: r'className') @BuiltValueField(wireName: r'className')
String get className; String get className;

View File

@ -7,8 +7,12 @@ import 'package:built_value/serializer.dart';
part 'api_response.g.dart'; part 'api_response.g.dart';
/// ApiResponse
///
/// Properties:
/// * [code]
/// * [type]
/// * [message]
abstract class ApiResponse implements Built<ApiResponse, ApiResponseBuilder> { abstract class ApiResponse implements Built<ApiResponse, ApiResponseBuilder> {
@BuiltValueField(wireName: r'code') @BuiltValueField(wireName: r'code')
int? get code; int? get code;

View File

@ -8,8 +8,10 @@ import 'package:built_value/serializer.dart';
part 'array_of_array_of_number_only.g.dart'; part 'array_of_array_of_number_only.g.dart';
/// ArrayOfArrayOfNumberOnly
///
/// Properties:
/// * [arrayArrayNumber]
abstract class ArrayOfArrayOfNumberOnly implements Built<ArrayOfArrayOfNumberOnly, ArrayOfArrayOfNumberOnlyBuilder> { abstract class ArrayOfArrayOfNumberOnly implements Built<ArrayOfArrayOfNumberOnly, ArrayOfArrayOfNumberOnlyBuilder> {
@BuiltValueField(wireName: r'ArrayArrayNumber') @BuiltValueField(wireName: r'ArrayArrayNumber')
BuiltList<BuiltList<num>>? get arrayArrayNumber; BuiltList<BuiltList<num>>? get arrayArrayNumber;

View File

@ -8,8 +8,10 @@ import 'package:built_value/serializer.dart';
part 'array_of_number_only.g.dart'; part 'array_of_number_only.g.dart';
/// ArrayOfNumberOnly
///
/// Properties:
/// * [arrayNumber]
abstract class ArrayOfNumberOnly implements Built<ArrayOfNumberOnly, ArrayOfNumberOnlyBuilder> { abstract class ArrayOfNumberOnly implements Built<ArrayOfNumberOnly, ArrayOfNumberOnlyBuilder> {
@BuiltValueField(wireName: r'ArrayNumber') @BuiltValueField(wireName: r'ArrayNumber')
BuiltList<num>? get arrayNumber; BuiltList<num>? get arrayNumber;

View File

@ -9,8 +9,12 @@ import 'package:built_value/serializer.dart';
part 'array_test.g.dart'; part 'array_test.g.dart';
/// ArrayTest
///
/// Properties:
/// * [arrayOfString]
/// * [arrayArrayOfInteger]
/// * [arrayArrayOfModel]
abstract class ArrayTest implements Built<ArrayTest, ArrayTestBuilder> { abstract class ArrayTest implements Built<ArrayTest, ArrayTestBuilder> {
@BuiltValueField(wireName: r'array_of_string') @BuiltValueField(wireName: r'array_of_string')
BuiltList<String>? get arrayOfString; BuiltList<String>? get arrayOfString;

View File

@ -7,8 +7,15 @@ import 'package:built_value/serializer.dart';
part 'capitalization.g.dart'; part 'capitalization.g.dart';
/// Capitalization
///
/// Properties:
/// * [smallCamel]
/// * [capitalCamel]
/// * [smallSnake]
/// * [capitalSnake]
/// * [sCAETHFlowPoints]
/// * [ATT_NAME] - Name of the pet
abstract class Capitalization implements Built<Capitalization, CapitalizationBuilder> { abstract class Capitalization implements Built<Capitalization, CapitalizationBuilder> {
@BuiltValueField(wireName: r'smallCamel') @BuiltValueField(wireName: r'smallCamel')
String? get smallCamel; String? get smallCamel;

View File

@ -11,6 +11,12 @@ part 'cat.g.dart';
// ignore_for_file: unused_import // ignore_for_file: unused_import
/// Cat
///
/// Properties:
/// * [className]
/// * [color]
/// * [declawed]
abstract class Cat implements Built<Cat, CatBuilder> { abstract class Cat implements Built<Cat, CatBuilder> {
@BuiltValueField(wireName: r'className') @BuiltValueField(wireName: r'className')
String get className; String get className;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'cat_all_of.g.dart'; part 'cat_all_of.g.dart';
/// CatAllOf
///
/// Properties:
/// * [declawed]
abstract class CatAllOf implements Built<CatAllOf, CatAllOfBuilder> { abstract class CatAllOf implements Built<CatAllOf, CatAllOfBuilder> {
@BuiltValueField(wireName: r'declawed') @BuiltValueField(wireName: r'declawed')
bool? get declawed; bool? get declawed;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'category.g.dart'; part 'category.g.dart';
/// Category
///
/// Properties:
/// * [id]
/// * [name]
abstract class Category implements Built<Category, CategoryBuilder> { abstract class Category implements Built<Category, CategoryBuilder> {
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
int? get id; int? get id;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'class_model.g.dart'; part 'class_model.g.dart';
/// Model for testing model with \"_class\" property
///
/// Properties:
/// * [class_]
abstract class ClassModel implements Built<ClassModel, ClassModelBuilder> { abstract class ClassModel implements Built<ClassModel, ClassModelBuilder> {
@BuiltValueField(wireName: r'_class') @BuiltValueField(wireName: r'_class')
String? get class_; String? get class_;

View File

@ -11,6 +11,12 @@ part 'dog.g.dart';
// ignore_for_file: unused_import // ignore_for_file: unused_import
/// Dog
///
/// Properties:
/// * [className]
/// * [color]
/// * [breed]
abstract class Dog implements Built<Dog, DogBuilder> { abstract class Dog implements Built<Dog, DogBuilder> {
@BuiltValueField(wireName: r'className') @BuiltValueField(wireName: r'className')
String get className; String get className;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'dog_all_of.g.dart'; part 'dog_all_of.g.dart';
/// DogAllOf
///
/// Properties:
/// * [breed]
abstract class DogAllOf implements Built<DogAllOf, DogAllOfBuilder> { abstract class DogAllOf implements Built<DogAllOf, DogAllOfBuilder> {
@BuiltValueField(wireName: r'breed') @BuiltValueField(wireName: r'breed')
String? get breed; String? get breed;

View File

@ -8,8 +8,11 @@ import 'package:built_value/serializer.dart';
part 'enum_arrays.g.dart'; part 'enum_arrays.g.dart';
/// EnumArrays
///
/// Properties:
/// * [justSymbol]
/// * [arrayEnum]
abstract class EnumArrays implements Built<EnumArrays, EnumArraysBuilder> { abstract class EnumArrays implements Built<EnumArrays, EnumArraysBuilder> {
@BuiltValueField(wireName: r'just_symbol') @BuiltValueField(wireName: r'just_symbol')
EnumArraysJustSymbolEnum? get justSymbol; EnumArraysJustSymbolEnum? get justSymbol;

View File

@ -12,8 +12,17 @@ import 'package:built_value/serializer.dart';
part 'enum_test.g.dart'; part 'enum_test.g.dart';
/// EnumTest
///
/// Properties:
/// * [enumString]
/// * [enumStringRequired]
/// * [enumInteger]
/// * [enumNumber]
/// * [outerEnum]
/// * [outerEnumInteger]
/// * [outerEnumDefaultValue]
/// * [outerEnumIntegerDefaultValue]
abstract class EnumTest implements Built<EnumTest, EnumTestBuilder> { abstract class EnumTest implements Built<EnumTest, EnumTestBuilder> {
@BuiltValueField(wireName: r'enum_string') @BuiltValueField(wireName: r'enum_string')
EnumTestEnumStringEnum? get enumString; EnumTestEnumStringEnum? get enumString;

View File

@ -9,8 +9,11 @@ import 'package:built_value/serializer.dart';
part 'file_schema_test_class.g.dart'; part 'file_schema_test_class.g.dart';
/// FileSchemaTestClass
///
/// Properties:
/// * [file]
/// * [files]
abstract class FileSchemaTestClass implements Built<FileSchemaTestClass, FileSchemaTestClassBuilder> { abstract class FileSchemaTestClass implements Built<FileSchemaTestClass, FileSchemaTestClassBuilder> {
@BuiltValueField(wireName: r'file') @BuiltValueField(wireName: r'file')
ModelFile? get file; ModelFile? get file;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'foo.g.dart'; part 'foo.g.dart';
/// Foo
///
/// Properties:
/// * [bar]
abstract class Foo implements Built<Foo, FooBuilder> { abstract class Foo implements Built<Foo, FooBuilder> {
@BuiltValueField(wireName: r'bar') @BuiltValueField(wireName: r'bar')
String? get bar; String? get bar;

View File

@ -9,8 +9,25 @@ import 'package:built_value/serializer.dart';
part 'format_test.g.dart'; part 'format_test.g.dart';
/// FormatTest
///
/// Properties:
/// * [integer]
/// * [int32]
/// * [int64]
/// * [number]
/// * [float]
/// * [double_]
/// * [decimal]
/// * [string]
/// * [byte]
/// * [binary]
/// * [date]
/// * [dateTime]
/// * [uuid]
/// * [password]
/// * [patternWithDigits] - A string that is a 10 digit number. Can have leading zeros.
/// * [patternWithDigitsAndDelimiter] - A string starting with 'image_' (case insensitive) and one to three digits following i.e. Image_01.
abstract class FormatTest implements Built<FormatTest, FormatTestBuilder> { abstract class FormatTest implements Built<FormatTest, FormatTestBuilder> {
@BuiltValueField(wireName: r'integer') @BuiltValueField(wireName: r'integer')
int? get integer; int? get integer;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'has_only_read_only.g.dart'; part 'has_only_read_only.g.dart';
/// HasOnlyReadOnly
///
/// Properties:
/// * [bar]
/// * [foo]
abstract class HasOnlyReadOnly implements Built<HasOnlyReadOnly, HasOnlyReadOnlyBuilder> { abstract class HasOnlyReadOnly implements Built<HasOnlyReadOnly, HasOnlyReadOnlyBuilder> {
@BuiltValueField(wireName: r'bar') @BuiltValueField(wireName: r'bar')
String? get bar; String? get bar;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'health_check_result.g.dart'; part 'health_check_result.g.dart';
/// Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model.
///
/// Properties:
/// * [nullableMessage]
abstract class HealthCheckResult implements Built<HealthCheckResult, HealthCheckResultBuilder> { abstract class HealthCheckResult implements Built<HealthCheckResult, HealthCheckResultBuilder> {
@BuiltValueField(wireName: r'NullableMessage') @BuiltValueField(wireName: r'NullableMessage')
String? get nullableMessage; String? get nullableMessage;

View File

@ -8,8 +8,10 @@ import 'package:built_value/serializer.dart';
part 'inline_response_default.g.dart'; part 'inline_response_default.g.dart';
/// InlineResponseDefault
///
/// Properties:
/// * [string]
abstract class InlineResponseDefault implements Built<InlineResponseDefault, InlineResponseDefaultBuilder> { abstract class InlineResponseDefault implements Built<InlineResponseDefault, InlineResponseDefaultBuilder> {
@BuiltValueField(wireName: r'string') @BuiltValueField(wireName: r'string')
Foo? get string; Foo? get string;

View File

@ -8,8 +8,13 @@ import 'package:built_value/serializer.dart';
part 'map_test.g.dart'; part 'map_test.g.dart';
/// MapTest
///
/// Properties:
/// * [mapMapOfString]
/// * [mapOfEnumString]
/// * [directMap]
/// * [indirectMap]
abstract class MapTest implements Built<MapTest, MapTestBuilder> { abstract class MapTest implements Built<MapTest, MapTestBuilder> {
@BuiltValueField(wireName: r'map_map_of_string') @BuiltValueField(wireName: r'map_map_of_string')
BuiltMap<String, BuiltMap<String, String>>? get mapMapOfString; BuiltMap<String, BuiltMap<String, String>>? get mapMapOfString;

View File

@ -9,8 +9,12 @@ import 'package:built_value/serializer.dart';
part 'mixed_properties_and_additional_properties_class.g.dart'; part 'mixed_properties_and_additional_properties_class.g.dart';
/// MixedPropertiesAndAdditionalPropertiesClass
///
/// Properties:
/// * [uuid]
/// * [dateTime]
/// * [map]
abstract class MixedPropertiesAndAdditionalPropertiesClass implements Built<MixedPropertiesAndAdditionalPropertiesClass, MixedPropertiesAndAdditionalPropertiesClassBuilder> { abstract class MixedPropertiesAndAdditionalPropertiesClass implements Built<MixedPropertiesAndAdditionalPropertiesClass, MixedPropertiesAndAdditionalPropertiesClassBuilder> {
@BuiltValueField(wireName: r'uuid') @BuiltValueField(wireName: r'uuid')
String? get uuid; String? get uuid;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'model200_response.g.dart'; part 'model200_response.g.dart';
/// Model for testing model name starting with number
///
/// Properties:
/// * [name]
/// * [class_]
abstract class Model200Response implements Built<Model200Response, Model200ResponseBuilder> { abstract class Model200Response implements Built<Model200Response, Model200ResponseBuilder> {
@BuiltValueField(wireName: r'name') @BuiltValueField(wireName: r'name')
int? get name; int? get name;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'model_client.g.dart'; part 'model_client.g.dart';
/// ModelClient
///
/// Properties:
/// * [client]
abstract class ModelClient implements Built<ModelClient, ModelClientBuilder> { abstract class ModelClient implements Built<ModelClient, ModelClientBuilder> {
@BuiltValueField(wireName: r'client') @BuiltValueField(wireName: r'client')
String? get client; String? get client;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'model_file.g.dart'; part 'model_file.g.dart';
/// Must be named `File` for test.
///
/// Properties:
/// * [sourceURI] - Test capitalization
abstract class ModelFile implements Built<ModelFile, ModelFileBuilder> { abstract class ModelFile implements Built<ModelFile, ModelFileBuilder> {
/// Test capitalization /// Test capitalization
@BuiltValueField(wireName: r'sourceURI') @BuiltValueField(wireName: r'sourceURI')

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'model_list.g.dart'; part 'model_list.g.dart';
/// ModelList
///
/// Properties:
/// * [n123list]
abstract class ModelList implements Built<ModelList, ModelListBuilder> { abstract class ModelList implements Built<ModelList, ModelListBuilder> {
@BuiltValueField(wireName: r'123-list') @BuiltValueField(wireName: r'123-list')
String? get n123list; String? get n123list;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'model_return.g.dart'; part 'model_return.g.dart';
/// Model for testing reserved words
///
/// Properties:
/// * [return_]
abstract class ModelReturn implements Built<ModelReturn, ModelReturnBuilder> { abstract class ModelReturn implements Built<ModelReturn, ModelReturnBuilder> {
@BuiltValueField(wireName: r'return') @BuiltValueField(wireName: r'return')
int? get return_; int? get return_;

View File

@ -7,8 +7,13 @@ import 'package:built_value/serializer.dart';
part 'name.g.dart'; part 'name.g.dart';
/// Model for testing model name same as property name
///
/// Properties:
/// * [name]
/// * [snakeCase]
/// * [property]
/// * [n123number]
abstract class Name implements Built<Name, NameBuilder> { abstract class Name implements Built<Name, NameBuilder> {
@BuiltValueField(wireName: r'name') @BuiltValueField(wireName: r'name')
int get name; int get name;

View File

@ -10,8 +10,21 @@ import 'package:built_value/serializer.dart';
part 'nullable_class.g.dart'; part 'nullable_class.g.dart';
/// NullableClass
///
/// Properties:
/// * [integerProp]
/// * [numberProp]
/// * [booleanProp]
/// * [stringProp]
/// * [dateProp]
/// * [datetimeProp]
/// * [arrayNullableProp]
/// * [arrayAndItemsNullableProp]
/// * [arrayItemsNullable]
/// * [objectNullableProp]
/// * [objectAndItemsNullableProp]
/// * [objectItemsNullable]
abstract class NullableClass implements Built<NullableClass, NullableClassBuilder> { abstract class NullableClass implements Built<NullableClass, NullableClassBuilder> {
@BuiltValueField(wireName: r'integer_prop') @BuiltValueField(wireName: r'integer_prop')
int? get integerProp; int? get integerProp;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'number_only.g.dart'; part 'number_only.g.dart';
/// NumberOnly
///
/// Properties:
/// * [justNumber]
abstract class NumberOnly implements Built<NumberOnly, NumberOnlyBuilder> { abstract class NumberOnly implements Built<NumberOnly, NumberOnlyBuilder> {
@BuiltValueField(wireName: r'JustNumber') @BuiltValueField(wireName: r'JustNumber')
num? get justNumber; num? get justNumber;

View File

@ -8,8 +8,15 @@ import 'package:built_value/serializer.dart';
part 'order.g.dart'; part 'order.g.dart';
/// Order
///
/// Properties:
/// * [id]
/// * [petId]
/// * [quantity]
/// * [shipDate]
/// * [status] - Order Status
/// * [complete]
abstract class Order implements Built<Order, OrderBuilder> { abstract class Order implements Built<Order, OrderBuilder> {
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
int? get id; int? get id;

View File

@ -7,8 +7,12 @@ import 'package:built_value/serializer.dart';
part 'outer_composite.g.dart'; part 'outer_composite.g.dart';
/// OuterComposite
///
/// Properties:
/// * [myNumber]
/// * [myString]
/// * [myBoolean]
abstract class OuterComposite implements Built<OuterComposite, OuterCompositeBuilder> { abstract class OuterComposite implements Built<OuterComposite, OuterCompositeBuilder> {
@BuiltValueField(wireName: r'my_number') @BuiltValueField(wireName: r'my_number')
num? get myNumber; num? get myNumber;

View File

@ -8,8 +8,10 @@ import 'package:built_value/serializer.dart';
part 'outer_object_with_enum_property.g.dart'; part 'outer_object_with_enum_property.g.dart';
/// OuterObjectWithEnumProperty
///
/// Properties:
/// * [value]
abstract class OuterObjectWithEnumProperty implements Built<OuterObjectWithEnumProperty, OuterObjectWithEnumPropertyBuilder> { abstract class OuterObjectWithEnumProperty implements Built<OuterObjectWithEnumProperty, OuterObjectWithEnumPropertyBuilder> {
@BuiltValueField(wireName: r'value') @BuiltValueField(wireName: r'value')
OuterEnumInteger get value; OuterEnumInteger get value;

View File

@ -10,8 +10,15 @@ import 'package:built_value/serializer.dart';
part 'pet.g.dart'; part 'pet.g.dart';
/// Pet
///
/// Properties:
/// * [id]
/// * [category]
/// * [name]
/// * [photoUrls]
/// * [tags]
/// * [status] - pet status in the store
abstract class Pet implements Built<Pet, PetBuilder> { abstract class Pet implements Built<Pet, PetBuilder> {
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
int? get id; int? get id;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'read_only_first.g.dart'; part 'read_only_first.g.dart';
/// ReadOnlyFirst
///
/// Properties:
/// * [bar]
/// * [baz]
abstract class ReadOnlyFirst implements Built<ReadOnlyFirst, ReadOnlyFirstBuilder> { abstract class ReadOnlyFirst implements Built<ReadOnlyFirst, ReadOnlyFirstBuilder> {
@BuiltValueField(wireName: r'bar') @BuiltValueField(wireName: r'bar')
String? get bar; String? get bar;

View File

@ -7,8 +7,10 @@ import 'package:built_value/serializer.dart';
part 'special_model_name.g.dart'; part 'special_model_name.g.dart';
/// SpecialModelName
///
/// Properties:
/// * [dollarSpecialLeftSquareBracketPropertyPeriodNameRightSquareBracket]
abstract class SpecialModelName implements Built<SpecialModelName, SpecialModelNameBuilder> { abstract class SpecialModelName implements Built<SpecialModelName, SpecialModelNameBuilder> {
@BuiltValueField(wireName: r'$special[property.name]') @BuiltValueField(wireName: r'$special[property.name]')
int? get dollarSpecialLeftSquareBracketPropertyPeriodNameRightSquareBracket; int? get dollarSpecialLeftSquareBracketPropertyPeriodNameRightSquareBracket;

View File

@ -7,8 +7,11 @@ import 'package:built_value/serializer.dart';
part 'tag.g.dart'; part 'tag.g.dart';
/// Tag
///
/// Properties:
/// * [id]
/// * [name]
abstract class Tag implements Built<Tag, TagBuilder> { abstract class Tag implements Built<Tag, TagBuilder> {
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
int? get id; int? get id;

View File

@ -7,8 +7,17 @@ import 'package:built_value/serializer.dart';
part 'user.g.dart'; part 'user.g.dart';
/// User
///
/// Properties:
/// * [id]
/// * [username]
/// * [firstName]
/// * [lastName]
/// * [email]
/// * [password]
/// * [phone]
/// * [userStatus] - User Status
abstract class User implements Built<User, UserBuilder> { abstract class User implements Built<User, UserBuilder> {
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
int? get id; int? get id;

View File

@ -2,8 +2,6 @@ name: openapi
version: 1.0.0 version: 1.0.0
description: OpenAPI API client description: OpenAPI API client
homepage: homepage homepage: homepage
authors:
- 'Author <author@homepage>'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'

View File

@ -2,8 +2,6 @@ name: openapi
version: 1.0.0 version: 1.0.0
description: OpenAPI API client description: OpenAPI API client
homepage: homepage homepage: homepage
authors:
- 'Author <author@homepage>'
environment: environment:
sdk: '>=2.7.0 <3.0.0' sdk: '>=2.7.0 <3.0.0'

View File

@ -2,8 +2,6 @@ name: openapi
version: 1.0.0 version: 1.0.0
description: OpenAPI API client description: OpenAPI API client
homepage: homepage homepage: homepage
authors:
- 'Author <author@homepage>'
environment: environment:
sdk: '>=2.7.0 <3.0.0' sdk: '>=2.7.0 <3.0.0'

View File

@ -5,8 +5,6 @@
name: 'openapi' name: 'openapi'
version: '1.0.0' version: '1.0.0'
description: 'OpenAPI API client' description: 'OpenAPI API client'
authors:
- 'Author <author@homepage>'
homepage: 'homepage' homepage: 'homepage'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'

View File

@ -5,8 +5,6 @@
name: 'openapi' name: 'openapi'
version: '1.0.0' version: '1.0.0'
description: 'OpenAPI API client' description: 'OpenAPI API client'
authors:
- 'Author <author@homepage>'
homepage: 'homepage' homepage: 'homepage'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'

View File

@ -5,8 +5,6 @@
name: 'openapi' name: 'openapi'
version: '1.0.0' version: '1.0.0'
description: 'OpenAPI API client' description: 'OpenAPI API client'
authors:
- 'Author <author@homepage>'
homepage: 'homepage' homepage: 'homepage'
environment: environment:
sdk: '>=2.12.0 <3.0.0' sdk: '>=2.12.0 <3.0.0'