@autorest/openapi-to-typespec/dist/utils/paging.d.ts

Autorest plugin to scaffold a Typespec definition from an OpenAPI document

import { CodeModel, Operation, Response, Property } from "@autorest/codemodel";
export interface PaginationExtension {
    /**
     * The name of the field in the response that can be paged over.
     */
    itemName?: string;
    /**
     * Name of the field containing the nextLink value.
     * An empty object indicates a null value and that all results
     * are returned in a single page.
     */
    nextLinkName?: string | {};
    /**
     * Reference to the operation to call to get the next page.
     */
    nextLinkOperation?: Operation;
    /**
     * The name of the operationGroup that nextLinkOperation resides in.
     */
    group?: string;
    /**
     * The name of the operation that nextLinkOperation references.
     */
    member?: string;
    /**
     * Indicates whether this operation is used by another operation to get pages.
     */
    isNextLinkMethod?: boolean;
}
export declare function isPageableOperation(operation: Operation): boolean;
export declare function getPageableResponse(operation: Operation): Response | undefined;
export declare function isPageValue(property: Property): boolean;
export declare function markPagination(codeModel: CodeModel): void;
//# sourceMappingURL=paging.d.ts.map