-
Notifications
You must be signed in to change notification settings - Fork 0
Description
This issue proposes the creation of a new API endpoint for the FOLIO platform that can ingest circulation policies from an HTML or PDF document and translate them into machine-readable FOLIO circulation rules.
Justification:
Currently, configuring circulation rules in FOLIO requires manual translation from human-readable policy documents to a structured machine-readable format. This process can be time-consuming and error-prone, especially for libraries with complex circulation policies. An API endpoint that automates this translation would significantly improve efficiency and accuracy.
Implementation Details:
- The API endpoint should accept a link to an HTML or PDF document containing circulation policies.
- The endpoint should utilize a parsing library or tool to extract relevant policy information from the document.
- The extracted information should be mapped to the FOLIO circulation rule schema as documented here: https://raw.githubusercontent.com/folio-org/mod-circulation/refs/heads/master/doc/circulationrules.md
- The API should return the translated circulation rules in a machine-readable format (e.g., JSON, YAML).
Additional Considerations:
- The API should handle different document structures and layouts commonly used for circulation policies.
- Error handling should be implemented to gracefully handle cases where the parsing fails or the document does not contain valid circulation policy information.
The API may require configuration options to allow libraries to customize the parsing process for specific document formats.
Benefits:
This API endpoint will streamline the process of configuring circulation rules in FOLIO.
- It will reduce the time and effort required for library staff to translate policies.
- It will minimize errors associated with manual data entry.
- It will improve the consistency and accuracy of circulation rule configuration.
Next Steps:
- Discuss the feasibility and technical requirements for this API endpoint.
- Research existing libraries or tools for parsing HTML and PDF documents.
- Define the API specification including request parameters, response format, and error handling.