OpenAPI constructor

OpenAPI({
  1. List<String>? tags,
  2. String? summary,
  3. String? description,
  4. OpenAPIExternalDocs? externalDocs,
  5. String? operationId,
  6. List<OpenAPIRef<OpenAPIParameter>>? parameters,
  7. OpenAPIRef<OpenAPIRequestBody>? requestBody,
  8. Map<String, OpenAPIRef<OpenAPIResponse>>? responses,
  9. Map<String, OpenAPIRef<OpenAPICallback>>? callbacks,
  10. bool? deprecated,
  11. List<OpenAPISecurityRequirement>? security,
  12. List<OpenAPIServer>? servers,
  13. Map<String, Object?>? extensions,
  14. OpenAPIComponents? globalComponents,
})

Creates route metadata and allows extra route-level global components.

Implementation

factory OpenAPI({
  List<String>? tags,
  String? summary,
  String? description,
  OpenAPIExternalDocs? externalDocs,
  String? operationId,
  List<OpenAPIRef<OpenAPIParameter>>? parameters,
  OpenAPIRef<OpenAPIRequestBody>? requestBody,
  Map<String, OpenAPIRef<OpenAPIResponse>>? responses,
  Map<String, OpenAPIRef<OpenAPICallback>>? callbacks,
  bool? deprecated,
  List<OpenAPISecurityRequirement>? security,
  List<OpenAPIServer>? servers,
  Map<String, Object?>? extensions,
  OpenAPIComponents? globalComponents,
}) => OpenAPI._({
  ..._buildOperationMap(
    tags: tags,
    summary: summary,
    description: description,
    externalDocs: externalDocs,
    operationId: operationId,
    parameters: parameters,
    requestBody: requestBody,
    responses: responses,
    callbacks: callbacks,
    deprecated: deprecated,
    security: security,
    servers: servers,
    extensions: extensions,
  ),
  'x-spry-openapi-global-components': ?globalComponents,
});