mod-finc-config/ramls/fincConfigFilters.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#%RAML 1.0
title: Filters for Finc Config
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 filters of metadata collections for all tenants/isils

types:
  fincSelectFilter: !include schemas/fincSelectFilter.json
  fincSelectFilters: !include schemas/fincSelectFilters.json
  fincSelectFilterToCollections: !include schemas/fincSelectFilterToCollections.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-item: !include ./raml-util/rtypes/item-collection.raml

/finc-config/filters:
  displayName: Finc config filters
  type:
    collection:
      exampleCollection: !include examples/fincSelectFilter_collection.sample
      exampleItem: !include examples/fincSelectFilter1.sample
      schemaCollection: fincSelectFilters
      schemaItem: fincSelectFilter
  get:
    is: [
      searchable: {description: "", example: "((label=\"test*\") and type=\"Blacklist\") sortby label"},
      orderable: {fieldsList: "label, type"},
      pageable
    ]
    description: Get all filters
  post:
    is: [validate]
    description: Post new filter
  /{id}:
    type:
      collection-item:
        exampleItem: !include examples/fincSelectFilter1.sample
        schema: fincSelectFilter
    get:
      description: Get one finc config filter identified by id
    put:
      description: Put a filter identified by id
    delete:
      description: Delete a filter identified by id
    /collections:
      get:
        description: Get all metadata collections the current filter is assigned to
        responses:
          200:
            description: The IDs of collections assigned to this filter
            body:
              application/json:
                type: fincSelectFilterToCollections
                example: !include examples/fincSelectFilterToMetadataCollections.sample
          404:
            description: Not found
            body:
              text/plain:
                example: Not found
          500:
            description: Internal server error
            body:
              text/plain:
                example: "Internal server error"
      put:
        description: Add collections to this filter
        body:
          application/json:
            type: fincSelectFilterToCollections
        responses:
          200:
            description: The added collections
            body:
              application/json:
                type: fincSelectFilterToCollections
                example: !include examples/fincSelectFilterToMetadataCollections.sample
          400:
            description: Bad request
            body:
              text/plain:
                example: Bad request
          500:
            description: Internal server error
            body:
              text/plain:
                example: Internal server error