From c3214595ef03392a3e88328cbe47757d35a35936 Mon Sep 17 00:00:00 2001 From: Art Lowel Date: Tue, 14 Feb 2017 09:59:24 +0100 Subject: [PATCH] added doc --- src/app/core/dspace-rest-v2/dspace-rest-v2.validator.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/app/core/dspace-rest-v2/dspace-rest-v2.validator.ts b/src/app/core/dspace-rest-v2/dspace-rest-v2.validator.ts index 69d895c79b..9cc88f1536 100644 --- a/src/app/core/dspace-rest-v2/dspace-rest-v2.validator.ts +++ b/src/app/core/dspace-rest-v2/dspace-rest-v2.validator.ts @@ -1,12 +1,20 @@ import * as schema from './dspace-rest-v2.schema.json' import { Validator } from "jsonschema"; +/** + * Verifies a document is a valid response from + * a DSpace REST API v2 + */ export class DSpaceRESTv2Validator { constructor(private document: any) { } + /** + * Throws an exception if this.document isn't a valid response from + * a DSpace REST API v2. Succeeds otherwise. + */ validate(): void { const validator = new Validator(); const result = validator.validate(this.document, schema);