iya-sts
    Preparing search index...

    The request headers a published API takes, and the refusal of any other.

    Index
    • Whether a header is accepted whatever the operation declares.

      Parameters

      • name: string

        the header's name, in any case

      Returns boolean

      true for a standard, in-transit or internal header

    • Checks a request's headers against what its operation declares. The sentence names the header and never its value.

      Parameters

      • parameters: DeclaredParameter[]

        the operation's parameters

      • headers: any

        the request's headers

      Returns HeaderCheck

      { ok: true }, or { ok: false, header, sentence }

    • Checks a request's query and headers against its operation's parameters. The sentence names the parameter or header and never its value.

      Parameters

      • parameters: DeclaredParameter[]

        the operation's parameters

      • query: any

        the request's parsed query

      • headers: any

        the request's headers

      Returns RequestCheck

      { ok: true }, or { ok: false, problem, sentence }