Skip to content

feat: remove `total` and `startIndex`

Feature

Summary

This MR removes the fields total and startIndex from the AnnotationAPI. The reasons for this decision are:

  • Both keys are not mandatory according to the W3C Data Annotation Model
  • They aren't used in any of our application
  • Depending on the size of the collection they are quite costly to compute

Although we now this might result in some drawbacks when using the annotations in another application outside the SUB (there is no use case for this scenario yet), we decided to opt for a better performance.

Compliance to “Definition of Done”

  • Unit tests passed
  • Code reviewed
  • Product Owner accepts the User Story

Documentation

  • I updated the README (if applicable)
  • I provided my functions with appropriate documentation
  • I updated existing documentation

Tests

Are we able to test this new feature?

  • Yes, everything can be done via unit tests.

Changelog

  • I added a statement to the CHANGELOG.

Version number

  • I bumped the version number in build.properties.

Closes

Closes #172 (closed).

/cc Mathias Göbel, Frank Schneider, Michelle Weidling

Merge request reports