Unified-Learner-Passbook / Credential-MS

MIT License
1 stars 4 forks source link

API Endpoint Review and Cleanup for /credentials #18

Closed KDwevedi closed 1 year ago

KDwevedi commented 1 year ago

Description

Cleaning up and review of the APIs at the /credentials path is required wrt the Sunbird RC Swagger docs along with an evaluation of APIs that are completely or partially unimplemented.

APIs

  1. Obtain Credentials by Subject or Issuer Currently implemented here. The request body implemented differs from request body expected according to RC Swagger Docs, as such the DTO may be needed to be updated.

  2. Obtain Credential by ID This API (implemented here) is currently bugged and returns only an empty array. The RC docs again stipulate additional header parameters here which are not being handled currently.

  3. Issue a Credential The request body currently takes in the entire credential schema when RC docs expect only a string.

  4. Update Credential Status This API endpoint is currently not implemented.

  5. Derive a Credential This API endpoint to derive a credential is currently not implemented.

  6. Render a Credential This API is currently bugged (returns 500 on first call, but rendered PDF on the second). The current implementation also has other issues for which I'll create a dedicated issue soon.

Tasks

techsavvyash commented 1 year ago

All of these have been addressed and closed