refactor: add @filterable tag to filterable properties

This commit is contained in:
Sebastian Lange
2019-09-16 11:21:09 +02:00
parent 49b55db66f
commit 5561b36a34
20 changed files with 67 additions and 0 deletions

View File

@@ -18,11 +18,15 @@
export interface SCLanguage { export interface SCLanguage {
/** /**
* The two letter ISO 639-1 Code of the Language * The two letter ISO 639-1 Code of the Language
*
* @filterable
*/ */
code: SCLanguageCode; code: SCLanguageCode;
/** /**
* The Fulltext name of the Language * The Fulltext name of the Language
*
* @filterable
*/ */
name: SCLanguageName; name: SCLanguageName;
} }

View File

@@ -29,6 +29,7 @@ export interface SCAcademicDegreeWithoutReferences
* The achievable academic degree with academic field specification * The achievable academic degree with academic field specification
* (eg. Master of Science) * (eg. Master of Science)
* *
* @filterable
* @keyword * @keyword
*/ */
academicDegreewithField: string; academicDegreewithField: string;
@@ -37,6 +38,7 @@ export interface SCAcademicDegreeWithoutReferences
* The achievable academic degree with academic field specification * The achievable academic degree with academic field specification
* shorted (eg. M.Sc.). * shorted (eg. M.Sc.).
* *
* @filterable
* @keyword * @keyword
*/ */
academicDegreewithFieldShort: string; academicDegreewithFieldShort: string;

View File

@@ -32,21 +32,29 @@ export interface SCAcademicTermWithoutReferences
/** /**
* End date of the academic term * End date of the academic term
*
* @filterable
*/ */
endDate: SCISO8601Date; endDate: SCISO8601Date;
/** /**
* End date of lectures in the academic term * End date of lectures in the academic term
*
* @filterable
*/ */
eventsEndDate?: SCISO8601Date; eventsEndDate?: SCISO8601Date;
/** /**
* Start date of lectures in the academic term * Start date of lectures in the academic term
*
* @filterable
*/ */
eventsStartDate?: SCISO8601Date; eventsStartDate?: SCISO8601Date;
/** /**
* Start date of the academic term * Start date of the academic term
*
* @filterable
*/ */
startDate: SCISO8601Date; startDate: SCISO8601Date;
} }

View File

