Introduction
This API documentaton is automatically generated from each repository’s API description files, and specify how client modules may access the functionality provided by these modules. See usage notes below.
- view-1: Generated from RAML. Uses pop-up windows for each method and endpoint.
- view-2: Generated from RAML. Plain. Uses one-page view to everything.
- view-3: Uploaded from the module’s code build.
- view-4: Generated from OpenAPI OAS.
- Explain views.
This list of modules is sorted into functional groups.
Login
Handling the login process.
mod-login
Source | ||||
---|---|---|---|---|
ramls/login.raml | view-1 | view-2 |
Documentation for mod-login.
mod-login-saml
Source | ||||
---|---|---|---|---|
ramls/saml-login.raml | view-1 | view-2 |
Documentation for mod-login-saml.
mod-authtoken
Source | ||||
---|---|---|---|---|
src/main/resources/openapi/token-1.0.yaml | view-4 |
Documentation for mod-authtoken.
mod-password-validator
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/password-validator.yaml | view-4 | |||
src/main/resources/swagger.api/validator-registry.yaml | view-4 |
Documentation for mod-password-validator.
mod-permissions
Source | ||||
---|---|---|---|---|
ramls/permissions.raml | view-1 | view-2 | ||
ramls/tenantPermissions.raml | view-1 | view-2 |
Documentation for mod-permissions.
Users
Information about users.
mod-users-bl
Source | ||||
---|---|---|---|---|
ramls/mod-users-bl.raml | view-1 | view-2 |
Documentation for mod-users-bl.
mod-users
Documentation for mod-users.
mod-patron
Source | ||||
---|---|---|---|---|
ramls/patron.raml | view-1 | view-2 |
Documentation for mod-patron.
edge-patron
Source | ||||
---|---|---|---|---|
ramls/edge-patron.raml | view-1 | view-2 |
Documentation for edge-patron.
mod-patron-blocks
Documentation for mod-patron-blocks.
mod-feesfines
Documentation for mod-feesfines.
Codex
The FOLIO Codex.
mod-codex-mux
Refer to the raml (raml-util) repository.
Documentation for mod-codex-mux.
mod-codex-inventory
Refer to the raml (raml-util) repository.
Documentation for mod-codex-inventory.
mod-codex-ekb
Refer to the raml (raml-util) repository.
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 | ||||
---|---|---|---|---|
ramls/copycat.raml | view-1 | view-2 |
Documentation for mod-copycat.
mod-inventory
Module should now be using "api-doc" CI facilty.
Documentation for mod-inventory.
mod-inventory-storage
Documentation for mod-inventory-storage.
mod-inventory-update
Source | ||||
---|---|---|---|---|
ramls/inventory-update.raml | view-1 | view-2 |
Documentation for mod-inventory-update.
mod-meta-storage
Source | ||||
---|---|---|---|---|
server/src/main/resources/openapi/meta-storage-1.0.yaml | view-4 |
Documentation for mod-meta-storage.
mod-kb-ebsco-java
Documentation for mod-kb-ebsco-java.
mod-oai-pmh
Documentation for mod-oai-pmh.
edge-oai-pmh
Source | ||||
---|---|---|---|---|
ramls/edge-oai-pmh.raml | view-1 | view-2 |
Documentation for edge-oai-pmh.
Resource management
ERM, licenses, usage statistics.
mod-erm-usage
Documentation for mod-erm-usage.
mod-erm-usage-harvester
Source | ||||
---|---|---|---|---|
ramls/harvester.raml | view-1 | view-2 | ||
ramls/periodic.raml | view-1 | view-2 |
Documentation for mod-erm-usage-harvester.
mod-licenses
Source | ||||
---|---|---|---|---|
ramls/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 | ||||
---|---|---|---|---|
ramls/courses.raml | view-1 | view-2 |
Documentation for mod-courses.
edge-lti-courses
Source | ||||
---|---|---|---|---|
ramls/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
Module should now be using "api-doc" CI facilty.
Documentation for mod-orders-storage.
edge-orders
Source | ||||
---|---|---|---|---|
ramls/edge-orders.raml | view-1 | view-2 |
Documentation for edge-orders.
mod-organizations
Source | ||||
---|---|---|---|---|
ramls/organizations.raml | view-1 | view-2 |
Documentation for mod-organizations.
mod-organizations-storage
Documentation for mod-organizations-storage.
mod-gobi
Source | ||||
---|---|---|---|---|
ramls/gobi.raml | view-1 | view-2 |
Documentation for mod-gobi.
Notifications
Assembling and sending notifications.
mod-notify
Source | ||||
---|---|---|---|---|
ramls/notify.raml | view-1 | view-2 | ||
ramls/patron-notice.raml | view-1 | view-2 |
Documentation for mod-notify.
mod-event-config
Source | ||||
---|---|---|---|---|
ramls/event_config.raml | view-1 | view-2 |
Documentation for mod-event-config.
mod-email
Source | ||||
---|---|---|---|---|
ramls/delayedTasks.raml | view-1 | view-2 | ||
ramls/email.raml | view-1 | view-2 |
Documentation for mod-email.
mod-sender
Source | ||||
---|---|---|---|---|
ramls/sender.raml | view-1 | view-2 |
Documentation for mod-sender.
mod-pubsub
Source | ||||
---|---|---|---|---|
ramls/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 | ||||
---|---|---|---|---|
ramls/dataImport.raml | view-1 | view-2 |
Documentation for mod-data-import.
mod-data-import-converter-storage
Source | ||||
---|---|---|---|---|
ramls/data-import-converter-storage.raml | view-1 | view-2 | ||
ramls/field-protection-settings.raml | view-1 | view-2 | ||
ramls/form-configs-storage.raml | view-1 | view-2 |
Documentation for mod-data-import-converter-storage.
mod-data-export-spring
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/export-configs.yaml | view-4 | |||
src/main/resources/swagger.api/jobs.yaml | view-4 |
Documentation for mod-data-export-spring.
mod-data-export-spring-migrated
Documentation for mod-data-export-spring-migrated.
mod-data-export-worker
Documentation for mod-data-export-worker.
mod-data-export
Documentation for mod-data-export.
mod-source-record-manager
Source | ||||
---|---|---|---|---|
ramls/change-manager.raml | view-1 | view-2 | ||
ramls/mapping-metadata-provider.raml | view-1 | view-2 | ||
ramls/mapping-rules-provider.raml | view-1 | view-2 | ||
ramls/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 | ||||
---|---|---|---|---|
ramls/import.raml | view-1 | view-2 |
Documentation for mod-user-import.
Remote integration
Integration with remote services.
edge-caiasoft
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/edge-caiasoft.yaml | view-4 |
Documentation for edge-caiasoft.
edge-dematic
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/edge-dematic.yaml | view-4 |
Documentation for edge-dematic.
mod-ebsconet
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/ebsconet.yaml | view-4 |
Documentation for mod-ebsconet.
mod-idm-connect
Source | ||||
---|---|---|---|---|
ramls/idm-connect.raml | view-1 | view-2 |
Documentation for mod-idm-connect.
mod-inn-reach
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/circulation.yaml | view-4 | |||
src/main/resources/swagger.api/contribution.yaml | view-4 | |||
src/main/resources/swagger.api/settings.yaml | view-4 |
Documentation for mod-inn-reach.
edge-inn-reach
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/edge-inn-reach.yaml | view-4 |
Documentation for edge-inn-reach.
mod-remote-storage
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/remote-storage.yaml | view-4 |
Documentation for mod-remote-storage.
mod-rtac
Source | ||||
---|---|---|---|---|
ramls/rtac-batch.raml | view-1 | view-2 | ||
ramls/rtac.raml | view-1 | view-2 |
Documentation for mod-rtac.
edge-rtac
Source | ||||
---|---|---|---|---|
ramls/edge-rtac.raml | view-1 | view-2 |
Documentation for edge-rtac.
Utilities and tools
Notes, tags, calendar, etc.
mod-notes
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/notes.yml | view-4 |
Documentation for mod-notes.
mod-tags
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/tags.yml | view-4 |
Documentation for mod-tags.
mod-calendar
Source | ||||
---|---|---|---|---|
ramls/calendar.raml | view-1 | view-2 |
Documentation for mod-calendar.
mod-search
Source | ||||
---|---|---|---|---|
mod-search | view-3 | |||
src/main/resources/swagger.api/mod-search.yaml | view-4 |
Documentation for mod-search.
mod-template-engine
Source | ||||
---|---|---|---|---|
ramls/template-engine.raml | view-1 | view-2 |
Documentation for mod-template-engine.
mod-quick-marc
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/records-editor-async.yaml | view-4 | |||
src/main/resources/swagger.api/records-editor.yaml | view-4 |
Documentation for mod-quick-marc.
Infrastructure
Gateway, raml-util, RMB, monitoring, etc.
okapi
Source | ||||
---|---|---|---|---|
okapi-core/src/main/raml/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.
Documentation for raml.
raml-module-builder
Source | ||||
---|---|---|---|---|
domain-models-api-interfaces/ramls/admin.raml | view-1 | view-2 | ||
domain-models-api-interfaces/ramls/sample.raml | view-1 | view-2 |
Documentation for raml-module-builder.
mod-configuration
Source | ||||
---|---|---|---|---|
ramls/configuration/config.raml | view-1 | view-2 |
Documentation for mod-configuration.
mod-audit
Source | ||||
---|---|---|---|---|
ramls/audit-data.raml | view-1 | view-2 | ||
ramls/circulation-logs.raml | view-1 | view-2 | ||
ramls/mod-audit-handlers.raml | view-1 | view-2 |
Documentation for mod-audit.
Other
Not yet grouped.
mod-eusage-reports
Source | ||||
---|---|---|---|---|
src/main/resources/openapi/eusage-reports-1.0.yaml | view-4 |
Documentation for mod-eusage-reports.
mod-ldp
Source | ||||
---|---|---|---|---|
ramls/ldp.raml | view-1 | view-2 |
Documentation for mod-ldp.
folio-custom-fields
Source | ||||
---|---|---|---|---|
ramls/custom-fields.raml | view-1 | view-2 |
Documentation for folio-custom-fields.
folio-spring-base
Source | ||||
---|---|---|---|---|
src/main/resources/swagger.api/tenant.yaml | view-4 |
Documentation for folio-spring-base.
folio-vertx-lib
Source | ||||
---|---|---|---|---|
core/src/main/resources/openapi/tenant-2.0.yaml | view-4 |
Documentation for folio-vertx-lib.
acq-models
Has only schema and no API descriptions.
Documentation for acq-models.
data-import-raml-storage
Has only schema and no API descriptions.
Documentation for data-import-raml-storage.
folio-export-common
Has only schema and no API descriptions.
Documentation for folio-export-common.
Missing API documentation
The following list of modules are missing the configuration for generating their API documentation.
edge-search-srs
Module should be using "api-doc" CI facilty.
mod-translations
Module should be using "api-doc" CI facilty.
Further information
Usage notes
Generated during CI
The API documents are generated by CI for each repository during the “merge to main branch” phase or upon module release. So the documentation does not relate to feature development branches.
Versioned API Docs
To find documentation for each software version, amend the URL of each generated document view to add the version number (major.minor).
For example mod-circulation, do mod-circulation/22.0/...
Explain “views”
For each module, the “views” of its documentation are generated from the same source API description file, but using different presentation software.
Some modules use RAML (so view-1
and view-2
), others use OpenAPI OAS (so view-4
).
view-1
: Generated from RAML. Uses pop-up windows for each method and endpoint.- via raml2html with default theme.
view-2
: Generated from RAML. Plain. Uses one-page view to everything.- via raml2html with plain theme.
view-3
: Uploaded from the module’s code build.- via CI doUploadApidocs.
view-4
: Generated from OpenAPI OAS.- via Redocly ReDoc.
Encourage use api-doc
Modules should now be using the new CI job “api-doc” (“doApiDoc
”). The old “publishAPI
” facility is now deprecated.
Encourage use api-lint
Modules should now be using the new CI job “api-lint” (“doApiLint
”). The old “runLintRamlCop
” facility is now deprecated.
Explain gather api-doc config
For modules that are now using the “api-doc” CI facility, there is an automated daily workflow “gather-config-apidocs” which collects configuration changes. So there will be a delay for new (or deleted) entries to be listed in their table. Updates to the actual generated API documents for each module do happen automatically, being deployed during their “merge to main branch” phase.
Linking to API Docs tables
- Each section of this page can be directly linked to (e.g. #mod-circulation). Similarly each row of a module’s documentation (e.g. #mod-circulation-change-due-date).
Which module/interface/endpoint
- See assistance for How to determine which module handles which interface and endpoint.
Other notes
- 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.