Skip to content

Commit 55b1cd9

Browse files
dt-iohkminikin
andauthored
fix(docs): Update proposal schema (#2321)
* fix: update proposal schema * fix: x-guidance for dependencies section --------- Co-authored-by: Oleksandr Prokhorenko <[email protected]>
1 parent ff1b822 commit 55b1cd9

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

docs/src/architecture/08_concepts/document_templates/proposal/F14-Generic/0ce8ab38-9258-4fbc-a62e-7faa6e58318f.schema.json

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
"description": "Schema for the F14 Catalyst Proposal Submission Form",
66
"maintainers": [{ "name": "Catalyst Team", "url": "https://projectcatalyst.io/" }],
77
"x-changelog": {
8+
"2025-04-22": [
9+
"Updated schema to make optional text fields mandatory.",
10+
"Assigned title to theme property.",
11+
"Fixed x-guidance for dependencies section."
12+
],
813
"2025-01-14": [
914
"Updated schema to include new fields for proposal details.",
1015
"Fixed validation issues with the URL pattern.",
@@ -71,7 +76,6 @@
7176
"contentMediaType": "text/plain",
7277
"pattern": "^[\\S\\s]*$",
7378
"x-note": "Enter multiple lines of plain text. You can use line breaks but no special formatting."
74-
7579
},
7680
"multiLineTextEntryMarkdown": {
7781
"$comment": "UI - Multiline text entry with Markdown content.",
@@ -458,19 +462,19 @@
458462
"$ref": "#/definitions/section",
459463
"title": "Project Dependencies",
460464
"description": "External dependencies and requirements for project success",
461-
"x-guidance": "If your project has any dependencies and prerequisites for your project's success, list them here. These are usually external factors (such as third-party suppliers, external resources, third-party software, etc.) that may cause a delay, since a project has less control over them. In case of third party software, indicate whether you have the necessary licenses and permission to use such software.",
462465
"properties": {
463466
"hasDependency": {
464467
"$ref": "#/definitions/yesNoChoice",
465468
"title": "Does the project have any dependency",
466469
"description": "Does your project have any dependencies on other organizations, technical or otherwise?",
467-
"x-guidance": "If YES, please describe what the dependency is and why you believe it is essential for your project's delivery. If NO, please write \"No dependencies\"",
470+
"x-guidance": "If your project has any dependencies and prerequisites for your project's success, list them here. These are usually external factors (such as third-party suppliers, external resources, third-party software, etc.) that may cause a delay, since a project has less control over them. In case of third party software, indicate whether you have the necessary licenses and permission to use such software.",
468471
"x-placeholder": "Select if your project has any dependencies"
469472
},
470473
"dependencyDetail": {
471474
"$ref": "#/definitions/singleLineTextEntry",
472475
"title": "Dependency description",
473476
"description": "Here you should list any dependencies and prerequisites for your project's success. These are usually external factors (such as third-party suppliers, external resources, third-party software, etc.) that may cause a delay, since a project has less control over them. In case of third party software, indicate whether you have the necessary licenses and permission to use such software.",
477+
"x-guidance": "If YES, please describe what the dependency is and why you believe it is essential for your project's delivery. If NO, please write \"No dependencies\"",
474478
"x-placeholder": "Describe any dependencies or write 'No dependencies'."
475479
}
476480
}
@@ -520,7 +524,6 @@
520524
"x-icon": "top-bar",
521525
"$ref": "#/definitions/segment",
522526
"description": "Determine the eligibility of the proposal for this category",
523-
524527
"properties": {
525528
"category_details": {
526529
"$ref": "#/definitions/section",
@@ -705,7 +708,9 @@
705708
"properties": {
706709
"grouped_tag": {
707710
"$ref": "#/definitions/singleGroupedTagSelector",
708-
"oneOf": [{
711+
"title": "Theme Selection",
712+
"oneOf": [
713+
{
709714
"properties": {
710715
"group": {
711716
"$ref": "#/definitions/tagGroup",
@@ -970,7 +975,8 @@
970975
"description": "Please describe your proposed solution",
971976
"x-placeholder": "Describe your proposed solution and how it addresses the problem"
972977
}
973-
}
978+
},
979+
"required": ["solution"]
974980
},
975981
"impact": {
976982
"$ref": "#/definitions/section",
@@ -984,7 +990,8 @@
984990
"minLength": 1,
985991
"maxLength": 10240
986992
}
987-
}
993+
},
994+
"required": ["impact"]
988995
},
989996
"feasibility": {
990997
"$ref": "#/definitions/section",
@@ -998,10 +1005,12 @@
9981005
"minLength": 1,
9991006
"maxLength": 10240
10001007
}
1001-
}
1008+
},
1009+
"required": ["feasibility"]
10021010
}
10031011
},
1004-
"x-order": ["solution", "impact", "feasibility"]
1012+
"x-order": ["solution", "impact", "feasibility"],
1013+
"required": ["solution", "impact", "feasibility"]
10051014
},
10061015
"milestones": {
10071016
"$ref": "#/definitions/segment",
@@ -1104,7 +1113,8 @@
11041113
"minLength": 1,
11051114
"maxLength": 10240
11061115
}
1107-
}
1116+
},
1117+
"required": ["who"]
11081118
},
11091119
"budget": {
11101120
"$ref": "#/definitions/section",
@@ -1119,7 +1129,8 @@
11191129
"minLength": 1,
11201130
"maxLength": 10240
11211131
}
1122-
}
1132+
},
1133+
"required": ["costs"]
11231134
},
11241135
"value": {
11251136
"$ref": "#/definitions/section",
@@ -1134,10 +1145,12 @@
11341145
"minLength": 1,
11351146
"maxLength": 10240
11361147
}
1137-
}
1148+
},
1149+
"required": ["note"]
11381150
}
11391151
},
1140-
"x-order": ["team", "budget", "value"]
1152+
"x-order": ["team", "budget", "value"],
1153+
"required": ["team", "budget", "value"]
11411154
},
11421155
"agreements": {
11431156
"$ref": "#/definitions/segment",

0 commit comments

Comments
 (0)