/** * bookmarks is the top-level document returned by the OADA API * @example * ```json * { * "_type": "application/vnd.oada.bookmarks.1+json", * "context": {}, * "planting": { * "_id": "resources/09ijfofj", * "_rev": 2 * }, * "harvest": { * "_id": "resources/908uf2jh", * "_rev": 33 * }, * "machines": { * "_id": "respurces/0kdfj20j", * "_rev": 8 * }, * "irrigation": { * "_id": "resources/0jk2iopw", * "_rev": 4 * }, * "sales": { * "_id": "resources/0kdfj20j", * "_rev": 99 * }, * "sensors": { * "_id": "resources/kd02ufjk", * "_rev": 3 * }, * "fields": { * "_id": "resources/0kdfj2jl", * "_rev": 7 * }, * "clients": { * "_id": "resources/9sdkf2lk", * "_rev": 4 * }, * "sensor-hubs": { * "_id": "resources/xks84x8s", * "_rev": 1 * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/bookmarks/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/bookmarks/v1.schema.json} */ export declare const $id = "https://formats.openag.io/oada/bookmarks/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/bookmarks/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/bookmarks/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "bookmarks is the top-level document returned by the OADA API"; readonly properties: { readonly trellisfw: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 planting: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 harvest: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 machines: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 irrigation: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 sensors: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 fields: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 clients: { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 'sensor-hubs': { readonly description: "A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents."; 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 isoblue: { 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.bookmarks.1+json"]; }; }; readonly additionalProperties: true; readonly required: readonly ["_type"]; readonly type: "object"; readonly examples: readonly [{ readonly _type: "application/vnd.oada.bookmarks.1+json"; readonly context: {}; readonly planting: { readonly _id: "resources/09ijfofj"; readonly _rev: 2; }; readonly harvest: { readonly _id: "resources/908uf2jh"; readonly _rev: 33; }; readonly machines: { readonly _id: "respurces/0kdfj20j"; readonly _rev: 8; }; readonly irrigation: { readonly _id: "resources/0jk2iopw"; readonly _rev: 4; }; readonly sales: { readonly _id: "resources/0kdfj20j"; readonly _rev: 99; }; readonly sensors: { readonly _id: "resources/kd02ufjk"; readonly _rev: 3; }; readonly fields: { readonly _id: "resources/0kdfj2jl"; readonly _rev: 7; }; readonly clients: { readonly _id: "resources/9sdkf2lk"; readonly _rev: 4; }; readonly 'sensor-hubs': { readonly _id: "resources/xks84x8s"; readonly _rev: 1; }; }]; }; /** * 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; /** * bookmarks is the top-level document returned by the OADA API * @example * ```json * { * "_type": "application/vnd.oada.bookmarks.1+json", * "context": {}, * "planting": { * "_id": "resources/09ijfofj", * "_rev": 2 * }, * "harvest": { * "_id": "resources/908uf2jh", * "_rev": 33 * }, * "machines": { * "_id": "respurces/0kdfj20j", * "_rev": 8 * }, * "irrigation": { * "_id": "resources/0jk2iopw", * "_rev": 4 * }, * "sales": { * "_id": "resources/0kdfj20j", * "_rev": 99 * }, * "sensors": { * "_id": "resources/kd02ufjk", * "_rev": 3 * }, * "fields": { * "_id": "resources/0kdfj2jl", * "_rev": 7 * }, * "clients": { * "_id": "resources/9sdkf2lk", * "_rev": 4 * }, * "sensor-hubs": { * "_id": "resources/xks84x8s", * "_rev": 1 * } * } * ``` * */ export default V1Schema; /** * bookmarks is the top-level document returned by the OADA API */ export interface V1Schema { /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'trellisfw'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'planting'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'harvest'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'machines'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'irrigation'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'sensors'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'fields'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'clients'?: { /** * _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; }; /** * A versioned link in OADA has _id an _rev in the link in order allow changes to bubble up from child to parents. */ 'sensor-hubs'?: { /** * _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; }; /** * A link in OADA has at least an _id key and links one resource to another. */ 'isoblue'?: { /** * _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.bookmarks.1+json'; [k: string]: unknown; }