Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
53 lines (46 sloc) 1.7 KB
#%RAML 1.0
title: "mod-finance-storage"
baseUri: https://github.com/folio-org/mod-finance-storage
version: v2
documentation:
- title: mod-finance-storage (Fiscal Year)
content: <b>CRUD APIs used to manage fiscal years.</b>
types:
errors: !include raml-util/schemas/errors.schema
fiscal-year: !include acq-models/mod-finance/schemas/fiscal_year.json
fiscal-year-collection: !include acq-models/mod-finance/schemas/fiscal_year_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
language: !include raml-util/traits/language.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/fiscal-years:
type:
collection:
exampleCollection: !include acq-models/mod-finance/examples/fiscal_year_collection.sample
exampleItem: !include acq-models/mod-finance/examples/fiscal_year.sample
schemaCollection: fiscal-year-collection
schemaItem: fiscal-year
is: [validate]
get:
description: Get list of fiscal years
is: [
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
pageable
]
/{id}:
uriParameters:
id:
description: The UUID of a fiscal year
type: UUID
type:
collection-item:
exampleItem: !include acq-models/mod-finance/examples/fiscal_year.sample
schema: fiscal-year
is: [validate]
You can’t perform that action at this time.