Skip to content

Validation Service

Feature Requests

Description

When projects (internal or external) implement the TextAPI they want to know if they have done it right for a certain version.

Currently we have the possibility to validate with our Python script, but this requires users to download their complete API results and run the validation locally. This solution also does not consider dynamic scenarios like pagination.

For a convenient check if a the TextAPI has been implemented correctly it would be nice to have a small FastAPI application that accepts a URL to an entry point (collection or manifest) and recursively checks if all collections, manifests, and items comply to a certain API version.

Things to consider:

How do we deal with…

  • … different version of the TextAPI?
  • … pagination?
  • … large collections like MINE's?

User Stories

As a developer that implements the TextAPI I need a convenient and easy way to check if the implementation is correct in order to to get a fast overview of possible mistakes.

Classification

Is this feature an enhancement of existing code or a completely new feature?

  • new feature

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

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information