/** * * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/resource.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/resource.schema.json} */ export declare const $id = "https://formats.openag.io/oada/resource.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/resource.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/resource.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly type: "object"; readonly required: readonly ["_id", "_rev", "_meta", "_type"]; readonly title: "OADA Resource"; readonly properties: { readonly _id: { readonly $ref: "../oada.schema.json#/definitions/_id"; }; readonly _rev: { readonly $ref: "../oada.schema.json#/definitions/_rev"; }; readonly _meta: { readonly $ref: "../oada.schema.json#/definitions/link/definitions/versioned"; }; readonly _type: { readonly $ref: "../oada.schema.json#/definitions/_type"; }; }; }; /** * Returns true if `val` is a @type `OADAResource`, false otherwise */ export declare function is(val: unknown): val is OADAResource; /** * Asserts that `val` is a @type `OADAResource` */ export declare function assert(val: unknown): asserts val is OADAResource; /** * * */ export default OADAResource; 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; }