nori/components

Components container for OpenAPI specifications.

Holds reusable components that can be referenced from other parts of the spec.

Types

Components

Holds a set of reusable objects for different aspects of the OAS.

pub type Components {
  Components(
    schemas: dict.Dict(String, schema.Schema),
    responses: dict.Dict(String, reference.Ref(response.Response)),
    parameters: dict.Dict(
      String,
      reference.Ref(parameter.Parameter),
    ),
    examples: dict.Dict(String, reference.Ref(parameter.Example)),
    request_bodies: dict.Dict(
      String,
      reference.Ref(request_body.RequestBody),
    ),
    headers: dict.Dict(String, reference.Ref(parameter.Header)),
    security_schemes: dict.Dict(
      String,
      reference.Ref(security.SecurityScheme),
    ),
    links: dict.Dict(String, reference.Ref(response.Link)),
    callbacks: dict.Dict(
      String,
      reference.Ref(
        dict.Dict(String, reference.Ref(operation.PathItem)),
      ),
    ),
    path_items: dict.Dict(
      String,
      reference.Ref(operation.PathItem),
    ),
    extensions: dict.Dict(String, json.Json),
  )
}

Constructors

Components(
  schemas: dict.Dict(String, schema.Schema),
  responses: dict.Dict(String, reference.Ref(response.Response)),
  parameters: dict.Dict(
    String,
    reference.Ref(parameter.Parameter),
  ),
  examples: dict.Dict(String, reference.Ref(parameter.Example)),
  request_bodies: dict.Dict(
    String,
    reference.Ref(request_body.RequestBody),
  ),
  headers: dict.Dict(String, reference.Ref(parameter.Header)),
  security_schemes: dict.Dict(
    String,
    reference.Ref(security.SecurityScheme),
  ),
  links: dict.Dict(String, reference.Ref(response.Link)),
  callbacks: dict.Dict(
    String,
    reference.Ref(
      dict.Dict(String, reference.Ref(operation.PathItem)),
    ),
  ),
  path_items: dict.Dict(String, reference.Ref(operation.PathItem)),
  extensions: dict.Dict(String, json.Json),
)

Arguments

schemas: An object to hold reusable Schema Objects.
responses: An object to hold reusable Response Objects.
parameters: An object to hold reusable Parameter Objects.
examples: An object to hold reusable Example Objects.
request_bodies: An object to hold reusable Request Body Objects.
headers: An object to hold reusable Header Objects.
security_schemes: An object to hold reusable Security Scheme Objects.
links: An object to hold reusable Link Objects.
callbacks: An object to hold reusable Callback Objects.
path_items: An object to hold reusable Path Item Objects.
extensions: Extension fields (x-*)

Values

add_callback

</>

pub fn add_callback(
  components: Components,
  name: String,
  callback: dict.Dict(String, reference.Ref(operation.PathItem)),
) -> Components

Adds a callback to the components.

add_example

</>

pub fn add_example(
  components: Components,
  name: String,
  example: parameter.Example,
) -> Components

Adds an example to the components.

add_header

</>

pub fn add_header(
  components: Components,
  name: String,
  header: parameter.Header,
) -> Components

Adds a header to the components.

add_link

</>

pub fn add_link(
  components: Components,
  name: String,
  link: response.Link,
) -> Components

Adds a link to the components.

add_parameter

</>

pub fn add_parameter(
  components: Components,
  name: String,
  parameter: parameter.Parameter,
) -> Components

Adds a parameter to the components.

add_path_item

</>

pub fn add_path_item(
  components: Components,
  name: String,
  path_item: operation.PathItem,
) -> Components

Adds a path item to the components.

add_request_body

</>

pub fn add_request_body(
  components: Components,
  name: String,
  request_body: request_body.RequestBody,
) -> Components

Adds a request body to the components.

add_response

</>

pub fn add_response(
  components: Components,
  name: String,
  response: response.Response,
) -> Components

Adds a response to the components.

add_schema

</>

pub fn add_schema(
  components: Components,
  name: String,
  schema: schema.Schema,
) -> Components

Adds a schema to the components.

add_security_scheme

</>

pub fn add_security_scheme(
  components: Components,
  name: String,
  scheme: security.SecurityScheme,
) -> Components

Adds a security scheme to the components.

callback_ref

</>

pub fn callback_ref(name: String) -> String

Creates a reference string for a component callback.

example_ref

</>

pub fn example_ref(name: String) -> String

Creates a reference string for a component example.

header_ref

</>

pub fn header_ref(name: String) -> String

Creates a reference string for a component header.

is_empty

</>

pub fn is_empty(components: Components) -> Bool

Checks if the components object is empty (all maps are empty).

link_ref

</>

pub fn link_ref(name: String) -> String

Creates a reference string for a component link.

new

</>

pub fn new() -> Components

Creates an empty Components object.

parameter_ref

</>

pub fn parameter_ref(name: String) -> String

Creates a reference string for a component parameter.

path_item_ref

</>

pub fn path_item_ref(name: String) -> String

Creates a reference string for a component path item.

request_body_ref

</>

pub fn request_body_ref(name: String) -> String

Creates a reference string for a component request body.

response_ref

</>

pub fn response_ref(name: String) -> String

Creates a reference string for a component response.

schema_ref

</>

pub fn schema_ref(name: String) -> String

Creates a reference string for a component schema.

security_scheme_ref

</>

pub fn security_scheme_ref(name: String) -> String

Creates a reference string for a component security scheme.