feat: add ES annotations

This commit is contained in:
Benjamin Jöckel
2019-05-10 11:47:06 +02:00
parent 55b5248660
commit 9c424b0f96
41 changed files with 263 additions and 2 deletions

View File

@@ -27,6 +27,8 @@ export interface SCPersonWithoutReferences
extends SCThingWithoutReferences {
/**
* Additional first names of the person.
*
* @keyword
*/
additionalName?: string;
@@ -39,16 +41,22 @@ export interface SCPersonWithoutReferences
* The private email address of the person.
*
* @TJS-format email
*
* @keyword
*/
email?: string;
/**
* The family name of the person.
*
* @keyword
*/
familyName: string;
/**
* The private fax number of the person.
*
* @keyword
*/
faxNumber?: string;
@@ -59,26 +67,36 @@ export interface SCPersonWithoutReferences
/**
* The first name of the person.
*
* @keyword
*/
givenName: string;
/**
* Honorific prefix of the person.
*
* @keyword
*/
honorificPrefix?: string;
/**
* Honorific suffix of the person.
*
* @keyword
*/
honorificSuffix?: string;
/**
* Titles of jobs that the person has.
*
* @keyword
*/
jobTitles?: string[];
/**
* The complete name of the person combining all the parts of the name into one.
*
* @text
*/
name: string;
@@ -89,6 +107,8 @@ export interface SCPersonWithoutReferences
/**
* The private telephone number of the person.
*
* @keyword
*/
telephone?: string;
@@ -102,6 +122,7 @@ export interface SCPersonWithoutReferences
* A person
*
* @validatable
* @indexable
*/
export interface SCPerson
extends SCPersonWithoutReferences, SCThing {
@@ -210,26 +231,36 @@ export interface SCContactPoint {
/**
* E-mail at the work location
*
* @keyword
*/
email?: string;
/**
* Fax number at the work location
*
* @keyword
*/
faxNumber?: string;
/**
* Times available for contacting at the work location
*
* @keyword
*/
hoursAvailable?: string;
/**
* Contact number at the work location
*
* @keyword
*/
telephone?: string;
/**
* URL at the work location
*
* @keyword
*/
url?: string;
}