ledger-rollover-budgets.raml

#%RAML 1.0
title: "mod-finance"
baseUri: https://github.com/folio-org/mod-finance
version: v1

documentation:
  - title: mod-finance (Ledger Rollover Budgets)
    content: <b>APIs used to manage ledger rollover budgets.</b>

types:
  errors: !include raml-util/schemas/errors.schema
  ledger_fiscal_year_rollover_budget: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover_budget.json
  ledger_fiscal_year_rollover_budget-collection: !include acq-models/mod-finance/schemas/ledger_fiscal_year_rollover_budget_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-get: !include raml-util/rtypes/collection-get.raml
  collection-item-get: !include raml-util/rtypes/item-collection-get.raml

/finance/ledger-rollovers-budgets:
  type:
    collection-get:
      exampleCollection: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_budget_collection.sample
      exampleItem: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_budget.sample
      schemaCollection: ledger_fiscal_year_rollover_budget-collection
      schemaItem: ledger_fiscal_year_rollover_budget
  is: [validate]
  get:
    description: Get list of rollovers budgets
    is: [
        searchable:
          {
            description: "with valid searchable fields: for example 'budgetStatus'", example: "[\"budgetStatus\", \"Active\", \"=\"]"
          },
        pageable
    ]
  /{id}:
    uriParameters:
      id:
        description: The UUID of a rollover budgets record
        type: UUID
    type:
      collection-item-get:
        exampleItem: !include acq-models/mod-finance/examples/ledger_fiscal_year_rollover_budget.sample
        schema: ledger_fiscal_year_rollover_budget
    is: [validate]