Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
mod-finance-storage/ramls/ledger_rollover_progress.raml
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
51 lines (45 sloc)
1.95 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#%RAML 1.0 | |
title: "mod-finance-storage" | |
baseUri: https://github.com/folio-org/mod-finance-storage | |
version: v1 | |
documentation: | |
- title: mod-finance-storage (Ledger Rollover Progress) | |
content: <b>CRUD APIs used to manage ledger rollover progress.</b> | |
types: | |
errors: !include raml-util/schemas/errors.schema | |
ledger-fiscal-year-rollover-progress: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover_progress.json | |
ledger-fiscal-year-rollover-progress-collection: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover_progress_collection.json | |
UUID: | |
type: string | |
pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ | |
traits: | |
pageable: !include raml-util/traits/pageable.raml | |
searchable: !include raml-util/traits/searchable.raml | |
validate: !include raml-util/traits/validation.raml | |
resourceTypes: | |
collection: !include raml-util/rtypes/collection.raml | |
collection-item: !include raml-util/rtypes/item-collection.raml | |
/finance-storage/ledger-rollovers-progress: | |
type: | |
collection: | |
exampleCollection: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_progress_collection.sample | |
exampleItem: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_progress.sample | |
schemaCollection: ledger-fiscal-year-rollover-progress-collection | |
schemaItem: ledger-fiscal-year-rollover-progress | |
is: [validate] | |
get: | |
description: Get list of rollovers progresses | |
is: [ | |
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"}, | |
pageable | |
] | |
/{id}: | |
uriParameters: | |
id: | |
description: The UUID of a rollover progress record | |
type: UUID | |
type: | |
collection-item: | |
exampleItem: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_progress.sample | |
schema: ledger-fiscal-year-rollover-progress | |
is: [validate] |