feat: use tag @validatable to mark schema types

src/core/files/ConfigFile.ts

@@ -12,12 +12,13 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
-import { SCAppConfiguration } from '../types/config/App';
-import { SCBackendConfiguration, SCBackendInternalConfiguration } from '../types/config/Backend';
-import { SCLicensePlate } from '../types/namespaces';
+import {SCAppConfiguration} from '../types/config/App';
+import {SCBackendConfiguration, SCBackendInternalConfiguration} from '../types/config/Backend';
+import {SCLicensePlate} from '../types/namespaces';
 
 /**
  * A configuration file that configures app and backend
+ * @validatable
  */
 export interface SCConfigFile {
 

src/core/protocol/errors/ErrorResponse.ts

@@ -16,6 +16,8 @@ import {ValidationError} from 'jsonschema';
 
 /**
  * A generic error that can be returned by the backend if somethings fails during the processing of a request
+ *
+ * @validatable
  */
 export interface SCErrorResponse extends Error {
   /**
@@ -126,11 +128,11 @@ export class SCNotFoundErrorResponse extends SCError {
 }
 
 /**
- * An error that is returned, when an internal server error occured
+ * An error that is returned, when an internal server error occurred
  */
 export class SCInternalServerErrorResponse extends SCError {
   /**
-   * Internal error that occured. If the stack is disabled this error is not set for security reasons
+   * Internal error that occurred. If the stack is disabled this error is not set for security reasons
    */
   additionalData?: Error;
 

src/core/protocol/routes/INDEX/IndexRequest.ts

@@ -16,6 +16,8 @@ import {SCAbstractRoute} from '../../../Route';
 
 /**
  * Index request
+ *
+ * @validatable
  */
 export interface SCIndexRequest {
 }

src/core/protocol/routes/INDEX/IndexResponse.ts

@@ -17,6 +17,8 @@ import {SCBackendConfiguration} from '../../../types/config/Backend';
 
 /**
  * A response to an index request
+ *
+ * @validatable
  */
 export interface SCIndexResponse {
   app: SCAppConfiguration;

src/core/protocol/routes/TYPE/UID/ThingUpdateRequest.ts

@@ -17,6 +17,8 @@ import {SCAbstractRoute} from '../../../../Route';
 
 /**
  * Request to update an existing thing
+ *
+ * @validatable
  */
 export type SCThingUpdateRequest = SCThings;
 

src/core/protocol/routes/TYPE/UID/ThingUpdateResponse.ts

@@ -14,6 +14,8 @@
  */
 /**
  * Response for an entity update request
+ *
+ * @validatable
  */
 export interface SCThingUpdateResponse {
 }

src/core/protocol/routes/bookAvailability/BookAvailabilityRequest.ts

@@ -17,6 +17,7 @@ import {SCUuid} from '../../../types/UUID';
 
 /**
  * Request to check the availability of books
+ * @validatable
  */
 export type SCBookAvailabilityRequest = SCBookAvailabilityRequestByIsbn | SCBookAvailabilityRequestByUuid;
 

src/core/protocol/routes/bookAvailability/BookAvailabilityResponse.ts

@@ -16,5 +16,6 @@ import {SCAcademicPriceGroup, SCThingThatCanBeOfferedOffer} from '../../../base/
 
 /**
  * List of availabilities of a book
+ * @validatable
  */
 export type SCBookAvailabilityResponse = Array<SCThingThatCanBeOfferedOffer<SCAcademicPriceGroup>>;

src/core/protocol/routes/bulk/BulkRequest.ts

@@ -20,6 +20,8 @@ import {SCISO8601Date} from '../../../types/Time';
  * A bulk request
  *
  * Parameters to be sent to request a new bulk.
+ *
+ * @validatable
  */
 export interface SCBulkRequest extends SCBulkParameters {
 }

src/core/protocol/routes/bulk/BulkResponse.ts

@@ -17,6 +17,8 @@ import {SCBulkParameters} from './BulkRequest';
 
 /**
  * Requested Bulk from backend
+ *
+ * @validatable
  */
 export interface SCBulkResponse extends SCBulkParameters {
   /**

src/core/protocol/routes/bulk/UID/BulkAddRequest.ts

@@ -17,6 +17,7 @@ import {SCAbstractRoute} from '../../../../Route';
 
 /**
  * Request to add a thing to a bulk
+ * @validatable
  */
 export type SCBulkAddRequest = SCThings;
 

src/core/protocol/routes/bulk/UID/BulkAddResponse.ts

@@ -14,6 +14,7 @@
  */
 /**
  * Response to a request to add a thing to a bulk
+ * @validatable
  */
 export interface SCBulkAddResponse {
 }

src/core/protocol/routes/bulk/UID/BulkDoneRequest.ts

@@ -16,6 +16,7 @@ import {SCAbstractRoute} from '../../../../Route';
 
 /**
  * Request to change the bulk state to done (close the bulk process)
+ * @validatable
  */
 export interface SCBulkDoneRequest {
 }

src/core/protocol/routes/bulk/UID/BulkDoneResponse.ts

@@ -14,6 +14,7 @@
  */
 /**
  * Response to a request to change the state of a bulk to done
+ * @validatable
  */
 export interface SCBulkDoneResponse {
 }

src/core/protocol/routes/feedback/FeedbackRequest.ts

@@ -17,6 +17,8 @@ import {SCMessage} from '../../../things/Message';
 
 /**
  * User feedback
+ *
+ * @validatable
  */
 export interface SCFeedbackRequest extends SCMessage {
   /**

src/core/protocol/routes/feedback/FeedbackResponse.ts

@@ -14,6 +14,8 @@
  */
 /**
  * A response to a feedback request
+ *
+ * @validatable
  */
 export interface SCFeedbackResponse {
 }

src/core/protocol/routes/search/MultiSearchRequest.ts

@@ -21,6 +21,8 @@ import {SCSearchQuery} from './SearchRequest';
  * This is a map of [[SCSearchRequest]]s indexed by name.
  *
  * **CAUTION: This is limited to an amount of queries. Currently this limit is 5.**
+ *
+ * @validatable
  */
 export interface SCMultiSearchRequest {
   [k: string]: SCSearchQuery;

src/core/protocol/routes/search/MultiSearchResponse.ts

@@ -18,6 +18,8 @@ import {SCSearchResult} from './SearchResponse';
  * A multi search response
  *
  * This is a map of [[SCSearchResponse]]s indexed by name
+ *
+ * @validatable
  */
 export interface SCMultiSearchResponse {
   [k: string]: SCSearchResult;

src/core/protocol/routes/search/SearchRequest.ts

@@ -18,6 +18,8 @@ import {SCSearchSort} from '../../../types/sorts/Abstract';
 
 /**
  * A search request
+ *
+ * @validatable
  */
 export interface SCSearchRequest extends SCSearchQuery {
 }

src/core/protocol/routes/search/SearchResponse.ts

@@ -16,6 +16,8 @@ import {SCThings, SCThingsField} from '../../../Classes';
 
 /**
  * A search response
+ *
+ * @validatable
  */
 export interface SCSearchResponse extends SCSearchResult {
 }

src/core/things/AcademicEvent.ts

@@ -49,6 +49,11 @@ export interface SCAcademicEventWithoutReferences
   type: SCThingType.AcademicEvent;
 }
 
+/**
+ * An academic event
+ *
+ * @validatable
+ */
 export interface SCAcademicEvent extends SCEvent, SCAcademicEventWithoutReferences {
   /**
    * Translated fields of an academic event

src/core/things/Article.ts

@@ -50,6 +50,8 @@ export interface SCArticleWithoutReferences
 
 /**
  * An article
+ *
+ * @validatable
  */
 export interface SCArticle extends SCCreativeWork, SCArticleWithoutReferences {
   /**

src/core/things/Book.ts

@@ -54,6 +54,8 @@ export interface SCBookWithoutReferences extends SCCreativeWorkWithoutReferences
 
 /**
  * A book
+ *
+ * @validatable
  */
 export interface SCBook extends SCCreativeWork, SCBookWithoutReferences {
   /**

src/core/things/Building.ts

@@ -56,6 +56,11 @@ export interface SCBuildingWithoutReferences
   type: SCThingType.Building;
 }
 
+/**
+ * A building
+ *
+ * @validatable
+ */
 export interface SCBuilding extends SCBuildingWithoutReferences {
   /**
    * Type of the building

src/core/things/Catalog.ts

@@ -37,6 +37,8 @@ export interface SCCatalogWithoutReferences
 
 /**
  * A catalog
+ *
+ * @validatable
  */
 export interface SCCatalog extends SCCatalogWithoutReferences {
   /**

src/core/things/CourseOfStudies.ts

@@ -61,6 +61,8 @@ export interface SCCourseOfStudiesWithoutReferences extends
 
 /**
  * A course of studies
+ *
+ * @validatable
  */
 export interface SCCourseOfStudies extends SCCourseOfStudiesWithoutReferences {
   /**

src/core/things/DateSeries.ts

@@ -73,6 +73,8 @@ export interface SCDateSeriesWithoutReferences
 
 /**
  * A date series
+ *
+ * @validatable
  */
 export interface SCDateSeries extends SCDateSeriesWithoutReferences, SCThingInPlace {
   /**

src/core/things/Diff.ts

@@ -12,6 +12,7 @@
  * You should have received a copy of the GNU General Public License along with
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
+import * as jsonpatch from 'json-patch';
 import {SCThingsWithoutDiff} from '../Classes';
 import {SCThing, SCThingMeta, SCThingType} from '../Thing';
 import {SCISO8601Date} from '../types/Time';
@@ -43,6 +44,8 @@ export interface SCDiffWithoutReferences extends SCThing {
 
 /**
  * A diff
+ *
+ * @validatable
  */
 export interface SCDiff extends SCDiffWithoutReferences {
   /**

src/core/things/Dish.ts

@@ -66,6 +66,8 @@ export interface SCDishWithoutReferences
 
 /**
  * A dish
+ *
+ * @validatable
  */
 export interface SCDish extends SCDishWithoutReferences, SCThingInPlace {
   /**

src/core/things/Favorite.ts

@@ -50,6 +50,8 @@ export interface SCFavoriteWithoutReferences extends SCThing {
 
 /**
  * A favorite
+ *
+ * @validatable
  */
 export interface SCFavorite extends SCFavoriteWithoutReferences {
   /**

src/core/things/Floor.ts

@@ -46,6 +46,8 @@ export interface SCFloorWithoutReferences extends SCThing {
 
 /**
  * A floor
+ *
+ * @validatable
  */
 export interface SCFloor extends SCFloorWithoutReferences, SCThingInPlace {
   /**

src/core/things/Message.ts

@@ -54,6 +54,8 @@ export interface SCMessageWithoutReferences extends SCCreativeWorkWithoutReferen
 
 /**
  * A message
+ *
+ * @validatable
  */
 export interface SCMessage extends SCCreativeWork, SCMessageWithoutReferences {
   /**

src/core/things/Organization.ts

@@ -27,6 +27,8 @@ export interface SCOrganizationWithoutReferences extends SCThing {
 
 /**
  * An organization
+ *
+ * @validatable
  */
 export interface SCOrganization extends SCOrganizationWithoutReferences, SCThingInPlace {
   /**

src/core/things/Person.ts

@@ -99,6 +99,8 @@ export interface SCPersonWithoutReferences extends SCThing {
 
 /**
  * A person
+ *
+ * @validatable
  */
 export interface SCPerson extends SCPersonWithoutReferences {
   /**

src/core/things/PointOfInterest.ts

@@ -42,6 +42,8 @@ export interface SCPointOfInterestWithoutReferences
 
 /**
  * A point of interest
+ *
+ * @validatable
  */
 export interface SCPointOfInterest extends SCPointOfInterestWithoutReferences, SCThingInPlace {
   /**

src/core/things/Room.ts

@@ -70,6 +70,8 @@ export interface SCRoomWithoutReferences
 
 /**
  * A room
+ *
+ * @validatable
  */
 export interface SCRoom extends SCRoomWithoutReferences, SCThingInPlace {
   /**

src/core/things/Semester.ts

@@ -34,6 +34,8 @@ export interface SCSemesterWithoutReferences extends SCAcademicTermWithoutRefere
 
 /**
  * A semester
+ *
+ * @validatable
  */
 export interface SCSemester extends SCSemesterWithoutReferences {
   /**

src/core/things/Setting.ts

@@ -13,11 +13,12 @@
  * this program. If not, see <https://www.gnu.org/licenses/>.
  */
 import {
-  SCThingWithCategoriesSpecificValues, SCThingWithCategoriesTranslatableProperties,
+  SCThingWithCategoriesSpecificValues,
+  SCThingWithCategoriesTranslatableProperties,
   SCThingWithCategoriesWithoutReferences,
 } from '../base/ThingWithCategories';
 import {SCThingMeta, SCThingType} from '../Thing';
-import { SCTranslations } from '../types/i18n';
+import {SCTranslations} from '../types/i18n';
 
 export type SCSettingCategories = string;
 
@@ -56,6 +57,8 @@ export type SCSettingInputType = SCSettingSingleChoice
 
 /**
  * A setting with references
+ *
+ * @validatable
  */
 export interface SCSetting extends SCSettingWithoutReferences {
   /**

src/core/things/SportCourse.ts

@@ -27,6 +27,8 @@ export interface SCSportCourseWithoutReferences extends SCEventWithoutReferences
 
 /**
  * A sport course
+ *
+ * @validatable
  */
 export interface SCSportCourse extends SCEvent, SCSportCourseWithoutReferences {
   /**

src/core/things/Ticket.ts

@@ -43,6 +43,8 @@ export interface SCTicketWithoutReferences extends SCThing {
 
 /**
  * A ticket
+ *
+ * @validatable
  */
 export interface SCTicket extends SCTicketWithoutReferences, SCThingInPlace {
   /**

src/core/things/Tour.ts

@@ -36,6 +36,8 @@ export interface SCTourWithoutReferences extends SCThing {
 
 /**
  * A tour
+ *
+ * @validatable
  */
 export interface SCTour extends SCTourWithoutReferences {
   /**

src/core/things/Video.ts

@@ -99,6 +99,8 @@ export interface SCVideoTrack {
 
 /**
  * A video
+ *
+ * @validatable
  */
 export interface SCVideo extends SCCreativeWork, SCVideoWithoutReferences {
   /**