loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-03 14:10:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

[dart][dart-dio] Fix property deprecation and add parameter deprecation (#15374)

Browse Source 
Addresses problems in #13818
This commit is contained in:
Peter Leibiger 2023-05-02 13:42:06 +02:00 committed by GitHub
parent fefbfd6aa2
commit e356b770d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
modules/openapi-generator/src/main/resources/dart/libraries/dio/api.mustache vendored
View File

@ -39,11 +39,11 @@ class {{classname}} {
@Deprecated('This operation has been deprecated') @Deprecated('This operation has been deprecated')
{{/isDeprecated}} {{/isDeprecated}}
Future<Response<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {{nickname}}({ {{#allParams}}{{#isPathParam}} Future<Response<{{{returnType}}}{{^returnType}}void{{/returnType}}>> {{nickname}}({ {{#allParams}}{{#isPathParam}}
required {{{dataType}}} {{paramName}},{{/isPathParam}}{{#isQueryParam}} {{#isDeprecated}}@Deprecated('{{paramName}} is deprecated') {{/isDeprecated}}required {{{dataType}}} {{paramName}},{{/isPathParam}}{{#isQueryParam}}
{{#required}}{{^isNullable}}{{^defaultValue}}required {{/defaultValue}}{{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}}{{^isContainer}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isContainer}},{{/isQueryParam}}{{#isHeaderParam}} {{#isDeprecated}}@Deprecated('{{paramName}} is deprecated') {{/isDeprecated}}{{#required}}{{^isNullable}}{{^defaultValue}}required {{/defaultValue}}{{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}}{{^isContainer}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isContainer}},{{/isQueryParam}}{{#isHeaderParam}}
{{#required}}{{^isNullable}}{{^defaultValue}}required {{/defaultValue}}{{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}}{{^isContainer}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isContainer}},{{/isHeaderParam}}{{#isBodyParam}} {{#isDeprecated}}@Deprecated('{{paramName}} is deprecated') {{/isDeprecated}}{{#required}}{{^isNullable}}{{^defaultValue}}required {{/defaultValue}}{{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}}{{^isContainer}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}{{/isContainer}},{{/isHeaderParam}}{{#isBodyParam}}
{{#required}}{{^isNullable}}required {{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}},{{/isBodyParam}}{{#isFormParam}} {{#isDeprecated}}@Deprecated('{{paramName}} is deprecated') {{/isDeprecated}}{{#required}}{{^isNullable}}required {{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}},{{/isBodyParam}}{{#isFormParam}}
{{#required}}{{^isNullable}}required {{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}},{{/isFormParam}}{{/allParams}} {{#isDeprecated}}@Deprecated('{{paramName}} is deprecated') {{/isDeprecated}}{{#required}}{{^isNullable}}required {{/isNullable}}{{/required}}{{{dataType}}}{{#required}}{{#isNullable}}?{{/isNullable}}{{/required}}{{^required}}?{{/required}} {{paramName}},{{/isFormParam}}{{/allParams}}
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
Map<String, dynamic>? extra, Map<String, dynamic>? extra,

4
modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/built_value/class_members.mustache vendored
View File

@ -3,9 +3,9 @@
{{#description}} {{#description}}
/// {{{.}}} /// {{{.}}}
{{/description}} {{/description}}
{{#isDeprecated}} {{#deprecated}}
@Deprecated('{{{name}}} has been deprecated') @Deprecated('{{{name}}} has been deprecated')
{{/isDeprecated}} {{/deprecated}}
@BuiltValueField(wireName: r'{{baseName}}') @BuiltValueField(wireName: r'{{baseName}}')
{{>serialization/built_value/variable_type}}{{^isNullable}}{{^required}}?{{/required}}{{/isNullable}} get {{name}}; {{>serialization/built_value/variable_type}}{{^isNullable}}{{^required}}?{{/required}}{{/isNullable}} get {{name}};
{{#allowableValues}} {{#allowableValues}}

4
modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/json_serializable/class.mustache vendored
View File

@ -35,9 +35,9 @@ class {{{classname}}} {
// maximum: {{{maximum}}} // maximum: {{{maximum}}}
{{/maximum}} {{/maximum}}
{{/isEnum}} {{/isEnum}}
{{#isDeprecated}} {{#deprecated}}
@Deprecated('{{{name}}} has been deprecated') @Deprecated('{{{name}}} has been deprecated')
{{/isDeprecated}} {{/deprecated}}
{{^isBinary}} {{^isBinary}}
@JsonKey( @JsonKey(
{{#defaultValue}}defaultValue: {{{defaultValue}}},{{/defaultValue}} {{#defaultValue}}defaultValue: {{{defaultValue}}},{{/defaultValue}}

2
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake-json_serializable/lib/src/api/pet_api.dart
View File

@ -158,7 +158,7 @@ _bodyData=jsonEncode(pet);
/// Returns a [Future] containing a [Response] with a [List<Pet>] as data /// Returns a [Future] containing a [Response] with a [List<Pet>] as data
/// Throws [DioError] if API call or serialization fails /// Throws [DioError] if API call or serialization fails
Future<Response<List<Pet>>> findPetsByStatus({ Future<Response<List<Pet>>> findPetsByStatus({
required List<String> status, @Deprecated('status is deprecated') required List<String> status,
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
Map<String, dynamic>? extra, Map<String, dynamic>? extra,

1
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake-json_serializable/lib/src/model/deprecated_object.dart
View File

@ -22,7 +22,6 @@ class DeprecatedObject {
this.name, this.name,
}); });
@Deprecated('name has been deprecated')
@JsonKey( @JsonKey(
name: r'name', name: r'name',

3
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake-json_serializable/lib/src/model/object_with_deprecated_fields.dart
View File

@ -40,6 +40,7 @@ class ObjectWithDeprecatedFields {
@Deprecated('id has been deprecated')
@JsonKey( @JsonKey(
name: r'id', name: r'id',
@ -52,6 +53,7 @@ class ObjectWithDeprecatedFields {
@Deprecated('deprecatedRef has been deprecated')
@JsonKey( @JsonKey(
name: r'deprecatedRef', name: r'deprecatedRef',
@ -64,6 +66,7 @@ class ObjectWithDeprecatedFields {
@Deprecated('bars has been deprecated')
@JsonKey( @JsonKey(
name: r'bars', name: r'bars',

2
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/lib/src/api/pet_api.dart
View File

@ -162,7 +162,7 @@ class PetApi {
/// Returns a [Future] containing a [Response] with a [BuiltList<Pet>] as data /// Returns a [Future] containing a [Response] with a [BuiltList<Pet>] as data
/// Throws [DioError] if API call or serialization fails /// Throws [DioError] if API call or serialization fails
Future<Response<BuiltList<Pet>>> findPetsByStatus({ Future<Response<BuiltList<Pet>>> findPetsByStatus({
required BuiltList<String> status, @Deprecated('status is deprecated') required BuiltList<String> status,
CancelToken? cancelToken, CancelToken? cancelToken,
Map<String, dynamic>? headers, Map<String, dynamic>? headers,
Map<String, dynamic>? extra, Map<String, dynamic>? extra,

1
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/lib/src/model/deprecated_object.dart
View File

@ -15,7 +15,6 @@ part 'deprecated_object.g.dart';
@Deprecated('DeprecatedObject has been deprecated') @Deprecated('DeprecatedObject has been deprecated')
@BuiltValue() @BuiltValue()
abstract class DeprecatedObject implements Built<DeprecatedObject, DeprecatedObjectBuilder> { abstract class DeprecatedObject implements Built<DeprecatedObject, DeprecatedObjectBuilder> {
@Deprecated('name has been deprecated')
@BuiltValueField(wireName: r'name') @BuiltValueField(wireName: r'name')
String? get name; String? get name;

3
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/lib/src/model/object_with_deprecated_fields.dart
View File

@ -22,12 +22,15 @@ abstract class ObjectWithDeprecatedFields implements Built<ObjectWithDeprecatedF
@BuiltValueField(wireName: r'uuid') @BuiltValueField(wireName: r'uuid')
String? get uuid; String? get uuid;
@Deprecated('id has been deprecated')
@BuiltValueField(wireName: r'id') @BuiltValueField(wireName: r'id')
num? get id; num? get id;
@Deprecated('deprecatedRef has been deprecated')
@BuiltValueField(wireName: r'deprecatedRef') @BuiltValueField(wireName: r'deprecatedRef')
DeprecatedObject? get deprecatedRef; DeprecatedObject? get deprecatedRef;
@Deprecated('bars has been deprecated')
@BuiltValueField(wireName: r'bars') @BuiltValueField(wireName: r'bars')
BuiltList<String>? get bars; BuiltList<String>? get bars;

1
samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake_tests/test/api/pet_api_test.dart
View File

@ -198,6 +198,7 @@ void main() {
); );
final response = await client.getPetApi().findPetsByStatus( final response = await client.getPetApi().findPetsByStatus(
// ignore: deprecated_member_use
status: ListBuilder<String>(<String>[ status: ListBuilder<String>(<String>[
PetStatusEnum.available.name, PetStatusEnum.available.name,
PetStatusEnum.sold.name, PetStatusEnum.sold.name,