mod-orders-storage/ramls/settings.raml at master · folio-org/mod-orders-storage · 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
#%RAML 1.0
title: "Settings"
baseUri: https://github.com/folio-org/mod-orders-storage
version: v1.0

documentation:
  - title: Settings
    content: <b>CRUD APIs used to manage settings for mod-orders.</b>

types:
  setting: !include acq-models/common/schemas/setting.json
  setting_collection: !include acq-models/common/schemas/setting_collection.json
  errors: !include raml-util/schemas/errors.schema
  error: !include raml-util/schemas/error.schema
  UUID:
    type: string
    pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

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


/orders-storage/settings:
  type:
    collection:
      exampleCollection: !include acq-models/common/examples/setting_collection.sample
      exampleItem: !include acq-models/common/examples/setting_post.sample
      schemaCollection: setting_collection
      schemaItem: setting
  get:
    description: Get a list of settings
    is: [
      searchable: { description: "CQL query", example: "key=BANKING_INFORMATION_ENABLED" },
      pageable
    ]
  post:
    description: Add a new setting
    body:
      application/json:
        type: setting
        example:
          strict: false
          value: !include acq-models/common/examples/setting_post.sample
    responses:
      201:
        description: Setting added
        body:
          application/json:
            example: !include acq-models/common/examples/setting_get.sample
      400:
        description: Bad Request
        body:
          application/json:
            type: error
      401:
        description: Not found
        body:
          application/json:
            type: error
      500:
        description: Internal error
        body:
          application/json:
            type: error
  /{id}:
    uriParameters:
      id:
        description: The UUID of a setting
        type: UUID
    displayName: Settings
    description: Get, Delete or Update a specific setting
    type:
      collection-item:
        exampleItem: !include acq-models/common/examples/setting_get.sample
        schema: setting