/** * The format for @oada/jobs jobs list * @example * ```json * { * "_id": "resources/123", * "_rev": 3, * "_meta": { * "_id": "resources/123/_meta", * "_rev": 3 * }, * "_type": "application/vnd.oada.service.jobs.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.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/service/jobs.schema.json} */ export declare const $id = "https://formats.openag.io/oada/service/jobs.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/service/jobs.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/service/jobs.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "The format for @oada/jobs jobs list"; readonly title: "OADA jobs list"; readonly allOf: readonly [{ readonly $ref: "../list/v1.schema.json"; }]; 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.service.jobs.1+json"; readonly asdxjkacsdj: { readonly _id: "resources/ajajkjfsdaf"; readonly _rev: 1; }; }]; }; /** * Returns true if `val` is a @type `OADAJobsList`, false otherwise */ export declare function is(val: unknown): val is OADAJobsList; /** * Asserts that `val` is a @type `OADAJobsList` */ export declare function assert(val: unknown): asserts val is OADAJobsList; /** * The format for @oada/jobs jobs list * @example * ```json * { * "_id": "resources/123", * "_rev": 3, * "_meta": { * "_id": "resources/123/_meta", * "_rev": 3 * }, * "_type": "application/vnd.oada.service.jobs.1+json", * "asdxjkacsdj": { * "_id": "resources/ajajkjfsdaf", * "_rev": 1 * } * } * ``` * */ export default OADAJobsList; /** * The format for @oada/jobs jobs list */ export type OADAJobsList = List; /** * OADA "list" */ export type List = OADAResource & { [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 | Versioned1; export interface OADAResource { /** * _id identifies a resource in the OADA API. */ _id: string; /** * _rev is the revision for a resource in the OADA API. */ _rev: number; _meta: Versioned; /** * _type identifies the content-type of a resource in the OADA API. */ _type: string; [k: string]: unknown; } export interface Versioned { /** * _rev is the revision for a resource in the OADA API. */ _rev: number; /** * _id identifies a resource in the OADA API. */ _id?: string; /** * _type identifies the content-type of a resource in the OADA API. */ _type?: string; } export interface Nonversioned { _id: string; [k: string]: unknown; } export interface Versioned1 { _id: string; /** * _rev is the revision for a resource in the OADA API. */ _rev: number; [k: string]: unknown; }