@@ -32,6 +32,8 @@ export interface SCCreativeWorkWithoutReferences
extends SCThingWithoutReferences, SCThingThatCanBeOfferedWithoutReferences { extends SCThingWithoutReferences, SCThingThatCanBeOfferedWithoutReferences {
/** /**
* Date the creative work was published * Date the creative work was published
*
* @filterable
*/ */
datePublished?: SCISO8601Date; datePublished?: SCISO8601Date;

View File

@@ -40,31 +40,43 @@ export interface SCGeoInformation {
export interface SCPostalAddress { export interface SCPostalAddress {
/** /**
* Country of the address * Country of the address
*
* @filterable
*/ */
addressCountry: string; addressCountry: string;
/** /**
* City of the address * City of the address
*
* @filterable
*/ */
addressLocality: string; addressLocality: string;
/** /**
* State of the address * State of the address
*
* @filterable
*/ */
addressRegion?: string; addressRegion?: string;
/** /**
* Zip code of the address * Zip code of the address
*
* @filterable
*/ */
postalCode: string; postalCode: string;
/** /**
* Optional post box number * Optional post box number
*
* @filterable
*/ */
postOfficeBoxNumber?: string; postOfficeBoxNumber?: string;
/** /**
* Street of the address - with house number! * Street of the address - with house number!
*
* @filterable
*/ */
streetAddress: string; streetAddress: string;
} }

View File

@@ -30,6 +30,8 @@ export interface SCThingThatAcceptsPaymentsWithoutReferences
extends SCThingWithoutReferences { extends SCThingWithoutReferences {
/** /**
* Accepted payments of the place * Accepted payments of the place
*
* @filterable
*/ */
paymentsAccepted?: SCThingThatAcceptsPaymentsAcceptedPayments[]; paymentsAccepted?: SCThingThatAcceptsPaymentsAcceptedPayments[];
} }

View File

@@ -55,6 +55,7 @@ export interface SCThingWithoutReferences {
/** /**
* Alternate names of the thing * Alternate names of the thing
* *
* @filterable
* @keyword * @keyword
*/ */
alternateNames?: string[]; alternateNames?: string[];
@@ -74,6 +75,7 @@ export interface SCThingWithoutReferences {
/** /**
* Name of the thing * Name of the thing
* *
* @filterable
* @minLength 1 * @minLength 1
* @sortable ducet * @sortable ducet
* @text * @text

View File

@@ -41,6 +41,7 @@ export interface SCAcademicEventWithoutReferences
/** /**
* Original unmapped category from the source of the academic event * Original unmapped category from the source of the academic event
* *
* @filterable
* @keyword * @keyword
*/ */
originalCategory?: string; originalCategory?: string;

View File

@@ -31,6 +31,7 @@ export interface SCBookWithoutReferences
/** /**
* Edition of a book * Edition of a book
* *
* @filterable
* @keyword * @keyword
*/ */
bookEdition?: string; bookEdition?: string;
@@ -38,6 +39,7 @@ export interface SCBookWithoutReferences
/** /**
* ISBN of a book * ISBN of a book
* *
* @filterable
* @keyword * @keyword
*/ */
isbn: string; isbn: string;

View File

@@ -53,6 +53,7 @@ export interface SCBuildingWithoutReferences
/** /**
* List of floor names of the place * List of floor names of the place
* *
* @filterable
* @keyword * @keyword
*/ */
floors?: string[]; floors?: string[];

View File

@@ -39,6 +39,7 @@ export interface SCCourseOfStudiesWithoutReferences
/** /**
* Actual major of the course of studies (eg. physics) * Actual major of the course of studies (eg. physics)
* *
* @filterable
* @keyword * @keyword
*/ */
major: string; major: string;

View File

@@ -47,6 +47,8 @@ export interface SCDateSeriesWithoutReferences
extends SCThingThatCanBeOfferedWithoutReferences { extends SCThingThatCanBeOfferedWithoutReferences {
/** /**
* Dates of the date series that are initially planned to be held * Dates of the date series that are initially planned to be held
*
* @filterable
*/ */
dates: SCISO8601Date[]; dates: SCISO8601Date[];

View File

@@ -38,6 +38,7 @@ export interface SCDishWithoutReferences
/** /**
* Additives of the dish * Additives of the dish
* *
* @filterable
* @keyword * @keyword
*/ */
additives?: string[]; additives?: string[];
@@ -119,6 +120,7 @@ export interface SCDishCharacteristic {
/** /**
* Name of the characteristic * Name of the characteristic
* *
* @filterable
* @text * @text
*/ */
name: string; name: string;

View File

@@ -36,11 +36,15 @@ export interface SCMessageWithoutReferences
/** /**
* Roles for which the message is intended * Roles for which the message is intended
*
* @filterable
*/ */
audiences: SCMessageAudience[]; audiences: SCMessageAudience[];
/** /**
* When the message was created * When the message was created
*
* @filterable
*/ */
dateCreated?: SCISO8601Date; dateCreated?: SCISO8601Date;

View File

@@ -28,12 +28,15 @@ export interface SCPersonWithoutReferences
/** /**
* Additional first names of the person. * Additional first names of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
additionalName?: string; additionalName?: string;
/** /**
* The birth date of the person. * The birth date of the person.
*
* @filterable
*/ */
birthDate?: SCISO8601Date; birthDate?: SCISO8601Date;
@@ -42,6 +45,7 @@ export interface SCPersonWithoutReferences
* *
* @TJS-format email * @TJS-format email
* *
* @filterable
* @keyword * @keyword
*/ */
email?: string; email?: string;
@@ -49,6 +53,7 @@ export interface SCPersonWithoutReferences
/** /**
* The family name of the person. * The family name of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
familyName: string; familyName: string;
@@ -56,18 +61,22 @@ export interface SCPersonWithoutReferences
/** /**
* The private fax number of the person. * The private fax number of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
faxNumber?: string; faxNumber?: string;
/** /**
* The gender of the person. * The gender of the person.
*
* @filterable
*/ */
gender?: SCPersonGender; gender?: SCPersonGender;
/** /**
* The first name of the person. * The first name of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
givenName: string; givenName: string;
@@ -75,6 +84,7 @@ export interface SCPersonWithoutReferences
/** /**
* Honorific prefix of the person. * Honorific prefix of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
honorificPrefix?: string; honorificPrefix?: string;
@@ -82,6 +92,7 @@ export interface SCPersonWithoutReferences
/** /**
* Honorific suffix of the person. * Honorific suffix of the person.
* *
* @filterable
* @keyword * @keyword
*/ */
honorificSuffix?: string; honorificSuffix?: string;
@@ -89,6 +100,7 @@ export interface SCPersonWithoutReferences
/** /**
* Titles of jobs that the person has. * Titles of jobs that the person has.
* *
* @filterable
* @keyword * @keyword
*/ */
jobTitles?: string[]; jobTitles?: string[];
@@ -96,6 +108,7 @@ export interface SCPersonWithoutReferences
/** /**
* The complete name of the person combining all the parts of the name into one. * The complete name of the person combining all the parts of the name into one.
* *
* @filterable
* @text * @text
*/ */
name: string; name: string;

View File

@@ -58,6 +58,7 @@ export interface SCRoomWithoutReferences
/** /**
* The name of the floor in which the room is in. * The name of the floor in which the room is in.
* *
* @filterable
* @text * @text
*/ */
floorName?: string; floorName?: string;

View File

@@ -28,6 +28,7 @@ export interface SCSemesterWithoutReferences
/** /**
* The short name of the semester, using the given pattern. * The short name of the semester, using the given pattern.
* *
* @filterable
* @pattern ^(WS|SS) [0-9]{4}(/[0-9]{2})?$ * @pattern ^(WS|SS) [0-9]{4}(/[0-9]{2})?$
* @keyword * @keyword
*/ */

View File

@@ -47,6 +47,7 @@ export interface SCStudyModuleWithoutReferences
/** /**
* Majors that this study module is meant for * Majors that this study module is meant for
* *
* @filterable
* @keyword * @keyword
*/ */
majors: string[]; majors: string[];

View File

@@ -35,6 +35,8 @@ export interface SCToDoWithoutReferences
/** /**
* A date when the "to do" is due * A date when the "to do" is due
*
* @filterable
*/ */
dueDate?: SCISO8601Date; dueDate?: SCISO8601Date;

View File

@@ -68,6 +68,8 @@ export interface SCVideoSource {
/** /**
* MIME-Type of the source File * MIME-Type of the source File
*
* @filterable
*/ */
mimeType: SCVideoMimeType; mimeType: SCVideoMimeType;
@@ -101,6 +103,8 @@ export interface SCVideoTrack {
/** /**
* Content Type of the Track File * Content Type of the Track File
*
* @filterable
*/ */
type: SCVideoTrackTypes; type: SCVideoTrackTypes;