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

    Interface IrOperation

    Represents a single HTTP operation (endpoint) in the IR. Each IrOperation generates two methods in the service: one returning Observable, one returning Promise.

    interface IrOperation {
        acceptHeader?: string;
        description?: string;
        method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
        methodName: string;
        operationId: string;
        parameters: IrParameter[];
        path: string;
        requestContentType?: string;
        responseType?: "text" | "blob" | "arraybuffer";
        returnType: IrType;
    }
    Index

    Properties

    acceptHeader? description? method methodName operationId parameters path requestContentType? responseType? returnType

    Properties

    acceptHeader?: string

    The Accept header value based on the response content-type. Used to tell the server what content type the client expects.

    'text/plain'

    'image/png'

    'application/pdf'
    description?: string

    Optional description from the OpenAPI operation. Used to generate JSDoc comments for the method.

    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

    The HTTP method for this operation. Maps to HttpService methods in the generated code.

    methodName: string

    The generated TypeScript method name in camelCase. Derived from the operationId or path/method combination.

    'getUserById'

    'createAnimal'

    'listPosts'
    operationId: string

    The original OpenAPI operationId. Preserved for traceability and debugging.

    'users:getById'

    'pets:create'
    parameters: IrParameter[]

    List of all parameters for this operation (path, query, body, header). Each parameter becomes a method argument in the generated service.

    path: string

    The HTTP path template with parameter placeholders. Path parameters use ${paramName} template syntax in generated code.

    '/users/${id}'

    '/pets/${petId}/owner'

    '/posts' (no parameters)
    requestContentType?: string

    The content-type of the request body. Used to generate proper headers for multipart/form-data, application/json, etc.

    'multipart/form-data'

    'application/json'
    responseType?: "text" | "blob" | "arraybuffer"

    The Axios responseType for non-JSON responses.

    'text' for text/plain

    'blob' for binary data (images, PDFs, etc)

    'arraybuffer' for raw binary
    returnType: IrType

    The return type of this operation. Used for typing the Observable/Promise and the HTTP service generic.

    { rawType: 'User', isArray: false, isPrimitive: false }

    { rawType: 'Post', isArray: true, isPrimitive: false } → generates `Post[]`

    Settings

    Member Visibility

    On This Page

    Properties