Skip FOLIO Project Navigation

GitHub and Twitter:

API documentation

Introduction

This API documentation, and the associated list of endpoints, is automatically generated from each repository’s API description files, and specifies how client modules may access the functionality provided by these modules. See further information 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. API data.

mod-login-saml

Source
ramls/saml-login.raml view-1 view-2

Documentation for mod-login-saml. API data.

mod-authtoken

Source
src/main/resources/openapi/token-1.0.yaml view-4

Documentation for mod-authtoken. API data.

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. API data.

mod-permissions

Source
ramls/permissions.raml view-1 view-2
ramls/tenantPermissions.raml view-1 view-2

Documentation for mod-permissions. API data.

Users

Information about users.

mod-users-bl

Source
ramls/mod-users-bl.raml view-1 view-2

Documentation for mod-users-bl. API data.

mod-users

Source
ramls/addressTypes.raml view-1 view-2
ramls/departments.raml view-1 view-2
ramls/groups.raml view-1 view-2
ramls/patronpin.raml view-1 view-2
ramls/proxiesFor.raml view-1 view-2
ramls/users.raml view-1 view-2

Documentation for mod-users. API data.

mod-patron

Source
ramls/patron.raml view-1 view-2

Documentation for mod-patron. API data.

edge-patron

Source
ramls/edge-patron.raml view-1 view-2

Documentation for edge-patron. API data.

mod-patron-blocks

Source
ramls/automated-patron-blocks.raml view-1 view-2
ramls/eventHandlers.raml view-1 view-2
ramls/patron-block-conditions.raml view-1 view-2
ramls/patron-block-limits.raml view-1 view-2
ramls/user-summary.raml view-1 view-2

Documentation for mod-patron-blocks. API data.

mod-feesfines

Source
ramls/accounts-bulk.raml view-1 view-2
ramls/accounts.raml view-1 view-2
ramls/actual-cost-fee-fine.raml view-1 view-2
ramls/comments.raml view-1 view-2
ramls/feefine-reports.raml view-1 view-2
ramls/feefineactions.raml view-1 view-2
ramls/feefines.raml view-1 view-2
ramls/lost-item-fee-policy.raml view-1 view-2
ramls/manual-block-templates.raml view-1 view-2
ramls/manualblocks.raml view-1 view-2
ramls/overdue-fine-policy.raml view-1 view-2
ramls/owners.raml view-1 view-2
ramls/payments.raml view-1 view-2
ramls/refunds.raml view-1 view-2
ramls/transfer-criteria.raml view-1 view-2
ramls/transfers.raml view-1 view-2
ramls/waiver.raml view-1 view-2

Documentation for mod-feesfines. API data.

Inventory and circulation

Inventory instances, items, and circulation.

mod-circulation

Source
ramls/age-to-lost-background-processes.raml view-1 view-2
ramls/change-due-date.raml view-1 view-2
ramls/circulation-event-handlers.raml view-1 view-2
ramls/circulation-rules.raml view-1 view-2
ramls/circulation.raml view-1 view-2
ramls/claim-item-returned.raml view-1 view-2
ramls/declare-item-lost.raml view-1 view-2
ramls/end-patron-action-session.raml view-1 view-2
ramls/inventory-reports.raml view-1 view-2
ramls/loan-anonymization.raml view-1 view-2
ramls/pick-slips.raml view-1 view-2
ramls/request-move.raml view-1 view-2
ramls/requests-reports.raml view-1 view-2

Documentation for mod-circulation. API data.

mod-circulation-storage

