Skip to content

Feature/#31 plain text export

Michelle Weidling requested to merge feature/#31-plain-text-export into develop

Feature

Summary

This MR provides a new API endpoint for plain texts. In favour of this approach, the former subset functions have been removed.

Use Cases

This enables users to get single plain text documents for Ahikar resources that they can employ e.g. for text analysis.

Documentation

Shall we add your feature to the documentation?

  • I've already did it!
  • At least I added a headline to the documentation.

Function Documentation

  • Of course I provided all my functions with an appropriate documentation.

Are there parts of the documentation we have to adjust

  • No.
  • Yes, but I'd like someone else to do it.
  • Yes, and I already did!

Tests

Are we able to test this new feature?

  • Yes, everything can be done via unit tests.
  • Yes, you can test by following these steps:
    • curl https://ahikar-test.sub.uni-goettingen.de/api/textapi/ahikar/3r84h/3r176.txt
    • curl https://ahikar-test.sub.uni-goettingen.de/api/textapi/ahikar/3r84h/3r176.txt?type=transliteration
  • No, it is not possible.

Changelog

  • I added a statement to the CHANGELOG.

Version number

  • I bumped the version number in build.properties.

Related Tickets

Closes

#31 (closed)

Logs and Screenshots

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

Edited by Michelle Weidling

Merge request reports