Skip to content
MILES Knowledge Base

API Changelog

The MILES API keeps evolving as new features land and old ones are removed. To keep API consumers up-to-date, changes in the schema – as well as changes the schema cannot express – are announced here.

To stay informed, you can subscribe via RSS too. Feed items are tagged with the kinds of changes they contain, so you can filter for releases that matter to you (e.g. only those with deprecations).

Details about this release in the version history

Exercise content is now validated on write. See Schema Validation for details.

  • Changed behavior createExercise and updateExercise now validate definition, answer and explanations against the JSON Schema of the exercise type and reject a mismatch with JSON_INVALID.
  • Changed behavior publishExercises now publishes only exercises whose Exercise.valid is true. The rest are skipped and counted as errors in the result.
  • Added
    Field Exercise.valid
    true if the exercise passed the completeness check and is ready to be published

Details about this release in the version history

  • Changed behavior requestPasswordReset now recognizes single sign-on users and sends them an email pointing to their identity provider instead of a reset token.
  • Changed behavior setNewPassword now fails with INVALID_INPUT when the token belongs to a single sign-on user.
  • Changed behavior addActivityLogs no longer writes learning-phase progress as a side effect of a LEARNING_PHASE entry — setPhaseCompleted has taken over that responsibility.

Details about this release in the version history

Details about this release in the version history

  • Added
    Operation updateFileReferences
    updates file meta data for given files.
  • Added
    Operation getFileReferences
    get metadata on files
  • Added
    Type UpdateFileReferenceInput
  • Added
    Field FileReference.uuid
  • Added
    Field FileReference.aiGenerated
    whether the file was produced by an AI feature
  • Added
    Field Group.hasAiTutor
    does the group have the ai tutor enabled?
  • Added
    Enum value Privilege.EDIT_FILE

This changelog starts with today’s release.