/** * The ISOBlue document holds links to data related to (often collected by) the ISOBlue device * @example * ```json * { * "_type": "application/vnd.oada.isoblue.1+json", * "can": { * "_id": "kfj20ikejldss" * }, * "heartbeat": { * "_id": "92jfkjfe0fdi" * }, * "location": { * "_id": "92jfkjfe0fdi" * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/isoblue/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/isoblue/v1.schema.json} */ export declare const $id = "https://formats.openag.io/oada/isoblue/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/isoblue/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/isoblue/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "The ISOBlue document holds links to data related to (often collected by) the ISOBlue device"; readonly properties: { readonly can: { readonly description: "A link in OADA has at least an _id key and links one resource to another."; readonly properties: { readonly _id: { readonly description: "_id identifies a resource in the OADA API."; readonly type: "string"; }; }; readonly required: readonly ["_id"]; readonly type: "object"; }; readonly heartbeat: { readonly description: "A link in OADA has at least an _id key and links one resource to another."; readonly properties: { readonly _id: { readonly description: "_id identifies a resource in the OADA API."; readonly type: "string"; }; }; readonly required: readonly ["_id"]; readonly type: "object"; }; readonly location: { readonly description: "A link in OADA has at least an _id key and links one resource to another."; readonly properties: { readonly _id: { readonly description: "_id identifies a resource in the OADA API."; readonly type: "string"; }; }; readonly required: readonly ["_id"]; readonly type: "object"; }; readonly _id: { readonly description: "_id identifies a resource in the OADA API."; readonly type: "string"; }; readonly _rev: { readonly description: "_rev is the revision string for a resource in the OADA API."; readonly type: "integer"; }; readonly _meta: { readonly description: "_meta is a link to the meta document for a resources."; readonly properties: { readonly _id: { readonly description: "_id identifies a resource in the OADA API."; readonly type: "string"; }; readonly _rev: { readonly description: "_rev is the revision string for a resource in the OADA API."; readonly type: "integer"; }; }; readonly required: readonly ["_id", "_rev"]; readonly type: "object"; }; readonly _type: { readonly enum: readonly ["application/vnd.oada.isoblue.1+json"]; }; }; readonly additionalProperties: true; readonly required: readonly ["_type"]; readonly type: "object"; readonly examples: readonly [{ readonly _type: "application/vnd.oada.isoblue.1+json"; readonly can: { readonly _id: "kfj20ikejldss"; }; readonly heartbeat: { readonly _id: "92jfkjfe0fdi"; }; readonly location: { readonly _id: "92jfkjfe0fdi"; }; }]; }; /** * 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; /** * The ISOBlue document holds links to data related to (often collected by) the ISOBlue device * @example * ```json * { * "_type": "application/vnd.oada.isoblue.1+json", * "can": { * "_id": "kfj20ikejldss" * }, * "heartbeat": { * "_id": "92jfkjfe0fdi" * }, * "location": { * "_id": "92jfkjfe0fdi" * } * } * ``` * */ export default V1Schema; /** * The ISOBlue document holds links to data related to (often collected by) the ISOBlue device */ export interface V1Schema { /** * A link in OADA has at least an _id key and links one resource to another. */ can?: { /** * _id identifies a resource in the OADA API. */ _id: string; [k: string]: unknown; }; /** * A link in OADA has at least an _id key and links one resource to another. */ heartbeat?: { /** * _id identifies a resource in the OADA API. */ _id: string; [k: string]: unknown; }; /** * A link in OADA has at least an _id key and links one resource to another. */ location?: { /** * _id identifies a resource in the OADA API. */ _id: string; [k: string]: unknown; }; /** * _id identifies a resource in the OADA API. */ _id?: string; /** * _rev is the revision string for a resource in the OADA API. */ _rev?: number; /** * _meta is a link to the meta document for a resources. */ _meta?: { /** * _id identifies a resource in the OADA API. */ _id: string; /** * _rev is the revision string for a resource in the OADA API. */ _rev: number; [k: string]: unknown; }; _type: 'application/vnd.oada.isoblue.1+json'; [k: string]: unknown; }