docs: update schema.json

This commit is contained in:
Sina Atalay 2024-03-10 18:13:49 +01:00
parent b734c44624
commit e5eea7948a
1 changed files with 52 additions and 37 deletions

View File

@ -155,7 +155,7 @@
}, },
"location": { "location": {
"default": null, "default": null,
"description": "The location of the person. This is not rendered currently.", "description": "The location of the person.",
"title": "Location", "title": "Location",
"allOf": [ "allOf": [
{ {
@ -220,29 +220,44 @@
"allOf": [ "allOf": [
{ {
"additionalProperties": { "additionalProperties": {
"items": { "anyOf": [
"anyOf": [ {
{ "items": {
"$ref": "#/$defs/EducationEntry"
},
{
"$ref": "#/$defs/ExperienceEntry"
},
{
"$ref": "#/$defs/PublicationEntry"
},
{
"$ref": "#/$defs/NormalEntry"
},
{
"$ref": "#/$defs/OneLineEntry" "$ref": "#/$defs/OneLineEntry"
}, },
{ "type": "array"
},
{
"items": {
"$ref": "#/$defs/NormalEntry"
},
"type": "array"
},
{
"items": {
"$ref": "#/$defs/ExperienceEntry"
},
"type": "array"
},
{
"items": {
"$ref": "#/$defs/EducationEntry"
},
"type": "array"
},
{
"items": {
"$ref": "#/$defs/PublicationEntry"
},
"type": "array"
},
{
"items": {
"type": "string" "type": "string"
} },
] "type": "array"
}, }
"type": "array" ]
}, },
"type": "object" "type": "object"
} }
@ -278,7 +293,7 @@
}, },
"end_date": { "end_date": {
"default": "2020-01-01", "default": "2020-01-01",
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start date.", "description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"present" "present"
@ -302,7 +317,7 @@
}, },
"date": { "date": {
"default": "Custom Date or 2020-01-01", "default": "Custom Date or 2020-01-01",
"description": "If the event is a one-day event, then this field should be filled in YYYY-MM-DD format. If the event is a multi-day event, then the start date and end date should be provided instead. All of them can't be provided at the same time.", "description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"My Custom Date" "My Custom Date"
@ -351,12 +366,12 @@
] ]
}, },
"institution": { "institution": {
"description": "The institution name. It will be shown as bold text.", "description": "The institution name.",
"title": "Institution", "title": "Institution",
"type": "string" "type": "string"
}, },
"area": { "area": {
"description": "The area of study. It will be shown as normal text.", "description": "The area of study.",
"title": "Area", "title": "Area",
"type": "string" "type": "string"
}, },
@ -439,7 +454,7 @@
}, },
"end_date": { "end_date": {
"default": "2020-01-01", "default": "2020-01-01",
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start date.", "description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"present" "present"
@ -463,7 +478,7 @@
}, },
"date": { "date": {
"default": "Custom Date or 2020-01-01", "default": "Custom Date or 2020-01-01",
"description": "If the event is a one-day event, then this field should be filled in YYYY-MM-DD format. If the event is a multi-day event, then the start date and end date should be provided instead. All of them can't be provided at the same time.", "description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"My Custom Date" "My Custom Date"
@ -512,12 +527,12 @@
] ]
}, },
"company": { "company": {
"description": "The company name. It will be shown as bold text.", "description": "The company name.",
"title": "Company", "title": "Company",
"type": "string" "type": "string"
}, },
"position": { "position": {
"description": "The position. It will be shown as normal text.", "description": "The position.",
"title": "Position", "title": "Position",
"type": "string" "type": "string"
} }
@ -802,7 +817,7 @@
}, },
"end_date": { "end_date": {
"default": "2020-01-01", "default": "2020-01-01",
"description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start date.", "description": "The end date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format. If the event is still ongoing, then type \"present\" or provide only the start_date.",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"present" "present"
@ -826,7 +841,7 @@
}, },
"date": { "date": {
"default": "Custom Date or 2020-01-01", "default": "Custom Date or 2020-01-01",
"description": "If the event is a one-day event, then this field should be filled in YYYY-MM-DD format. If the event is a multi-day event, then the start date and end date should be provided instead. All of them can't be provided at the same time.", "description": "If the event is a one-day event, then this field can be filled in YYYY-MM-DD format. Also, this field can be used if you would like to use a custom date string (like \"Fall 2020\").",
"examples": [ "examples": [
"2020-09-24", "2020-09-24",
"My Custom Date" "My Custom Date"
@ -875,7 +890,7 @@
] ]
}, },
"name": { "name": {
"description": "The name of the entry. It will be shown as bold text.", "description": "The name of the NormalEntry.",
"title": "Name", "title": "Name",
"type": "string" "type": "string"
} }
@ -890,19 +905,19 @@
"additionalProperties": false, "additionalProperties": false,
"description": "This class is the data model of `OneLineEntry`.", "description": "This class is the data model of `OneLineEntry`.",
"properties": { "properties": {
"name": { "label": {
"description": "The name of the entry. It will be shown as bold text.", "description": "The label of the OneLineEntry.",
"title": "Name", "title": "Name",
"type": "string" "type": "string"
}, },
"details": { "details": {
"description": "The details of the entry. It will be shown as normal text.", "description": "The details of the OneLineEntry.",
"title": "Details", "title": "Details",
"type": "string" "type": "string"
} }
}, },
"required": [ "required": [
"name", "label",
"details" "details"
], ],
"title": "OneLineEntry", "title": "OneLineEntry",
@ -949,7 +964,7 @@
"description": "This class is the data model of `PublicationEntry`.", "description": "This class is the data model of `PublicationEntry`.",
"properties": { "properties": {
"title": { "title": {
"description": "The title of the publication. It will be shown as bold text.", "description": "The title of the publication.",
"title": "Title of the Publication", "title": "Title of the Publication",
"type": "string" "type": "string"
}, },