Nog CLI Developer Guide - v0.11.0
    Preparing search index...

    Interface IrParameter

    Represents a single parameter for an HTTP operation. Each IrParameter becomes a method argument in the generated service.

    interface IrParameter {
        allowReserved?: boolean;
        description?: string;
        explode?: boolean;
        in: "query" | "path" | "body" | "header";
        isRequired: boolean;
        name: string;
        style?:
            | "form"
            | "spaceDelimited"
            | "pipeDelimited"
            | "deepObject"
            | "simple"
            | "label"
            | "matrix";
        type: IrType;
    }
    Index

    Properties

    allowReserved? description? explode? in isRequired name style? type

    Properties

    allowReserved?: boolean

    When true, RFC 3986 reserved characters in the value pass without percent-encoding. Applies only to query parameters; defaults to false. Runtime support deferred — IR-only for now.

    description?: string

    Optional description from the OpenAPI parameter. Used to generate JSDoc comments for individual parameters in the params object.

    explode?: boolean

    Whether array/object values are expanded into separate parameters. Only stored when it differs from the style default. Spec defaults: true when style: 'form', false otherwise.

    in: "query" | "path" | "body" | "header"

    The location of this parameter in the HTTP request.

    • 'path': URL path parameter (e.g., /users/{id})
    • 'query': URL query string parameter (e.g., ?limit=10)
    • 'body': Request body (POST/PUT/PATCH)
    • 'header': HTTP header (e.g., Authorization)
    isRequired: boolean

    Indicates if this parameter is required. When false, the parameter becomes optional in the generated method signature.

    Required path param: `getUserById(id: string)`

    Optional query param: `listUsers(limit?: number)`
    name: string

    The parameter name in camelCase. Used as the method argument name.

    'userId'

    'limit'

    'body'
    style?:
        | "form"
        | "spaceDelimited"
        | "pipeDelimited"
        | "deepObject"
        | "simple"
        | "label"
        | "matrix"

    Serialization style for the parameter, as defined by OpenAPI 3.0 Parameter Object. Only stored when it differs from the spec default for the parameter location. Defaults: form for in: 'query', simple for in: 'path' | 'header'.

    type: IrType

    The type of this parameter. For body parameters, typically references a DTO model.

    Settings

    Member Visibility

    On This Page

    Properties