Source
ramls/actual-cost-record-storage.raml view-1 view-2
ramls/anonymize-storage-loans.raml view-1 view-2
ramls/cancellation-reason.raml view-1 view-2
ramls/check-in-storage.raml view-1 view-2
ramls/circulation-rules-storage.raml view-1 view-2
ramls/fixed-due-date-schedule.raml view-1 view-2
ramls/loan-policy-storage.raml view-1 view-2
ramls/loan-storage.raml view-1 view-2
ramls/patron-action-session.raml view-1 view-2
ramls/patron-notice-policy.raml view-1 view-2
ramls/request-policy-storage.raml view-1 view-2
ramls/request-preference-storage.raml view-1 view-2
ramls/request-storage-batch.raml view-1 view-2
ramls/request-storage.raml view-1 view-2
ramls/scheduled-notice-storage.raml view-1 view-2
ramls/staff-slips.raml view-1 view-2
ramls/tlr-feature-toggle-job.raml view-1 view-2

Documentation for mod-circulation-storage. API data.

mod-copycat

Source
ramls/copycat.raml view-1 view-2

Documentation for mod-copycat. API data.

mod-inventory

Source
ramls/inventory-batch.raml view-1 view-2
ramls/inventory-config.raml view-1 view-2
ramls/inventory-event-handlers.raml view-1 view-2
ramls/inventory-move.raml view-1 view-2
ramls/inventory.raml view-1 view-2
ramls/isbn.raml view-1 view-2

Documentation for mod-inventory. API data.

mod-inventory-storage

Source
ramls/alternative-title-type.raml view-1 view-2
ramls/async-migration.raml view-1 view-2
ramls/authorities-reindex.raml view-1 view-2
ramls/authorities.raml view-1 view-2
ramls/authority-note-type.raml view-1 view-2
ramls/authority-source-file.raml view-1 view-2
ramls/bound-with-part.raml view-1 view-2
ramls/call-number-type.raml view-1 view-2
ramls/classification-type.raml view-1 view-2
ramls/contributor-name-type.raml view-1 view-2
ramls/contributor-type.raml view-1 view-2
ramls/electronic-access-relationship.raml view-1 view-2
ramls/holdings-note-type.raml view-1 view-2
ramls/holdings-sources.raml view-1 view-2
ramls/holdings-storage.raml view-1 view-2
ramls/holdings-sync-unsafe.raml view-1 view-2
ramls/holdings-sync.raml view-1 view-2
ramls/holdings-type.raml view-1 view-2
ramls/hrid-settings-storage.raml view-1 view-2
ramls/identifier-type.raml view-1 view-2
ramls/ill-policy.raml view-1 view-2
ramls/instance-format.raml view-1 view-2
ramls/instance-iteration.raml view-1 view-2
ramls/instance-note-type.raml view-1 view-2
ramls/instance-preceding-succeeding-titles.raml view-1 view-2
ramls/instance-reindex.raml view-1 view-2
ramls/instance-relationship-type.raml view-1 view-2
ramls/instance-set.raml view-1 view-2
ramls/instance-status.raml view-1 view-2
ramls/instance-storage-batch.raml view-1 view-2
ramls/instance-storage.raml view-1 view-2
ramls/instance-sync-unsafe.raml view-1 view-2
ramls/instance-sync.raml view-1 view-2
ramls/instance-type.raml view-1 view-2
ramls/inventory-hierarchy.raml view-1 view-2
ramls/inventory-view.raml view-1 view-2
ramls/item-damaged-statuses.raml view-1 view-2
ramls/item-note-type.raml view-1 view-2
ramls/item-storage-dereferenced.raml view-1 view-2
ramls/item-storage.raml view-1 view-2
ramls/item-sync-unsafe.raml view-1 view-2
ramls/item-sync.raml view-1 view-2
ramls/loan-type.raml view-1 view-2
ramls/location.raml view-1 view-2
ramls/locationunit.raml view-1 view-2
ramls/material-type.raml view-1 view-2
ramls/mode-of-issuance.raml view-1 view-2
ramls/nature-of-content-term.raml view-1 view-2
ramls/oai-pmh-view.raml view-1 view-2
ramls/record-bulk.raml view-1 view-2
ramls/service-point.raml view-1 view-2
ramls/service-points-user.raml view-1 view-2
ramls/shelf-location.raml view-1 view-2
ramls/statistical-code-type.raml view-1 view-2
ramls/statistical-code.raml view-1 view-2

