Skip to content

Feature/#85 syriac and arabic/karshuni endpoints



With this MR, the following changes will take place:

  • The TextAPI has been changed according to the project requirements, which state that there should be one viewer for the Syriac and one viewer for the Arabic and Karshuni texts each ("views"). For this, the understanding of the TextAPI's Collection Object in Ahiqar has been altered:

    • textapi/ahikar/3r84g/collection.json has been changed to textapi/ahikar/syriac/collection.json
    • textapi/ahikar/arabic-karshuni/collection.json summarizes the former endpoints textapi/ahikar/3r9ps/collection.json and textapi/ahikar/3r84h/collection.json.
    • ... this applies to all other endpoints as well. The API parameter $collection can now either be syriac or arabic-karshuni.

    Also, test data has been added to model the real data properly.

  • In order to match these two new views, the AnnotationAPI has been adjusted.

    • Both textapi/ahikar/syriac/collection.json and textapi/ahikar/arabic-karshuni/collection.json now have a corresponding Annotation Collection at /annotations/ahiqar/syriac/annotationCollection//annotations/ahiqar/arabic-karshuni/annotationCollection
    • the API parameter $collection can now either be syriac or arabic-karshuni

This way, Ahiqar's TextAPI and AnnotationAPI remain synchronized.

Breaking Change

After this merge, endpoints providing a URI such as 3r9ps as collection will not be available anymore.

The entry points for TIDO have to be altered to

  • textapi/ahikar/syriac/collection.json or
  • textapi/ahikar/arabic-syriac/collection.json

Compliance to “Definition of Done”

  • Unit tests passed
  • Code reviewed
  • Acceptance criteria met
  • Functional tests passed
  • Non-Functional requirements met
  • Product Owner accepts the User Story

Use Cases

Each viewer instance for the Ahiqar website needs a separate entry point. While this is easy for the Syriac text collection, we need to combine one entry point for the Arabic and Karshuni texts that contains all manifests from both collections. Otherwise the treeview won't work properly.


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


Are we able to test this new feature?

  • Yes, everything can be done via unit tests.
  • Yes, you can test by following these steps: …
  • No, it is not possible.


  • I added a statement to the CHANGELOG.

Version number

  • I bumped the version number in

Related Tickets

Closes #85 (closed).

Logs and Screenshots

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

Edited by Mathias Goebel

Merge request reports