Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

All API endpoints are documented in RAML or OpenAPI

Description

Description;
All API endpoints are documented in RAML or OpenAPI

Status as of: week 38:2021

  1. The "/ldp/db/log" endpoint is not contained in the RAML

  2. In the readme the log functionality is described as “undocumented and incomplete.”

Documentation:
MOD-LDP Acceptance Analysis - https://docs.google.com/document/d/1oSXnV-2mjAtnI_UH709eES8sjxHsVKEu1oLMP6tnIV4/edit#
Analysis performed by Jeremy Huff (huff@library.tamu.edu), Kevin Day (kday@library.tamu.edu), and Jason Root (jroot@tamu.edu)

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

Mike Taylor January 19, 2022 at 9:01 PM

I created RAML and JSON Schemas for the web service as it existed when I took it over as the Emergency Maintainer (after Nassib original minion left the project). Since then, I believe has added new WSAPIs, and those will need to be added to the RAML and JSON Schemas.

(I note in passing that plenty of other modules don't do this right; but that's no reason why we shouldn't do the right thing.)

Charlotte Whitt January 19, 2022 at 6:51 PM

- did you guys talk about this ticket last week, and is there more work to do here, or can I go ahead and close the ticket?

CC: and
Spreadsheet: https://docs.google.com/spreadsheets/d/1WfdDZ41CraZSUVrtUpNbOVdJ4Qwc661ZwB4L2pwvQbo/edit#gid=0

Done

Details

Assignee

Reporter

Priority

Development Team

Thor

Fix versions

Release

Lotus R1 2022

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created September 28, 2021 at 2:28 PM
Updated February 1, 2022 at 12:35 PM
Resolved February 1, 2022 at 12:35 PM
Configure
TestRail: Cases
TestRail: Runs

Flag notifications