Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Metadata Collections
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 for all tenants/isils
types:
fincConfigMetadataCollection: !include schemas/fincConfigMetadataCollection.json
fincConfigMetadataCollections: !include schemas/fincConfigMetadataCollections.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-config/metadata-collections:
displayName: Metadata Collections
type:
collection:
exampleCollection: !include examples/fincConfigMetadataCollection_collection.sample
exampleItem: !include examples/fincConfigMetadataCollection.sample
schemaCollection: fincConfigMetadataCollections
schemaItem: fincConfigMetadataCollection
get:
is: [
searchable: {description: "", example: "((label=\"Science*\") and metadataAvailable=(\"yes\" or \"no\")) sortby label"},
orderable: {fieldsList: "label, mdSource, metadataAvailable, usageRestricted, permittedFor, freeContent"},
pageable
]
description: Get all metadata collections
post:
is: [validate]
description: Post new metadata collection
/{id}:
type:
collection-item:
exampleItem: !include examples/fincConfigMetadataCollection.sample
schema: fincConfigMetadataCollection
get:
description: Get one metadata collection identified by id
delete:
description: Delete an metadata collection identified by id
put:
description: Put an metadata collection identified by id