nori - v1.1.0

nori/response

Response types for OpenAPI specifications.

Describes the responses for an operation.

Types

</>

Represents a possible design-time link for a response.

pub type Link {
  Link(
    operation_ref: option.Option(String),
    operation_id: option.Option(String),
    parameters: dict.Dict(String, json.Json),
    request_body: option.Option(json.Json),
    description: option.Option(String),
    server: option.Option(server.Server),
    extensions: dict.Dict(String, json.Json),
  )
}

Constructors 

  • Link(
  operation_ref: option.Option(String),
  operation_id: option.Option(String),
  parameters: dict.Dict(String, json.Json),
  request_body: option.Option(json.Json),
  description: option.Option(String),
  server: option.Option(server.Server),
  extensions: dict.Dict(String, json.Json),
)

    Arguments

    operation_ref

    A relative or absolute URI reference to an OAS operation.

    operation_id

    The name of an existing, resolvable OAS operation.

    parameters

    A map representing parameters to pass to an operation.

    request_body

    A literal value or expression to use as a request body.

    description

    A description of the link.

    server

    A server object to be used by the target operation.

    extensions

    Extension fields (x-*)

Response

</>

Describes a single response from an API Operation.

pub type Response {
  Response(
    description: String,
    headers: dict.Dict(String, reference.Ref(parameter.Header)),
    content: dict.Dict(String, parameter.MediaType),
    links: dict.Dict(String, reference.Ref(Link)),
    extensions: dict.Dict(String, json.Json),
  )
}

Constructors

StatusCode

</>

HTTP status code type (can be specific or wildcard).

pub type StatusCode {
  Status(Int)
  Info
  Success
  Redirect
  ClientError
  ServerError
  Default
}

Constructors 

  • Status(Int)

    Specific HTTP status code (e.g., 200, 404)

  • Info

    1XX status codes

  • Success

    2XX status codes

  • Redirect

    3XX status codes

  • ClientError

    4XX status codes

  • ServerError

    5XX status codes

  • Default

    Default response

Values

</> 
pub fn empty_link() -> Link

Creates an empty Link.

</> 
pub fn link_to_operation(operation_id: String) -> Link

Creates a Link with an operation ID reference.

new

</> 
pub fn new(description: String) -> Response

Creates a Response with just a description.

parse_status_code

</> 
pub fn parse_status_code(s: String) -> Result(StatusCode, Nil)

Parses a status code string.

status_code_to_string

</> 
pub fn status_code_to_string(code: StatusCode) -> String

Converts a StatusCode to its string representation.

with_content

</> 
pub fn with_content(
  description: String,
  content_type: String,
  media_type: parameter.MediaType,
) -> Response

Creates a Response with description and content.

✨ Search Document