From e5eea7948ad9ec300b238b20d7e4b5739c5db81d Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Sun, 10 Mar 2024 18:13:49 +0100 Subject: [PATCH] docs: update schema.json --- schema.json | 89 +++++++++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 37 deletions(-) diff --git a/schema.json b/schema.json index 1a47611..2750244 100644 --- a/schema.json +++ b/schema.json @@ -155,7 +155,7 @@ }, "location": { "default": null, - "description": "The location of the person. This is not rendered currently.", + "description": "The location of the person.", "title": "Location", "allOf": [ { @@ -220,29 +220,44 @@ "allOf": [ { "additionalProperties": { - "items": { - "anyOf": [ - { - "$ref": "#/$defs/EducationEntry" - }, - { - "$ref": "#/$defs/ExperienceEntry" - }, - { - "$ref": "#/$defs/PublicationEntry" - }, - { - "$ref": "#/$defs/NormalEntry" - }, - { + "anyOf": [ + { + "items": { "$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": "array" + }, + "type": "array" + } + ] }, "type": "object" } @@ -278,7 +293,7 @@ }, "end_date": { "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": [ "2020-09-24", "present" @@ -302,7 +317,7 @@ }, "date": { "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": [ "2020-09-24", "My Custom Date" @@ -351,12 +366,12 @@ ] }, "institution": { - "description": "The institution name. It will be shown as bold text.", + "description": "The institution name.", "title": "Institution", "type": "string" }, "area": { - "description": "The area of study. It will be shown as normal text.", + "description": "The area of study.", "title": "Area", "type": "string" }, @@ -439,7 +454,7 @@ }, "end_date": { "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": [ "2020-09-24", "present" @@ -463,7 +478,7 @@ }, "date": { "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": [ "2020-09-24", "My Custom Date" @@ -512,12 +527,12 @@ ] }, "company": { - "description": "The company name. It will be shown as bold text.", + "description": "The company name.", "title": "Company", "type": "string" }, "position": { - "description": "The position. It will be shown as normal text.", + "description": "The position.", "title": "Position", "type": "string" } @@ -802,7 +817,7 @@ }, "end_date": { "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": [ "2020-09-24", "present" @@ -826,7 +841,7 @@ }, "date": { "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": [ "2020-09-24", "My Custom Date" @@ -875,7 +890,7 @@ ] }, "name": { - "description": "The name of the entry. It will be shown as bold text.", + "description": "The name of the NormalEntry.", "title": "Name", "type": "string" } @@ -890,19 +905,19 @@ "additionalProperties": false, "description": "This class is the data model of `OneLineEntry`.", "properties": { - "name": { - "description": "The name of the entry. It will be shown as bold text.", + "label": { + "description": "The label of the OneLineEntry.", "title": "Name", "type": "string" }, "details": { - "description": "The details of the entry. It will be shown as normal text.", + "description": "The details of the OneLineEntry.", "title": "Details", "type": "string" } }, "required": [ - "name", + "label", "details" ], "title": "OneLineEntry", @@ -949,7 +964,7 @@ "description": "This class is the data model of `PublicationEntry`.", "properties": { "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", "type": "string" },