mod-finc-config/ramls/fincConfigFiles.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
#%RAML 1.0
title: Files for Finc Config
version: v1.1
baseUri: http://localhost/mod-finc-config

documentation:
  - title: mod-finc-config API
    content: This documents the API calls that can be made to query files for all tenants/isils

traits:
  orderable: !include ./raml-util/traits/orderable.raml
  pageable: !include ./raml-util/traits/pageable.raml
  searchable: !include ./raml-util/traits/searchable.raml

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

/finc-config/files:
  displayName: Finc config files
  post:
    queryParameters:
      isil:
        type: string
        required: true
        description: The isil this file is assigned to.
    description: |
      Upload/update a finc select file.
      Maximum file size: 50 MB
    body:
      application/octet-stream:
    responses:
      200:
        description: Uploading the file was successful. Returns uuid of uploaded file. This uuid will be referenced in 'fincSelectFilterFile' as value of the property 'file'.
        body:
          text/plain:
      400:
        body:
          text/plain:
      413:
        description: "Payload Too Large - File size exceeds maximum allowed size of 50 MB"
        body:
          text/plain:
      500:
        body:
          text/plain:
  /{id}:
    get:
      description: Get file by id
      responses:
        200:
          body:
            application/octet-stream:
        404:
          body:
            text/plain:
        500:
          description: Server Error
          body:
            text/plain:
    delete:
      description: Delete a file identified by id
      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"