/** * application/vnd.oada.user.1+json * @example * ```json * { * "bookmarks": { * "_id": "kdjsl028ifej", * "_rev": 2 * }, * "username": "frank", * "name": "Farmer Frank", * "family_name": "Frank", * "given_name": "Farmer", * "middle_name": "", * "nickname": "Frankie", * "email": "frank@openag.io" * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./oada/user/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/user/v1.schema.json} */ export declare const $id = "https://formats.openag.io/oada/user/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/oada/user/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/oada/user/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "application/vnd.oada.user.1+json"; readonly additionalProperties: true; readonly properties: { readonly bookmarks: { readonly $ref: "https://formats.openag.io/oada/link/v1.schema.json#/definitions/versioned"; }; }; readonly examples: readonly [{ readonly bookmarks: { readonly _id: "kdjsl028ifej"; readonly _rev: 2; }; readonly username: "frank"; readonly name: "Farmer Frank"; readonly family_name: "Frank"; readonly given_name: "Farmer"; readonly middle_name: ""; readonly nickname: "Frankie"; readonly email: "frank@openag.io"; }]; }; /** * 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; /** * application/vnd.oada.user.1+json * @example * ```json * { * "bookmarks": { * "_id": "kdjsl028ifej", * "_rev": 2 * }, * "username": "frank", * "name": "Farmer Frank", * "family_name": "Frank", * "given_name": "Farmer", * "middle_name": "", * "nickname": "Frankie", * "email": "frank@openag.io" * } * ``` * */ export default V1Schema; /** * application/vnd.oada.user.1+json */ export interface V1Schema { bookmarks?: Versioned; [k: string]: unknown; } export interface Versioned { _id: string; /** * _rev is the revision for a resource in the OADA API. */ _rev: number; [k: string]: unknown; }