Commit 50c7c3f9 authored by Martin Juhás's avatar Martin Juhás
Browse files

feat: add content to questionnaires and category to tools 

### Additions

* added field `content: Content!` to `QuestionnaireType` type
* added field `category: String!` to `ToolType` type
* added field `category: String!` to `ExtendedToolType` type

### Deletions

* removed field `description` from `QuestionnaireType` type

Closes #361
parent 40fe7100

definitions/CHANGELOG.md

+15 −0
Original line number Diff line number Diff line 
## 0.17.0



Add support for markdown in questionnaires. inject/backend#361

Add missing field from tools. inject/backend#297



### questionnaires.yml



- remove field `description` from questionnaire

- add field `content` to questionnaire



### tools.yml



- add field `category` to tool





## 0.16.0



More definition enhancements. inject/backend#357

definitions/README.md

+2 −1
Original line number Diff line number Diff line
@@ -219,6 +219,7 @@ which based on its input and current state of the exercise returns some output. 
Each tool has the following fields:



- **name**: _string, unique_ - Name of the tool

- **category**: _string, default=""_ - category of the tool, used to group multiple tools together visually

- **tooltip_description**: _string, default=""_ - Description of a tool displayed to trainees.

- **hint**: _string, default=""_ - Argument hint

- **default_response**: _string_ - Response that the tool returns if no other response gets matched.
@@ -296,7 +297,7 @@ This file contains all questionnaires. 
Each questionnaire has the following fields:



- **title**: _string_ - title of the questionnaire

- **description**: _string, default=""_ - description of the questionnaire

- **content**: _content, default=empty_ - description of the questionnaire

- **time**: _int, default=0_ - time since the beginning of the exercise in minutes,

  after which the questionnaire will be sent

- **control**: _[control](#control), default=empty_

definitions/base_definition/config.yml

+1 −1
Original line number Diff line number Diff line 
exercise_duration: 60

show_exercise_time: False

version: 0.16.0

version: 0.17.0

description: Some description about this definition.

target_audience: Some description of target audience

prerequisites:

definitions/base_definition/questionnaires.yml

+7 −5
Original line number Diff line number Diff line 
- title: Intro questionnaire

  description: Some short description.

  content: { content: Some short description. }

  control:

    activate_milestone: questionnaire_answered

  questions:
@@ -18,7 +18,9 @@ 
      multiline: True



- title: Conditional questionnaire

  description: |

  content:

    content: |

      ## Description

      Some long description.Some long description.Some long description.Some long description.Some long description.

      Some long description.Some long description.Some long description.Some long description.Some long description.

      Some long description.Some long description.Some long description.Some long description.Some long description.

definitions/base_definition/tools/more-tools.yml

+1 −0
Original line number Diff line number Diff line 
- name: browser

  category: Web

  tooltip_description: Get content of a website.

  default_response: Website unreachable.

  responses: