Introduction
These API specifications are automatically generated from each repository’s RAML files, and specify how client modules may access the functionality provided by these modules. See usage notes below.
- view-1: Uses pop-up windows for each method and endpoint.
- view-2: Uses one-page view to everything.
This list of modules is sorted into functional groups.
Login
Handling the login process.
mod-login
Source | ||
---|---|---|
login.raml | view-1 | view-2 |
Documentation for mod-login.
mod-login-saml
Source | ||
---|---|---|
saml-login.raml | view-1 | view-2 |
Documentation for mod-login-saml.
mod-password-validator
Source | ||
---|---|---|
password-validator.raml | view-1 | view-2 |
validator-registry.raml | view-1 | view-2 |
Documentation for mod-password-validator.
mod-permissions
Source | ||
---|---|---|
tenantPermissions.raml | view-1 | view-2 |
permissions.raml | view-1 | view-2 |
Documentation for mod-permissions.
Users
Information about users.
mod-users-bl
Source | ||
---|---|---|
mod-users-bl.raml | view-1 | view-2 |
Documentation for mod-users-bl.
mod-users
Source | ||
---|---|---|
departments.raml | view-1 | view-2 |
groups.raml | view-1 | view-2 |
users.raml | view-1 | view-2 |
addressTypes.raml | view-1 | view-2 |
proxiesFor.raml | view-1 | view-2 |
Documentation for mod-users.
mod-patron
Source | ||
---|---|---|
patron.raml | view-1 | view-2 |
Documentation for mod-patron.
edge-patron
Source | ||
---|---|---|
edge-patron.raml | view-1 | view-2 |
Documentation for edge-patron.
mod-patron-blocks
Source | ||
---|---|---|
automated-patron-blocks.raml | view-1 | view-2 |
eventHandlers.raml | view-1 | view-2 |
patron-block-conditions.raml | view-1 | view-2 |
patron-block-limits.raml | view-1 | view-2 |
user-summary.raml | view-1 | view-2 |
Documentation for mod-patron-blocks.
mod-feesfines
Documentation for mod-feesfines.
Codex
The FOLIO Codex.
mod-codex-mux
Source * | ||
---|---|---|
codex.raml | view-1 | view-2 |
codex-instances-sources.raml | view-1 | view-2 |
codex-packages.raml | view-1 | view-2 |
Documentation for mod-codex-mux.
mod-codex-inventory
Source * | ||
---|---|---|
codex.raml | view-1 | view-2 |
Documentation for mod-codex-inventory.
mod-codex-ekb
Source * | ||
---|---|---|
codex.raml | view-1 | view-2 |
codex-instances-sources.raml | view-1 | view-2 |
codex-packages.raml | view-1 | view-2 |
Documentation for mod-codex-ekb.
Inventory and circulation
Inventory instances, items, and circulation.
mod-circulation
Documentation for mod-circulation.
mod-circulation-storage
Documentation for mod-circulation-storage.
mod-copycat
Source | ||
---|---|---|
copycat.raml | view-1 | view-2 |
Documentation for mod-copycat.
mod-inventory
Documentation for mod-inventory.
mod-inventory-storage
Documentation for mod-inventory-storage.
mod-inventory-update
Source | ||
---|---|---|
inventory-update.raml | view-1 | view-2 |
Documentation for mod-inventory-update.
mod-kb-ebsco-java
Documentation for mod-kb-ebsco-java.
mod-oai-pmh
Source | ||
---|---|---|
cleanup-job.raml | view-1 | view-2 |
folio-set.raml | view-1 | view-2 |
folio-set-filtering-conditions.raml | view-1 | view-2 |
oai-pmh.raml | view-1 | view-2 |
Documentation for mod-oai-pmh.
edge-oai-pmh
Source | ||
---|---|---|
edge-oai-pmh.raml | view-1 | view-2 |
Documentation for edge-oai-pmh.
Resource management
ERM, licenses, usage statistics.
mod-erm-usage
Source | ||
---|---|---|
aggregatorsettings.raml | view-1 | view-2 |
counterreports.raml | view-1 | view-2 |
customreports.raml | view-1 | view-2 |
files.raml | view-1 | view-2 |
usagedataproviders.raml | view-1 | view-2 |
Documentation for mod-erm-usage.
mod-erm-usage-harvester
Source | ||
---|---|---|
harvester.raml | view-1 | view-2 |
periodic.raml | view-1 | view-2 |
start.raml | view-1 | view-2 |
Documentation for mod-erm-usage-harvester.
mod-licenses
Source | ||
---|---|---|
licenses.raml | view-1 | view-2 |
Documentation for mod-licenses.
mod-finc-config
Documentation for mod-finc-config.
Course reserves
Education courses and the items that have been reserved to them.
mod-courses
Source | ||
---|---|---|
courses.raml | view-1 | view-2 |
Documentation for mod-courses.
edge-lti-courses
Source | ||
---|---|---|
edge-lti-courses.raml | view-1 | view-2 |
Documentation for edge-lti-courses.
Finance and orders
Finance, orders, organizations.
mod-finance
Documentation for mod-finance.
mod-finance-storage
Documentation for mod-finance-storage.
mod-invoice
Documentation for mod-invoice.
mod-invoice-storage
Documentation for mod-invoice-storage.
mod-orders
Documentation for mod-orders.
mod-orders-storage
Documentation for mod-orders-storage.
edge-orders
Source | ||
---|---|---|
edge-orders.raml | view-1 | view-2 |
Documentation for edge-orders.
mod-organizations
Source | ||
---|---|---|
organizations.raml | view-1 | view-2 |
Documentation for mod-organizations.
mod-organizations-storage
Documentation for mod-organizations-storage.
mod-gobi
Source | ||
---|---|---|
gobi.raml | view-1 | view-2 |
Documentation for mod-gobi.
Notifications
Assembling and sending notifications.
mod-notify
Source | ||
---|---|---|
notify.raml | view-1 | view-2 |
patron-notice.raml | view-1 | view-2 |
Documentation for mod-notify.
mod-event-config
Source | ||
---|---|---|
event_config.raml | view-1 | view-2 |
Documentation for mod-event-config.
mod-email
Source | ||
---|---|---|
email.raml | view-1 | view-2 |
delayedTasks.raml | view-1 | view-2 |
Documentation for mod-email.
mod-sender
Source | ||
---|---|---|
sender.raml | view-1 | view-2 |
Documentation for mod-sender.
mod-pubsub
Source | ||
---|---|---|
pubSub.raml | view-1 | view-2 |
Documentation for mod-pubsub.
Data import and export
Importing and loading and exporting various data.
mod-data-import
Source | ||
---|---|---|
dataImport.raml | view-1 | view-2 |
Documentation for mod-data-import.
mod-data-import-converter-storage
Source | ||
---|---|---|
data-import-converter-storage.raml | view-1 | view-2 |
field-protection-settings.raml | view-1 | view-2 |
form-configs-storage.raml | view-1 | view-2 |
Documentation for mod-data-import-converter-storage.
mod-data-export
Documentation for mod-data-export.
mod-source-record-manager
Source | ||
---|---|---|
change-manager.raml | view-1 | view-2 |
change-manager-handlers.raml | view-1 | view-2 |
mapping-rules-provider.raml | view-1 | view-2 |
metadata-provider.raml | view-1 | view-2 |
Documentation for mod-source-record-manager.
mod-source-record-storage
Documentation for mod-source-record-storage.
mod-user-import
Source | ||
---|---|---|
import.raml | view-1 | view-2 |
Documentation for mod-user-import.
Utilities and tools
Notes, tags, calendar, etc.
mod-notes
Source | ||
---|---|---|
link.raml | view-1 | view-2 |
note.raml | view-1 | view-2 |
types.raml | view-1 | view-2 |
Documentation for mod-notes.
mod-tags
Source | ||
---|---|---|
tags.raml | view-1 | view-2 |
Documentation for mod-tags.
mod-calendar
Source | ||
---|---|---|
calendar.raml | view-1 | view-2 |
Documentation for mod-calendar.
mod-template-engine
Source | ||
---|---|---|
template-engine.raml | view-1 | view-2 |
Documentation for mod-template-engine.
mod-quick-marc
Source | ||
---|---|---|
records-editor.raml | view-1 | view-2 |
Documentation for mod-quick-marc.
Infrastructure
Gateway, raml-util, RMB, monitoring, etc.
okapi
Source | ||
---|---|---|
okapi.raml | view-1 | view-2 |
Documentation for okapi.
raml
This is the shared RAML repository. Each module uses a certain version of this as their "raml-util" directory.
Label | Source * | ||
---|---|---|---|
shared | jsonSchemas.raml | view-1 | view-2 |
shared | ramls.raml | view-1 | view-2 |
shared | tenant.raml | view-1 | view-2 |
shared-codex | codex.raml | view-1 | view-2 |
shared-codex | codex-instances-sources.raml | view-1 | view-2 |
shared-codex | codex-packages.raml | view-1 | view-2 |
tagged-record-example | users.raml | view-1 | view-2 |
Documentation for raml.
raml-module-builder
Source | ||
---|---|---|
admin.raml | view-1 | view-2 |
sample.raml | view-1 | view-2 |
Documentation for raml-module-builder.
mod-configuration
Source | ||
---|---|---|
config.raml | view-1 | view-2 |
Documentation for mod-configuration.
mod-audit
Source | ||
---|---|---|
audit-data.raml | view-1 | view-2 |
mod-audit-handlers.raml | view-1 | view-2 |
circulation-logs.raml | view-1 | view-2 |
Documentation for mod-audit.
mod-rtac
Source | ||
---|---|---|
rtac.raml | view-1 | view-2 |
rtac-batch.raml | view-1 | view-2 |
Documentation for mod-rtac.
edge-rtac
Source | ||
---|---|---|
edge-rtac.raml | view-1 | view-2 |
Documentation for edge-rtac.
Other
Not yet grouped.
folio-custom-fields
Source | ||
---|---|---|
custom-fields.raml | view-1 | view-2 |
Documentation for folio-custom-fields.
Deprecated
Some old ones that have been renamed.
mod-vendors
Documentation for mod-vendors.
Uploaded
This is a temporary list of modules that are recently using the new method to upload additional API documentation that is build-generated (see FOLIO-3008 and Jenkinsfile configuration). Note: This display is not yet automated, so please notify via FOLIO-3028 whenever new modules publish such documentation.
mod-search
Source | |||
---|---|---|---|
mod-search.yaml | view-3 |
Further information
Configuration
See explanation for how to configure the generation of API documentation of each back-end module.
Usage notes
-
The documents are generated by CI for each repository during the “merge to master” phase. So the documentation relates only to the current master branch.
-
Since August 2018 the generated documents are saved for each software version. So for mod-inventory-storage amend the URL of the generated documents to add the version number (major.minor), e.g.
mod-inventory-storage/12.5/...
-
For repositories that are still using RAML-0.8 version, the “view-2” presentation is empty because the software that is used to generate that view only supports RAML-1.0 version.
-
NOTE: 2018-11-20: The “view-2” using the “plain” theme is available after each module’s next merge to master.
-
The asterisk
*
denotes that this is a shared set of RAML files. The generated documents are for this module’s current raml-util, but the link to the source RAML file is to the head of the default branch of the shared “raml” repository. -
Each section of this page can be directly linked to (e.g. #mod-notes). Similarly each row of a module’s RAMLs (e.g. #mod-notes-types).
-
See assistance for How to determine which module handles which interface and endpoint.