Documentation for mod-inventory-storage. API data.

mod-inventory-update

Source
ramls/inventory-update.raml view-1 view-2

Documentation for mod-inventory-update. API data.

mod-kb-ebsco-java

Source
ramls/access-types.raml view-1 view-2
ramls/assigned-users.raml view-1 view-2
ramls/costperuse.raml view-1 view-2
ramls/currencies.raml view-1 view-2
ramls/custom-labels.raml view-1 view-2
ramls/eholdings.raml view-1 view-2
ramls/export.raml view-1 view-2
ramls/kb-credentials.raml view-1 view-2
ramls/packages.raml view-1 view-2
ramls/providers.raml view-1 view-2
ramls/proxies.raml view-1 view-2
ramls/resources.raml view-1 view-2
ramls/tags.raml view-1 view-2
ramls/titles.raml view-1 view-2
ramls/uc.raml view-1 view-2

Documentation for mod-kb-ebsco-java. API data.

mod-oai-pmh

Source
ramls/cleanup-job.raml view-1 view-2
ramls/folio-set-filtering-conditions.raml view-1 view-2
ramls/folio-set.raml view-1 view-2
ramls/oai-pmh.raml view-1 view-2
ramls/request-metadata.raml view-1 view-2

Documentation for mod-oai-pmh. API data.

edge-oai-pmh

Source
ramls/edge-oai-pmh.raml view-1 view-2

Documentation for edge-oai-pmh. API data.

mod-reservoir

Source
server/src/main/resources/openapi/reservoir.yaml view-4

Documentation for mod-reservoir. API data.

Resource management

ERM, licenses, usage statistics.

mod-erm-usage

Source
ramls/aggregatorsettings.raml view-1 view-2
ramls/counterreports.raml view-1 view-2
ramls/customreports.raml view-1 view-2
ramls/files.raml view-1 view-2
ramls/usagedataproviders.raml view-1 view-2

Documentation for mod-erm-usage. API data.

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. API data.

mod-licenses

Source
ramls/licenses.raml view-1 view-2

Documentation for mod-licenses. API data.

mod-finc-config

Source
ramls/fincConfigEZBCredentials.raml view-1 view-2
ramls/fincConfigFiles.raml view-1 view-2
ramls/fincConfigFilters.raml view-1 view-2
ramls/fincConfigMetadataCollections.raml view-1 view-2
ramls/fincConfigMetadataSources.raml view-1 view-2
ramls/fincSelectEZBCredentials.raml view-1 view-2
ramls/fincSelectFiles.raml view-1 view-2
ramls/fincSelectFilters.raml view-1 view-2
ramls/fincSelectMetadataCollections.raml view-1 view-2
ramls/fincSelectMetadataSources.raml view-1 view-2
ramls/isils.raml view-1 view-2

Documentation for mod-finc-config. API data.

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. API data.

edge-lti-courses

Source
ramls/edge-lti-courses.raml view-1 view-2

Documentation for edge-lti-courses. API data.

Finance and orders

Finance, orders, organizations, acquisitions.

mod-finance

Source
ramls/budgets.raml view-1 view-2
ramls/exchange-rate.raml view-1 view-2
ramls/expense-classes.raml view-1 view-2
ramls/finance-fund-codes-expense-classes.raml view-1 view-2
ramls/fiscal-years.raml view-1 view-2
ramls/fund-types.raml view-1 view-2
ramls/funds.raml view-1 view-2
ramls/group-fiscal-year-summaries.raml view-1 view-2
ramls/group-fund-fiscal-year.raml view-1 view-2
ramls/groups.raml view-1 view-2
ramls/ledger-rollover-budgets.raml view-1 view-2
ramls/ledger-rollover-errors.raml view-1 view-2
ramls/ledger-rollover-logs.raml view-1 view-2
ramls/ledger_rollover.raml view-1 view-2
ramls/ledger_rollover_progress.raml view-1 view-2
ramls/ledgers.raml view-1 view-2
ramls/release-encumbrance.raml view-1 view-2
ramls/transaction-summary.raml view-1 view-2
ramls/transaction.raml view-1 view-2

