mod-finc-config/ramls/fincConfigMetadataCollections.raml at master · folio-org/mod-finc-config · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
#%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
  fincConfigMetadataCollectionWithFilters: !include schemas/fincConfigMetadataCollectionWithFilters.json
  fincConfigMetadataCollectionWithFiltersCollection: !include schemas/fincConfigMetadataCollectionWithFiltersCollection.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
  validate: !include ./raml-util/traits/validation.raml
  include_filtered_by: !include ./traits/include_filtered_by.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,
      include_filtered_by
    ]
    description: Get all metadata collections
    responses:
      200:
        body:
          application/json:
            type: fincConfigMetadataCollectionWithFiltersCollection
  post:
    is: [validate]
    description: Post new metadata collection
  /{id}:
    type:
      collection-item:
        exampleItem: !include examples/fincConfigMetadataCollection.sample
        schema: fincConfigMetadataCollection
    get:
      is: [include_filtered_by]
      description: Get one metadata collection identified by id
      responses:
        200:
          body:
            application/json:
              type: fincConfigMetadataCollectionWithFilters
    delete:
      description: Delete an metadata collection identified by id
    put:
      description: Put an metadata collection identified by id