/** * bookmarks is the top-level document returned by the OADA API * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/bookmarks.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.schema.json} */ export declare const $id = "https://formats.openag.io/oada/bookmarks.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/bookmarks.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/bookmarks.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 definitions: { readonly v1: { readonly type: "object"; readonly properties: { readonly _type: { readonly enum: readonly ["application/vnd.oada.bookmarks.1+.json"]; }; }; }; }; readonly allOf: readonly [{ readonly $ref: "resource.schema.json#"; }, { readonly anyOf: readonly [{ readonly $ref: "#/definitions/v1"; }, { readonly type: "object"; readonly properties: { readonly _type: { readonly type: "string"; readonly pattern: "application/vnd\\.oada\\.bookmarks\\.[0-9]+\\+\\.json"; }; }; }]; }]; }; /** * Returns true if `val` is a @type `BookmarksSchema`, false otherwise */ export declare function is(val: unknown): val is BookmarksSchema; /** * Asserts that `val` is a @type `BookmarksSchema` */ export declare function assert(val: unknown): asserts val is BookmarksSchema; /** * bookmarks is the top-level document returned by the OADA API * */ export default BookmarksSchema; /** * bookmarks is the top-level document returned by the OADA API */ export type BookmarksSchema = OADAResource & (V1 | { _type?: string; [k: string]: unknown; }); 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 V1 { _type?: 'application/vnd.oada.bookmarks.1+.json'; [k: string]: unknown; }