OpenAPIParameter.query constructor

OpenAPIParameter.query(
  1. String name, {
  2. OpenAPISchema? schema,
  3. Map<String, OpenAPIMediaType>? content,
  4. bool required = false,
  5. String? description,
  6. bool? allowEmptyValue,
  7. bool? allowReserved,
  8. String? style,
  9. bool? explode,
  10. Object? example,
  11. Map<String, OpenAPIRef<OpenAPIExample>>? examples,
  12. Map<String, Object?>? extensions,
})

Creates a query parameter.

Implementation

factory OpenAPIParameter.query(
  String name, {
  OpenAPISchema? schema,
  Map<String, OpenAPIMediaType>? content,
  bool required = false,
  String? description,
  bool? allowEmptyValue,
  bool? allowReserved,
  String? style,
  bool? explode,
  Object? example,
  Map<String, OpenAPIRef<OpenAPIExample>>? examples,
  Map<String, Object?>? extensions,
}) {
  validateSchemaOrContent(
    schema: schema,
    content: content,
    scope: 'OpenAPIParameter.query',
  );
  validateExampleMutualExclusivity(
    example: example,
    examples: examples,
    scope: 'OpenAPIParameter.query',
  );
  return OpenAPIParameter._({
    'name': name,
    'in': 'query',
    if (required) 'required': true,
    'schema': ?schema,
    'content': ?content,
    'description': ?description,
    'allowEmptyValue': ?allowEmptyValue,
    'allowReserved': ?allowReserved,
    'style': ?style,
    'explode': ?explode,
    'example': ?example,
    'examples': ?examples,
    ...?prefixExtensions(extensions),
  });
}