Documentation for mod-finance. API data.

mod-finance-storage

Source
ramls/budget.raml view-1 view-2
ramls/budget_expense_class.raml view-1 view-2
ramls/expense_class.raml view-1 view-2
ramls/fiscal-year.raml view-1 view-2
ramls/fund-type.raml view-1 view-2
ramls/fund.raml view-1 view-2
ramls/group-budgets.raml view-1 view-2
ramls/group.raml view-1 view-2
ramls/group_fund_fy.raml view-1 view-2
ramls/ledger-rollover-errors.raml view-1 view-2
ramls/ledger.raml view-1 view-2
ramls/ledger_rollover-budgets.raml view-1 view-2
ramls/ledger_rollover.raml view-1 view-2
ramls/ledger_rollover_logs.raml view-1 view-2
ramls/ledger_rollover_progress.raml view-1 view-2
ramls/transaction-summary.raml view-1 view-2
ramls/transaction.raml view-1 view-2

Documentation for mod-finance-storage. API data.

mod-invoice

Source
ramls/batch-group.raml view-1 view-2
ramls/batch-voucher-export-configuration.raml view-1 view-2
ramls/batch-voucher-exports.raml view-1 view-2
ramls/batch-voucher.raml view-1 view-2
ramls/invoice.raml view-1 view-2
ramls/voucher.raml view-1 view-2

Documentation for mod-invoice. API data.

mod-invoice-storage

Source
ramls/batch-group.raml view-1 view-2
ramls/batch-voucher-export-configuration.raml view-1 view-2
ramls/batch-voucher-exports.raml view-1 view-2
ramls/batch-voucher.raml view-1 view-2
ramls/invoice-line-number.raml view-1 view-2
ramls/invoice-number.raml view-1 view-2
ramls/invoice.raml view-1 view-2
ramls/voucher-number.raml view-1 view-2
ramls/voucher.raml view-1 view-2

Documentation for mod-invoice-storage. API data.

mod-orders

Source
ramls/acquisition_method.raml view-1 view-2
ramls/acquisitions-units.raml view-1 view-2
ramls/check-in.raml view-1 view-2
ramls/configuration.raml view-1 view-2
ramls/export_history.raml view-1 view-2
ramls/holding-summary.raml view-1 view-2
ramls/order-lines.raml view-1 view-2
ramls/order-templates.raml view-1 view-2
ramls/order.raml view-1 view-2
ramls/pieces.raml view-1 view-2
ramls/po-number.raml view-1 view-2
ramls/receive.raml view-1 view-2
ramls/receiving-history.raml view-1 view-2
ramls/rollover.raml view-1 view-2
ramls/titles.raml view-1 view-2

Documentation for mod-orders. API data.

mod-orders-storage

Source
ramls/acquisition_method.raml view-1 view-2
ramls/acquisitions-unit.raml view-1 view-2
ramls/alert.raml view-1 view-2
ramls/audit_outbox.raml view-1 view-2
ramls/configuration.raml view-1 view-2
ramls/export_history.raml view-1 view-2
ramls/order-invoice-relns.raml view-1 view-2
ramls/order-templates.raml view-1 view-2
ramls/pieces.raml view-1 view-2
ramls/po-line-number.raml view-1 view-2
ramls/po-line.raml view-1 view-2
ramls/po-number.raml view-1 view-2
ramls/purchase-order.raml view-1 view-2
ramls/receiving-history.raml view-1 view-2
ramls/reporting-code.raml view-1 view-2
ramls/titles.raml view-1 view-2

Documentation for mod-orders-storage. API data.

edge-orders

