From 565d9dc0f06e9165dad3b3cb50737a75df4da446 Mon Sep 17 00:00:00 2001 From: sinaatalay Date: Tue, 16 Jul 2024 11:19:14 +0000 Subject: [PATCH] docs: update schema.json --- schema.json | 118 +++++++++++++++++++++++++++++++++------------------- 1 file changed, 75 insertions(+), 43 deletions(-) diff --git a/schema.json b/schema.json index 599468e2..b2ef7257 100644 --- a/schema.json +++ b/schema.json @@ -89,7 +89,7 @@ }, "page_numbering_style": { "default": "NAME - Page PAGE_NUMBER of TOTAL_PAGES", - "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", + "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\n- TODAY: Today's month and year (April 2024)\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", "title": "Page Numbering Style", "type": "string" }, @@ -173,8 +173,10 @@ "title": "Margins" }, "show_timespan_in": { - "default": [], - "description": "The time span will be shown in the date and location column in these sections. The input should be a list of section titles as strings (case-sensitive). The default value is an empty list, which means the time span will not be shown in any section.", + "default": [ + "Experience" + ], + "description": "The time span will be shown in the date and location column in these sections. The input should be a list of section titles as strings (case-sensitive). The default value is ['Experience'].", "items": { "type": "string" }, @@ -190,7 +192,7 @@ }, "CurriculumVitae": { "additionalProperties": false, - "description": "This class is the data model of the CV.", + "description": "This class is the data model of the `cv` field.", "properties": { "name": { "default": null, @@ -316,7 +318,7 @@ }, "EducationEntry": { "additionalProperties": false, - "description": "This class is the data model of `EducationEntry`.", + "description": "This class is the data model of `EducationEntry`. `EducationEntry` class is\ncreated by combining the `EntryBase` and `EducationEntryBase` classes to have the\nfields in the correct order.", "properties": { "institution": { "description": "The institution name.", @@ -354,10 +356,10 @@ "title": "Date", "oneOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" } ] }, @@ -514,7 +516,7 @@ }, "page_numbering_style": { "default": "NAME - Page PAGE_NUMBER of TOTAL_PAGES", - "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", + "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\n- TODAY: Today's month and year (April 2024)\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", "title": "Page Numbering Style", "type": "string" }, @@ -604,6 +606,7 @@ "type": "object" }, "EntryAreaMargins": { + "additionalProperties": false, "description": "This class is a data model for the entry area margins.", "properties": { "left_and_right": { @@ -629,10 +632,10 @@ } }, "title": "EntryAreaMargins", - "type": "object", - "additionalProperties": false + "type": "object" }, "EntryAreaMarginsForClassic": { + "additionalProperties": false, "description": "This class is a data model for the entry area margins.", "properties": { "left_and_right": { @@ -665,10 +668,10 @@ } }, "title": "EntryAreaMarginsForClassic", - "type": "object", - "additionalProperties": false + "type": "object" }, "EntryAreaMarginsForEngineeringresumes": { + "additionalProperties": false, "description": "This class is a data model for the entry area margins.", "properties": { "left_and_right": { @@ -694,12 +697,11 @@ } }, "title": "EntryAreaMarginsForEngineeringresumes", - "type": "object", - "additionalProperties": false + "type": "object" }, "ExperienceEntry": { "additionalProperties": false, - "description": "This class is the data model of `ExperienceEntry`.", + "description": "This class is the data model of `ExperienceEntry`. `ExperienceEntry` class is\ncreated by combining the `EntryBase` and `ExperienceEntryBase` classes to have the\nfields in the correct order.", "properties": { "company": { "description": "The company name.", @@ -721,10 +723,10 @@ "title": "Date", "oneOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" } ] }, @@ -809,6 +811,7 @@ "type": "object" }, "HeaderMargins": { + "additionalProperties": false, "description": "This class is a data model for the header margins.", "properties": { "vertical_between_name_and_connections": { @@ -834,10 +837,10 @@ } }, "title": "HeaderMargins", - "type": "object", - "additionalProperties": false + "type": "object" }, "HeaderMarginsForEngineeringresumes": { + "additionalProperties": false, "description": "This class is a data model for the header margins.", "properties": { "vertical_between_name_and_connections": { @@ -863,10 +866,10 @@ } }, "title": "HeaderMarginsForEngineeringresumes", - "type": "object", - "additionalProperties": false + "type": "object" }, "HighlightsAreaMargins": { + "additionalProperties": false, "description": "This class is a data model for the highlights area margins.", "properties": { "top": { @@ -892,10 +895,10 @@ } }, "title": "HighlightsAreaMargins", - "type": "object", - "additionalProperties": false + "type": "object" }, "HighlightsAreaMarginsForEngineeringresumes": { + "additionalProperties": false, "description": "This class is a data model for the highlights area margins.", "properties": { "top": { @@ -921,8 +924,7 @@ } }, "title": "HighlightsAreaMarginsForEngineeringresumes", - "type": "object", - "additionalProperties": false + "type": "object" }, "LocaleCatalog": { "additionalProperties": false, @@ -1015,12 +1017,41 @@ "type": "array" } ] + }, + "full_names_of_months": { + "default": [ + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "description": "Full names of the months in the locale.", + "title": "Full Names of Months", + "oneOf": [ + { + "items": { + "type": "string" + }, + "maxItems": 12, + "minItems": 12, + "type": "array" + } + ] } }, "title": "LocaleCatalog", "type": "object" }, "Margins": { + "additionalProperties": false, "description": "This class is a data model for the margins.", "properties": { "page": { @@ -1095,10 +1126,10 @@ } }, "title": "Margins", - "type": "object", - "additionalProperties": false + "type": "object" }, "MarginsForClassic": { + "additionalProperties": false, "description": "This class is a data model for the margins.", "properties": { "page": { @@ -1174,10 +1205,10 @@ } }, "title": "MarginsForClassic", - "type": "object", - "additionalProperties": false + "type": "object" }, "MarginsForEngineeringresumes": { + "additionalProperties": false, "description": "This class is a data model for the margins.", "properties": { "page": { @@ -1252,8 +1283,7 @@ } }, "title": "MarginsForEngineeringresumes", - "type": "object", - "additionalProperties": false + "type": "object" }, "ModerncvThemeOptions": { "additionalProperties": false, @@ -1404,7 +1434,7 @@ }, "NormalEntry": { "additionalProperties": false, - "description": "This class is the data model of `NormalEntry`.", + "description": "This class is the data model of `NormalEntry`. `NormalEntry` class is created by\ncombining the `EntryBase` and `NormalEntryBase` classes to have the fields in the\ncorrect order.", "properties": { "name": { "description": "The name of the NormalEntry.", @@ -1421,10 +1451,10 @@ "title": "Date", "oneOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" } ] }, @@ -1530,6 +1560,7 @@ "type": "object" }, "PageMargins": { + "additionalProperties": false, "description": "This class is a data model for the page margins.", "properties": { "top": { @@ -1562,12 +1593,11 @@ } }, "title": "PageMargins", - "type": "object", - "additionalProperties": false + "type": "object" }, "PublicationEntry": { "additionalProperties": false, - "description": "This class is the data model of `PublicationEntry`.", + "description": "This class is the data model of `PublicationEntry`. `PublicationEntry` class is\ncreated by combining the `EntryWithDate` and `PublicationEntryBase` classes to have\nthe fields in the correct order.", "properties": { "title": { "description": "The title of the publication.", @@ -1628,10 +1658,10 @@ "title": "Date", "oneOf": [ { - "type": "integer" + "type": "string" }, { - "type": "string" + "type": "integer" } ] } @@ -1716,7 +1746,7 @@ }, "page_numbering_style": { "default": "NAME - Page PAGE_NUMBER of TOTAL_PAGES", - "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", + "description": "The style of the page numbering. The following placeholders can be used:\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number\n- TOTAL_PAGES: The total number of pages\n- TODAY: Today's month and year (April 2024)\nThe default value is NAME - Page PAGE_NUMBER of TOTAL_PAGES.", "title": "Page Numbering Style", "type": "string" }, @@ -1806,6 +1836,7 @@ "type": "object" }, "SectionTitleMargins": { + "additionalProperties": false, "description": "This class is a data model for the section title margins.", "properties": { "top": { @@ -1824,8 +1855,7 @@ } }, "title": "SectionTitleMargins", - "type": "object", - "additionalProperties": false + "type": "object" }, "SocialNetwork": { "additionalProperties": false, @@ -1918,7 +1948,9 @@ "top": "0.3 cm" } }, - "show_timespan_in": [] + "show_timespan_in": [ + "Experience" + ] }, "description": "The design information of the CV. The default is the classic theme.", "discriminator": {