/** * application/vnd.oada.clients.1+json * @example * ```json * { * "name": "clients", * "list": { * "0jfl290ijfklwsdf": { * "_id": "321cba", * "_rev": "90-k2983wfhjdsdf" * }, * "kl9ojksfh92hkwef": { * "_id": "389dfj", * "_rev": "2-kdfj29eflwdfsd" * } * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/clients/v1.schema.json of @oada/formats * and run `$ yarn build` to regenerate this file. * * @packageDocumentation */ /** * `$id` of the source schema * @see {@link https://formats.openag.io/oada/clients/v1.schema.json} */ export declare const $id = "https://formats.openag.io/oada/clients/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/clients/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/clients/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "application/vnd.oada.clients.1+json"; readonly additionalProperties: true; readonly required: readonly ["name", "list"]; readonly properties: { readonly name: { readonly type: "string"; readonly pattern: "clients"; }; readonly list: { readonly $ref: "https://formats.openag.io/oada/link/v1.schema.json#/definitions/list"; }; }; readonly examples: readonly [{ readonly name: "clients"; readonly list: { readonly '0jfl290ijfklwsdf': { readonly _id: "321cba"; readonly _rev: "90-k2983wfhjdsdf"; }; readonly kl9ojksfh92hkwef: { readonly _id: "389dfj"; readonly _rev: "2-kdfj29eflwdfsd"; }; }; }]; }; /** * Returns true if `val` is a @type `V1Schema`, false otherwise */ export declare function is(val: unknown): val is V1Schema; /** * Asserts that `val` is a @type `V1Schema` */ export declare function assert(val: unknown): asserts val is V1Schema; /** * application/vnd.oada.clients.1+json * @example * ```json * { * "name": "clients", * "list": { * "0jfl290ijfklwsdf": { * "_id": "321cba", * "_rev": "90-k2983wfhjdsdf" * }, * "kl9ojksfh92hkwef": { * "_id": "389dfj", * "_rev": "2-kdfj29eflwdfsd" * } * } * } * ``` * */ export default V1Schema; /** * application/vnd.oada.clients.1+json */ export interface V1Schema { name: string; list: List; [k: string]: unknown; } export interface List { [k: string]: Nonversioned | Versioned; } export interface Versioned { _id: string; /** * _rev is the revision for a resource in the OADA API. */ _rev: number; [k: string]: unknown; } export interface Nonversioned { _id: string; [k: string]: unknown; }