mod-finc-config/ramls/fincConfigMetadataSources.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
69
70
71
72
73
74
75
76
#%RAML 1.0
title: Metadata Sources
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 sources for all tenants/isils

types:
  fincConfigMetadataSource: !include schemas/fincConfigMetadataSource.json
  fincConfigMetadataSources: !include schemas/fincConfigMetadataSources.json
  tinyMetadataSource: !include schemas/tinyMetadataSource.json
  tinyMetadataSources: !include schemas/tinyMetadataSources.json
  contact: !include schemas/contact.json
  contacts: !include schemas/contacts.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

resourceTypes:
  collection: !include ./raml-util/rtypes/collection.raml
  collection-get: !include ./raml-util/rtypes/collection-get.raml
  collection-item: !include ./raml-util/rtypes/item-collection.raml

/finc-config/metadata-sources:
  displayName: Metadata Sources
  type:
    collection:
      exampleCollection: !include examples/fincConfigMetadataSource_collection.sample
      exampleItem: !include examples/fincConfigMetadataSource.sample
      schemaCollection: fincConfigMetadataSources
      schemaItem: fincConfigMetadataSource
  get:
    is: [
      searchable: {description: "", example: "((label=\"Journals*\" or sourceId=\"Journals*\") and status=(\"active\" or \"technical implementation\")) sortby label"},
      orderable: {fieldsList: "label, sourceId, status, solrShard, lastProcessed"},
      pageable
    ]
    description: Get all metadata sources
  post:
    is: [validate]
    description: Post new metadata source
  /{id}:
    type:
      collection-item:
        exampleItem: !include examples/fincConfigMetadataSource.sample
        schema: fincConfigMetadataSource
    get:
      description: Get one metadata source identified by id
    delete:
      description: Delete an metadata source identified by id
    put:
      description: Put an metadata source identified by id
/finc-config/tiny-metadata-sources:
  type:
    collection-get:
      exampleCollection: !include examples/tinyMetadataSource_collection.sample
      exampleItem: !include examples/tinyMetadataSource.sample
      schemaCollection: tinyMetadataSources
      schemaItem: tinyMetadataSource
  get:
    description: Get all tiny metadata sources
/finc-config/contacts:
  type:
    collection-get:
      exampleCollection: !include examples/contact_collection.sample
      exampleItem: !include examples/contact.sample
      schemaCollection: contacts
      schemaItem: contact
  get:
    description: Get all contacts defined in metadata sources