mod-finc-config/ramls/fincSelectEZBCredentials.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
#%RAML 1.0
title: Finc Config EZB Credentials
version: v2
baseUri: http://github.com/org/folio/mod-finc-config

documentation:
  - title: mod-finc-config EZB Credentials API
    content: This documents the API calls that can be made to query and manage EZB credentials for the current tenant/isil

types:
  credential: !include schemas/ezbCredential.json
  credentials: !include schemas/ezbCredentials.json
  errors: !include raml-util/schemas/errors.schema

traits:
  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-select/ezb-credentials:
  get:
    description: Get the ezb credentials of current tenant. Returns JSON null if no credentials have been configured yet.
    responses:
      200:
        description: The tenant's ezb credential entry, or JSON null if not configured
        body:
          application/json:
            type: credential
            example: !include examples/fincConfigEZBCredential.sample
      500:
        description: Internal server error
        body:
          text/plain:
            example: "Internal server error"
  put:
    description: Add or edit an ezb credential entry
    body:
      application/json:
        type: credential
    responses:
      200:
        description: The added collections
        body:
          application/json:
            type: credential
            example: !include examples/fincConfigEZBCredential.sample
      400:
        description: Bad request
        body:
          text/plain:
            example: Bad request
      500:
        description: Internal server error
        body:
          text/plain:
            example: Internal server error
  delete:
    description: Delete ezb credential
    responses:
      204:
        description: "Delete succeeded"
      400:
        description: "Bad request"
        body:
          text/plain:
      500:
        description: "Internal server error"
        body:
          text/plain:
            example: "Internal server error, contact administrator"