Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (52 sloc) 2.08 KB
#%RAML 1.0
title: Metadata Collections Select
version: v1
baseUri: http://localhost/mod-finc-config
documentation:
- title: mod-finc-config API
content: This documents the API calls that can be made to query and manage metadata collections
types:
fincSelectMetadataSource: !include schemas/fincSelectMetadataSource.json
fincSelectMetadataSources: !include schemas/fincSelectMetadataSources.json
fincSelectMetadataCollection: !include schemas/fincSelectMetadataCollection.json
fincSelectMetadataCollections: !include schemas/fincSelectMetadataCollections.json
select: !include schemas/select.json
errors: !include ./raml-util/schemas/errors.schema
traits:
orderable: !include ./raml-util/traits/orderable.raml
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
/finc-select/metadata-collections:
displayName: Metadata Collections Select
type:
collection:
exampleCollection: !include examples/fincSelectMetadataCollection_collection.sample
exampleItem: !include examples/fincSelectMetadataCollection.sample
schemaCollection: fincSelectMetadataCollections
schemaItem: fincSelectMetadataCollection
get:
is: [
searchable: {description: "", example: "active=true sortBy username"},
orderable: {fieldsList: "field A, field B"},
pageable
]
description: Get all metadata collections
/{id}:
type:
collection-item:
exampleItem: !include examples/fincSelectMetadataCollection.sample
schema: fincSelectMetadataCollection
get:
description: Get one metadata collection identified by id
/select:
type:
collection-item:
exampleItem: !include examples/select.sample
schema: select
put:
description: Put, if this metadata collection is selected resp. deselected
You can’t perform that action at this time.