/** * OADA "list" * @example * ```json * { * "_id": "resources/123", * "_rev": 3, * "_meta": { * "_id": "resources/123/_meta", * "_rev": 3 * }, * "_type": "application/vnd.oada.list.1+json", * "asdxjkacsdj": { * "_id": "resources/ajajkjfsdaf", * "_rev": 1 * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/service/jobs-change.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/jobs-change/v1.schema.json} */ export declare const $id = "https://formats.openag.io/oada/jobs-change/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/jobs-change/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/jobs-change/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "OADA \"list\""; readonly title: "List"; readonly definitions: { readonly item: { readonly title: "List item"; readonly $ref: "../link/v1.schema.json"; }; }; readonly type: "object"; readonly properties: {}; readonly allOf: readonly [{ readonly description: "listed jobs"; readonly type: "object"; readonly tsType: "{[key: `${\"a\"|\"b\"|\"c\"|\"d\"|\"e\"|\"f\"|\"g\"|\"h\"|\"i\"|\"j\"|\"k\"|\"l\"|\"m\"|\"n\"|\"o\"|\"p\"|\"q\"|\"r\"|\"s\"|\"t\"|\"u\"|\"v\"|\"w\"|\"x\"|\"y\"|\"z\"|\"A\"|\"B\"|\"C\"|\"D\"|\"E\"|\"F\"|\"G\"|\"H\"|\"I\"|\"J\"|\"K\"|\"L\"|\"M\"|\"N\"|\"O\"|\"P\"|\"Q\"|\"R\"|\"S\"|\"T\"|\"U\"|\"V\"|\"W\"|\"X\"|\"Y\"|\"Z\"|\"0\"|\"1\"|\"2\"|\"3\"|\"4\"|\"5\"|\"6\"|\"7\"|\"8\"|\"9\"}${string}`]: ListItem}"; readonly patternProperties: { readonly '^[^_]': { readonly $ref: "#/definitions/item"; }; }; }]; readonly examples: readonly [{ readonly _id: "resources/123"; readonly _rev: 3; readonly _meta: { readonly _id: "resources/123/_meta"; readonly _rev: 3; }; readonly _type: "application/vnd.oada.list.1+json"; readonly asdxjkacsdj: { readonly _id: "resources/ajajkjfsdaf"; readonly _rev: 1; }; }]; }; /** * Returns true if `val` is a @type `List`, false otherwise */ export declare function is(val: unknown): val is List; /** * Asserts that `val` is a @type `List` */ export declare function assert(val: unknown): asserts val is List; /** * OADA "list" * @example * ```json * { * "_id": "resources/123", * "_rev": 3, * "_meta": { * "_id": "resources/123/_meta", * "_rev": 3 * }, * "_type": "application/vnd.oada.list.1+json", * "asdxjkacsdj": { * "_id": "resources/ajajkjfsdaf", * "_rev": 1 * } * } * ``` * */ export default List; /** * OADA "list" */ export type List = { [key: `${'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' | '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'}${string}`]: ListItem; } & { [k: string]: unknown; }; /** * OADA Link object * * This interface was referenced by `undefined`'s JSON-Schema * via the `definition` "item". */ export type ListItem = Nonversioned | Versioned; export interface Nonversioned { _id: string; [k: string]: unknown; } export interface Versioned { _id: string; /** * _rev is the revision for a resource in the OADA API. */ _rev: number; [k: string]: unknown; }