/** * This is document with a list of links to certifications. The keys are random strings. It is also possible to have a dynamic index that represents a set of smaller groups of certifications. In that case, an id-index key or other grouping would be found here. * @example * ```json * { * "_id": "resources/902j3kfljwf0932", * "_rev": 1, * "_meta": { * "_id": "resources/f2h0829i322/_meta", * "_rev": 1 * }, * "_type": "application/vnd.trellis.certifications.1+json", * "idjofkwjfsdD": { * "_id": "8f2ofj2308f2i", * "_rev": 1 * } * } * ``` * * * File automatically generated using json-schema-to-typescript. * ! DO NOT MODIFY IT BY HAND ! * Instead, modify the source file ./trellis/certifications/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/trellis/certifications/v1.schema.json} */ export declare const $id = "https://formats.openag.io/trellis/certifications/v1.schema.json"; /** * JSON Schema used to generate this type * @see {@link https://formats.openag.io/trellis/certifications/v1.schema.json} */ export declare const schema: { readonly $id: "https://formats.openag.io/trellis/certifications/v1.schema.json"; readonly $schema: "http://json-schema.org/draft-07/schema#"; readonly description: "This is document with a list of links to certifications. The keys are random strings. It is also possible to have a dynamic index that represents a set of smaller groups of certifications. In that case, an id-index key or other grouping would be found here."; readonly patternProperties: { readonly '^(?!(indexing|.*-index|_.*)).*$': { 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 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 _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.trellis.certifications.1+json"]; }; }; readonly additionalProperties: true; readonly required: readonly ["_type"]; readonly type: "object"; readonly examples: readonly [{ readonly _id: "resources/902j3kfljwf0932"; readonly _rev: 1; readonly _meta: { readonly _id: "resources/f2h0829i322/_meta"; readonly _rev: 1; }; readonly _type: "application/vnd.trellis.certifications.1+json"; readonly idjofkwjfsdD: { readonly _id: "8f2ofj2308f2i"; 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; /** * This is document with a list of links to certifications. The keys are random strings. It is also possible to have a dynamic index that represents a set of smaller groups of certifications. In that case, an id-index key or other grouping would be found here. * @example * ```json * { * "_id": "resources/902j3kfljwf0932", * "_rev": 1, * "_meta": { * "_id": "resources/f2h0829i322/_meta", * "_rev": 1 * }, * "_type": "application/vnd.trellis.certifications.1+json", * "idjofkwjfsdD": { * "_id": "8f2ofj2308f2i", * "_rev": 1 * } * } * ``` * */ export default V1Schema; /** * This is document with a list of links to certifications. The keys are random strings. It is also possible to have a dynamic index that represents a set of smaller groups of certifications. In that case, an id-index key or other grouping would be found here. */ export interface V1Schema { /** * _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.trellis.certifications.1+json'; [k: string]: unknown; }