OpenAPIHeader constructor

OpenAPIHeader({
  1. String? description,
  2. bool? required,
  3. bool? deprecated,
  4. OpenAPISchema? schema,
  5. Map<String, OpenAPIMediaType>? content,
  6. String? style,
  7. bool? explode,
  8. Object? example,
  9. Map<String, OpenAPIRef<OpenAPIExample>>? examples,
  10. Map<String, Object?>? extensions,
})

Creates a header object.

Implementation

factory OpenAPIHeader({
  String? description,
  bool? required,
  bool? deprecated,
  OpenAPISchema? schema,
  Map<String, OpenAPIMediaType>? content,
  String? style,
  bool? explode,
  Object? example,
  Map<String, OpenAPIRef<OpenAPIExample>>? examples,
  Map<String, Object?>? extensions,
}) {
  validateSchemaOrContent(
    schema: schema,
    content: content,
    scope: 'OpenAPIHeader',
  );
  validateExampleMutualExclusivity(
    example: example,
    examples: examples,
    scope: 'OpenAPIHeader',
  );
  return OpenAPIHeader._({
    'description': ?description,
    'required': ?required,
    'deprecated': ?deprecated,
    'schema': ?schema,
    'content': ?content,
    'style': ?style,
    'explode': ?explode,
    'example': ?example,
    'examples': ?examples,
    ...?prefixExtensions(extensions),
  });
}