CenterForDigitalHumanities / TPEN-services

Services required by TPEN interfaces in order to interact with data
1 stars 0 forks source link

API Functionality Issues Report #126

Closed thehabes closed 1 week ago

thehabes commented 3 months ago

Below are manual tests performed by pulling down the PR, running the TPEN Services API, and using Talend API as a means to use the TPEN Services API from the perspective of an application. Note that only functionality interpreted as incorrect is reported, the code itself was not looked at. Essentially, this is a beta tester's report.

As a general note, I consider these things a barrier to PR approval and they make me unsure of exactly what to review and how to review it, and what things to 'just take care of' as I review it.

auth

/project endpoint

/manifest endpoint

Note that this endpoint is outside the scope of this PR

/page endpoint

/line endpoint

Note that this endpoint is outside the scope of this PR

/my/projects endpoint

/my/profile endpoint

/user endpoint

TESTS

Even with the issues mentioned above, all tests are passing. I am not sure what all is in scope, but it would be nice to have tests that verify the correct response code is used and the correct response body is returned. Otherwise, manual tests are strictly required as part of the review process even before a PR reaches this stage. We should decide what changes to implement and what is core enough for the code that it warrants real tests to rely on as a means to reduce what manual testing is required.