Source
ramls/edge-orders.raml view-1 view-2

Documentation for edge-orders. API data.

mod-organizations

Source
ramls/organizations.raml view-1 view-2

Documentation for mod-organizations. API data.

mod-organizations-storage

Source
ramls/address.raml view-1 view-2
ramls/category.raml view-1 view-2
ramls/contact.raml view-1 view-2
ramls/email.raml view-1 view-2
ramls/interface.raml view-1 view-2
ramls/organization.raml view-1 view-2
ramls/organization_type.raml view-1 view-2
ramls/phone_number.raml view-1 view-2
ramls/url.raml view-1 view-2

Documentation for mod-organizations-storage. API data.

mod-gobi

Source
ramls/gobi-custom-mappings.raml view-1 view-2
ramls/gobi-mappings.raml view-1 view-2
ramls/gobi.raml view-1 view-2

Documentation for mod-gobi. API data.

acq-models

Has only schema and no API descriptions.

Documentation for acq-models.

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. API data.

mod-event-config

Source
ramls/event_config.raml view-1 view-2

Documentation for mod-event-config. API data.

mod-email

Source
ramls/delayedTasks.raml view-1 view-2
ramls/email.raml view-1 view-2
ramls/smtp-configuration.raml view-1 view-2

Documentation for mod-email. API data.

mod-sender

Source
ramls/sender.raml view-1 view-2

Documentation for mod-sender. API data.

mod-pubsub

Source
ramls/pubSub.raml view-1 view-2

Documentation for mod-pubsub. API data.

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. API data.

mod-di-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-di-converter-storage. API data.

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. API data.

mod-data-export-worker

Source
src/main/resources/swagger.api/authority-control.yaml view-4
src/main/resources/swagger.api/bulk-edit.yaml view-4
src/main/resources/swagger.api/bursar-export.yaml view-4
src/main/resources/swagger.api/circulation-log.yaml view-4
src/main/resources/swagger.api/e-holdings.yaml view-4
src/main/resources/swagger.api/order-export.yaml view-4
src/main/resources/swagger.api/refresh-presigned-url.yaml view-4

Documentation for mod-data-export-worker. API data.

mod-data-export

Source
ramls/dataExport-file-definition.raml view-1 view-2
ramls/dataExport-job-profile.raml view-1 view-2
ramls/dataExport-logs.raml view-1 view-2
ramls/dataExport-mapping-profiles.raml view-1 view-2
ramls/dataExport-transformation-fields.raml view-1 view-2
ramls/dataExport.raml view-1 view-2

Documentation for mod-data-export. API data.

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. API data.

mod-source-record-storage

Source
ramls/source-record-storage-batch.raml view-1 view-2
ramls/source-record-storage-records.raml view-1 view-2
ramls/source-record-storage-snapshots.raml view-1 view-2
ramls/source-record-storage-source-records.raml view-1 view-2
ramls/source-record-storage-stream.raml view-1 view-2
ramls/source-record-storage-test-records.raml view-1 view-2

Documentation for mod-source-record-storage. API data.

mod-user-import

Source
ramls/import.raml view-1 view-2

Documentation for mod-user-import. API data.

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.

Remote integration

Integration with remote services.

edge-caiasoft

Source
src/main/resources/swagger.api/edge-caiasoft.yaml view-4

Documentation for edge-caiasoft. API data.

edge-dematic

Source
src/main/resources/swagger.api/edge-dematic.yaml view-4

Documentation for edge-dematic. API data.

mod-ebsconet

Source
src/main/resources/swagger.api/ebsconet.yaml view-4

Documentation for mod-ebsconet. API data.

mod-idm-connect

Source
ramls/idm-connect.raml view-1 view-2

Documentation for mod-idm-connect. API data.

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. API data.

edge-inn-reach

Source
src/main/resources/swagger.api/edge-inn-reach.yaml view-4

Documentation for edge-inn-reach. API data.

mod-remote-storage

