@kwaeri/standards-types/dist/src/standards/json-api.d.mts

The @kwaeri/standards-types component module of the @kwaeri/node-kit platform.

/**
 * SPDX-PackageName: kwaeri/standards-types
 * SPDX-PackageVersion: 0.7.0
 * SPDX-FileCopyrightText: © 2014 - 2022 Richard Winters <kirvedx@gmail.com> and contributors
 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR MIT
 */
export type ErrorMessageBits = {
    domain?: string;
    reason?: string;
    message?: string;
    location?: string;
    locationType?: string;
    extendedHelp?: string;
    sendReport?: string;
};
export type ErrorBits = {
    code?: number;
    message?: string;
    errors?: ErrorMessageBits[];
};
export type ParameterBits = {
    [key: string]: string;
};
export type ItemsBits = {
    [key: string]: any;
};
export type DataBits = {
    kind?: string;
    fields?: string;
    etag?: string;
    id?: string;
    lang?: string;
    updated?: string;
    deleted?: boolean;
    currentItemCount?: number;
    itemsPerPage?: number;
    startIndex?: number;
    totalItems?: number;
    pageIndex?: number;
    totalPages?: number;
    pageLinkTemplate?: string;
    next?: any;
    nextLink?: string;
    previous?: any;
    previousLink?: string;
    self?: any;
    selfLink?: string;
    edit?: any;
    editLink?: string;
    items?: ItemsBits[];
};
export type RequestBits = {
    apiVersion?: string;
    context?: string;
    id?: string;
    method?: string;
    params?: ParameterBits;
    data?: DataBits;
    error?: ErrorBits;
};
export type ResponseBits = RequestBits;