Skip to content

Latest commit

 

History

History
609 lines (452 loc) · 11 KB

api.md

File metadata and controls

609 lines (452 loc) · 11 KB

Skilllevel Service API

Table of Contents

Query

Field Argument Type Description
_internal_noauth_userSkillLevelsByChapterIds [SkillLevels!]!

Get the skill levels of the current user for all skill types for a list of chapter ids. ⚠️ This query is only accessible internally in the system and allows the caller to fetch contents without any permissions check and should not be called without any validation of the caller's permissions. ⚠️

chapterIds [UUID!]!
_internal_noauth_skillLevelsForUserByChapterIds [SkillLevels!]!

Get the skill levels of the specified user for all skill types for a list of chapter ids. ⚠️ This query is only accessible internally in the system and allows the caller to fetch contents without any permissions check and should not be called without any validation of the caller's permissions. ⚠️

chapterIds [UUID!]!
userId UUID!

Mutation

Field Argument Type Description
recalculateLevels ⚠️ SkillLevels!

ONLY FOR TESTING PURPOSES. DO NOT USE IN FRONTEND. WILL BE REMOVED.

Triggers the recalculation of the skill level of the user. This is done automatically at some time in the night.

The purpose of this mutation is to allow testing of the skill level score and demonstrate the functionality. 🔒 The user must be a super-user, otherwise an exception is thrown.

⚠️ DEPRECATED

Only for testing purposes. Will be removed.

chapterId UUID!
userId UUID!

Objects

PaginationInfo

Return type for information about paginated results.

Field Argument Type Description
page Int!

The current page number.

size Int!

The number of elements per page.

totalElements Int!

The total number of elements across all pages.

totalPages Int!

The total number of pages.

hasNext Boolean!

Whether there is a next page.

SkillLevel

The skill level of a user.

Field Argument Type Description
value Float!

The value of the skill level. levels are between 0 and 100.

log [SkillLevelLogItem!]!

A log of the changes to the skill level

SkillLevelLogItem

An item in the skill level change log.

Field Argument Type Description
date DateTime!

The date when the skill level changed.

difference Float!

The difference between the previous and the new skill level.

oldValue Float!

The old skill level.

newValue Float!

The new skill level.

associatedContentIds [UUID!]!

The ids of the contents that are associated with the change.

SkillLevels

The four skill level of a user.

Field Argument Type Description
remember SkillLevel!

remember represents how much user remember the concept

understand SkillLevel!

understand represents how well the user understands learned content.

apply SkillLevel!

apply represents the how well user applies the learned concept during assessment.

analyze SkillLevel!

apply is how much user can evaluate information and draw conclusions

Inputs

DateTimeFilter

Filter for date values. If multiple filters are specified, they are combined with AND.

Field Type Description
after DateTime

If specified, filters for dates after the specified value.

before DateTime

If specified, filters for dates before the specified value.

IntFilter

Filter for integer values. If multiple filters are specified, they are combined with AND.

Field Type Description
equals Int

An integer value to match exactly.

greaterThan Int

If specified, filters for values greater than to the specified value.

lessThan Int

If specified, filters for values less than to the specified value.

Pagination

Specifies the page size and page number for paginated results.

Field Type Description
page Int!

The page number, starting at 0. If not specified, the default value is 0. For values greater than 0, the page size must be specified. If this value is larger than the number of pages, an empty page is returned.

size Int!

The number of elements per page.

StringFilter

Filter for string values. If multiple filters are specified, they are combined with AND.

Field Type Description
equals String

A string value to match exactly.

contains String

A string value that must be contained in the field that is being filtered.

ignoreCase Boolean!

If true, the filter is case-insensitive.

Enums

SortDirection

Specifies the sort direction, either ascending or descending.

Value Description
ASC
DESC

Scalars

Boolean

Built-in Boolean

Date

An RFC-3339 compliant Full Date Scalar

DateTime

A slightly refined version of RFC-3339 compliant DateTime Scalar

Float

Built-in Float

Int

Built-in Int

LocalTime

24-hour clock time value string in the format hh:mm:ss or hh:mm:ss.sss.

String

Built-in String

Time

An RFC-3339 compliant Full Time Scalar

UUID

A universally unique identifier compliant UUID Scalar

Url

A Url scalar