Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rework question data structure #113

Merged
merged 20 commits into from
Nov 25, 2022
Merged

Rework question data structure #113

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
007895b
Update question catalog to new format
Robbendebiene Oct 19, 2022
6dfba79
Update placeholder naming of maxweight question
Robbendebiene Oct 21, 2022
64290f0
Update duration input json structure
Robbendebiene Oct 21, 2022
8902f44
Update question catalog json schema
Robbendebiene Oct 21, 2022
18d9528
Update duration answer json structure
Robbendebiene Oct 25, 2022
ea01e30
Update question catalog classes to new JSON schema
Robbendebiene Oct 25, 2022
9295cb7
Update tests
Robbendebiene Oct 25, 2022
aee7b4a
Add new test for answer constructor/expressions
Robbendebiene Oct 25, 2022
cd48b96
Update question catalog usage across files
Robbendebiene Oct 25, 2022
3a6b18a
Rewrite answer classes to use answer constructor
Robbendebiene Oct 25, 2022
b071de6
Update input widgets
Robbendebiene Oct 25, 2022
253d695
Fix answer validation
Robbendebiene Oct 25, 2022
9410c1f
Add multiple choice list input
Robbendebiene Oct 28, 2022
0d804a4
Minor class adjustments
Robbendebiene Nov 21, 2022
cfd15c4
Fix questionnaire entry removal (#114) & add test
Robbendebiene Nov 21, 2022
d85464f
Merge pull request #115 from OPENER-next/fix_follow-up_questions_removal
Robbendebiene Nov 21, 2022
7c6118e
Fix wrong property name
Robbendebiene Nov 22, 2022
d0dcb9a
Replace json schema validator (#120)
Robbendebiene Nov 25, 2022
14828ca
Merge branch 'master' into rework_question_data_structure
Robbendebiene Nov 25, 2022
e9a446a
Resolve linter errors
Robbendebiene Nov 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,436 changes: 753 additions & 683 deletions assets/datasets/question_catalog.json
View file
Open in desktop

Large diffs are not rendered by default.

330 changes: 260 additions & 70 deletions assets/datasets/question_catalog_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,99 +1,289 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Question Catalog",
"description": "A list of questions.",
"description": "A list of questions to choose from.",
"type": "array",
"items": {
"type": "object",
"description": "A question derived from the DELFI catalog.",
"description": "A question entry is defined of three main parts:\n- A basic question phrase later displayed to the user\n- An input type, which defines the UI element in the frontend as well as the written OSM tags\n-A set of conditions that define under which circumstances the question should be asked",
"required": [ "question", "answer", "conditions" ],
"additionalProperties": false,
"properties": {
"id": {
"description": "The DELFI id this question is derived from.",
"type": "integer",
"exclusiveMinimum": 0
},
"name": {
"description": "A short title providing additional context to this question.",
"type": "string"
},
"description": {
"description": "Details or further information describing this question.",
"type": "string"
},
"image": {
"description": "A list of image urls that may help to clarify this question.",
"type": "array",
"items": {
"type": "string",
"format": "uri-reference"
},
"minItems": 1
},

"question": {
"description": "The actual question. It should be kept as short as possible while still being comprehensible and independent of the context in which it is asked.",
"type": "string"
"type": "object",
"description": "This holds any to the question related information including the question itself.",
"required": [ "name", "text" ],
"additionalProperties": false,
"properties": {
"id": {
"description": "The DELFI id this question is derived from.",
"type": "integer",
"exclusiveMinimum": 0
},
"name": {
"description": "A short term describing the content of the answer.",
"type": "string"
},
"text": {
"description": "The actual question. It should be kept as short as possible while still being comprehensible and independent of the context in which it is asked.",
"type": "string"
},
"description": {
"description": "Details or further information describing this question.",
"type": "string"
},
"image": {
"description": "A list of image urls that may help to clarify this question.",
"type": "array",
"items": {
"type": "string",
"format": "uri-reference"
},
"minItems": 1
}
}
},
"input": {

"answer": {
"type": "object",
"description": "This holds properties specifying the UI input element and its constraints.",
"description": "Holds properties to specify the UI input element and its constraints by which the question can be answered.",
"required": [ "type", "input" ],
"additionalProperties": false,
"properties": {
"type": {
"description": "The value type of the answer. This is closely related to the widget that will be displayed to the end user.",
"enum": ["Bool", "Number", "String", "List", "Duration", "OpeningHours"]
"description": "Defines the UI input element used to answer the question.",
"enum": ["String", "Number", "Duration", "Bool", "List", "MultiList"]
},
"values": {
"description": "A map of values with additional information for the user and the corresponding OSM tags.",
"input": {
"type": ["array", "object"],
"description": "Holds any properties to configure the UI input element and its constraints. The contents of this property **vary in its structure and properties** depending on the input `type`.",
"items": {
"type": "object"
},
"minItems": 2
},
"constructor": {
"type": "object",
"description": "The constructor ultimately creates the OSM tags to be written based on the given input value(s). Input types without predefined values like `String`, `Number` and `Duration` require a constructor, while all other types with predefined values have a default constructor that coalesces the selected values.\n The OSM tags to be written are defined by a key of type String and an expression that evaluates to a String. Expressions are defined by an array [] containing the expression identifier as the first element followed by a number of Strings as arguments. The input values can be accessed using the `$input` variable. If the expression starts with the `$input` variable the coalesce expression is assumed.",
"minProperties": 1,
"additionalProperties": {
"type": "object",
"properties": {
"osm_tags": {
"type": "object",
"additionalProperties": {
"type": "string"
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
}
},
"anyOf": [
{
"type": "object",
"description": "Describes a text input field that allows any character.",
"required": [ "constructor"],
"properties": {
"type": {
"const": "String"
},
"input": {
"type": "object",
"additionalProperties": false,
"properties": {
"placeholder": {
"type": "string",
"description": "An optional placeholder for the input field."
},
"min": {
"type": "integer",
"description": "Restricts the minimum number of characters allowed by this input field.",
"minimum": 0,
"maximum": 255,
"default": 0
},
"max": {
"type": "integer",
"description": "Restricts the maximum number of characters allowed by this input field.",
"minimum": 0,
"maximum": 255,
"default": 255
}
}
}
}
},

{
"type": "object",
"description": "Describes a number input field that allows numbers only.",
"required": [ "constructor"],
"properties": {
"type": {
"const": "Number"
},
"input": {
"type": "object",
"additionalProperties": false,
"properties": {
"placeholder": {
"type": "string",
"description": "An optional placeholder for the input field."
},
"unit": {
"type": "string",
"description": "The unit of the input value that will be displayed at the end of the input field."
},
"min": {
"type": "integer",
"description": "Limits the input value to a minimum value."
},
"max": {
"type": "integer",
"description": "Limits the input value to a maximum value."
},
"decimals": {
"type": "integer",
"description": "Restricts the number of allowed decimals by this input field.",
"minimum": 0
}
}
}
}
},

{
"type": "object",
"description": "Describes a time input field that allows entering a duration in different time units.",
"required": [ "constructor"],
"properties": {
"type": {
"const": "Duration"
},
"input": {
"type": "object",
"required": [ "unit_steps"],
Robbendebiene marked this conversation as resolved.
Show resolved Hide resolved
"additionalProperties": false,
"properties": {
"max": {
"type": "integer",
"description": "The maximum allowed value for the biggest unit.",
"minimum": 1
},
"unit_step": {
"type": "object",
"description": "Whether the input in the given time unit should be possible and its corresponding step size.",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"days": {
"type": "integer",
"description": "The time segment size of the days input.",
"minimum": 1
},
"hours": {
"type": "integer",
"description": "The time segment size of the hours input.",
"minimum": 1
},
"minutes": {
"type": "integer",
"description": "The time segment size of the minutes input.",
"minimum": 1
},
"seconds": {
"type": "integer",
"description": "The time segment size of the seconds input.",
"minimum": 1
}
}
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"image": {
"type": "string",
"format": "uri-reference"
},
"unit": {
"description": "An optional unit that will be displayed to the user.",
"type": "string"
},
"min": {
"type": "integer"
},
"max": {
"type": "integer"
},
"decimals": {
"description": "An optional property to specify how many decimals are allowed for type Number.",
"type": "integer",
"minimum": 0
}
}
}
},

{
"type": "object",
"description": "Describes an input with exactly two possible answers that allows the selection of one answer.",
"properties": {
"type": {
"const": "Bool"
},
"input": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "object",
"properties": {
"osm_tags": {
"type": "object",
"description": "All OSM tags that should apply when this entry is selected.",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "A short term describing this answer. If omitted the first entry will fallback to \"Yes\" and the second to \"No\"."
}
},
"additionalProperties": false,
"required": [ "osm_tags" ]
}
}
}
},

{
"type": "object",
"description": "Describes an input with multiple possible answers. List allows the selection of exactly one answer, while MultiList allows the selection of multiple answers.",
"properties": {
"type": {
"enum": [ "List", "MultiList" ]
},
"additionalProperties": false
"input": {
"type": "array",
"minItems": 2,
"items": {
"type": "object",
"properties": {
"osm_tags": {
"type": "object",
"description": "All OSM tags that should apply when this entry is selected.",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string",
"description": "A short term describing this answer."
},
"description": {
"type": "string",
"description": "Additional details and hints clarifying this answer."
},
"image": {
"type": "string",
"description": "A single image describing this answer.",
"format": "uri-reference"
}
},
"additionalProperties": false,
"required": [ "osm_tags", "name" ]
}
}
}
}
},
"additionalProperties": false,
"required": [ "type", "values" ]
]
},

"conditions": { "$ref": "/assets/datasets/osm_condition_schema.json" },

"isProfessional": {
"description": "Certain questions seek for information that requires authorization or might be dangerous to collect. If omitted this will fallback to false.",
"type": "boolean",
"default": false
}
},
"additionalProperties": false,
"required": [ "id", "name", "question", "input" ]
}
}
}
Loading