Source
src/main/resources/swagger.api/remote-storage.yaml view-4

Documentation for mod-remote-storage. API data.

mod-rtac

Source
ramls/rtac-batch.raml view-1 view-2
ramls/rtac.raml view-1 view-2

Documentation for mod-rtac. API data.

edge-rtac

Source
ramls/edge-rtac.raml view-1 view-2

Documentation for edge-rtac. API data.

Utilities and tools

Gateway, configuration, notes, tags, calendar, RMB, raml-util, etc.

okapi

Source
okapi-core/src/main/raml/okapi.raml view-1 view-2

Documentation for okapi. API data.

mod-configuration

Source
ramls/configuration/config.raml view-1 view-2

Documentation for mod-configuration. API data.

mod-settings

Source
src/main/resources/openapi/settings.yaml view-4

Documentation for mod-settings. API data.

mod-audit

Source
ramls/acquisition-events.raml view-1 view-2
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. API data.

Source

Documentation for mod-entities-links. API data.

mod-notes

Source
src/main/resources/swagger.api/notes.yml view-4

Documentation for mod-notes. API data.

mod-tags

Source
src/main/resources/swagger.api/tags.yml view-4

Documentation for mod-tags. API data.

mod-bulk-operations

Source
src/main/resources/swagger.api/bulk-operations.yaml view-4

Documentation for mod-bulk-operations. API data.

mod-calendar

Source
src/main/resources/api/calendar.yaml view-4

Documentation for mod-calendar. API data.

Source

Documentation for mod-search. API data.

mod-template-engine

Source
ramls/template-engine.raml view-1 view-2

Documentation for mod-template-engine. API data.

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. API data.

raml

This is the shared RAML repository. Each RAML-using module has a certain version of this as a git submodule in their "ramls/raml-util" directory.

Source
ramls/codex/codex-instances-sources.raml view-1 view-2
ramls/codex/codex-packages.raml view-1 view-2
ramls/codex/codex.raml view-1 view-2
ramls/jsonSchemas.raml view-1 view-2
ramls/ramls.raml view-1 view-2
ramls/tenant.raml view-1 view-2

Documentation for raml. API data.

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. API data.

Other

Not yet grouped.

mod-consortia

Source
src/main/resources/swagger.api/consortia.yaml view-4
src/main/resources/swagger.api/tenants.yaml view-4
src/main/resources/swagger.api/user_tenants.yaml view-4

Documentation for mod-consortia. API data.

mod-eusage-reports

Source
src/main/resources/openapi/eusage-reports-1.0.yaml view-4

Documentation for mod-eusage-reports. API data.

mod-ldp

Source
ramls/ldp.raml view-1 view-2

Documentation for mod-ldp. API data.

folio-custom-fields

Source
ramls/custom-fields.raml view-1 view-2

Documentation for folio-custom-fields. API data.

folio-spring-base

Source
src/main/resources/swagger.api/tenant.yaml view-4

Documentation for folio-spring-base. API data.

folio-vertx-lib

Source
core/src/main/resources/openapi/tenant-2.0.yaml view-4

Documentation for folio-vertx-lib. API data.

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

Generated during CI

The API documents are generated by the continuous integration (CI) task “api-doc” 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/23.1/...

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.
  • 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.

Encourage use api-lint

Modules should now be using the new CI job “api-lint” (“doApiLint”). The old “runLintRamlCop” facility is now deprecated.

Encourage use api-doc

Modules should now be using the new CI job “api-doc” (“doApiDoc”). The old “publishAPI” facility is now deprecated.

Explain API data

When api-doc generates the API documentation for a module, it also maintains a data file “config-doc.json” which lists the “API data” (description filenames and endpoints) that it discovered about the module. Follow its link.

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 the “API data” 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.

Each section of this page can be directly linked to (e.g. #mod-circulation). Similarly each row of a module’s documentation table (e.g. #mod-circulation-change-due-date).

Which module/interface/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.