mod-invoice/ramls/batch-voucher-exports.raml at master · folio-org/mod-invoice · 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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
#%RAML 1.0

title: Batch voucher exports
version: v1.0
protocols: [ HTTP, HTTPS ]
baseUri: http://github.com/folio-org/mod-invoice

documentation:
  - title: Batch voucher exports CRUD API
    content: This documents the API calls that can be made to manage batch voucher exports

types:
  batchVoucherExport: !include acq-models/mod-invoice-storage/schemas/batch_voucher_export.json
  batchVoucherExportCollection: !include acq-models/mod-invoice-storage/schemas/batch_voucher_export_collection.json
  errors: !include raml-util/schemas/errors.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:
  validate: !include raml-util/traits/validation.raml
  pageable:  !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml

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

/batch-voucher/batch-voucher-exports:
  displayName: Batch-voucher-exports
  description: Manage Batch-voucher-exports
  type:
    collection:
      schemaCollection: batchVoucherExportCollection
      schemaItem: batchVoucherExport
      exampleCollection: !include acq-models/mod-invoice-storage/examples/batch_voucher_export_collection.sample
      exampleItem: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
  post:
    is: [validate]
  get:
    description: Get list of batch voucher exports
    is: [
      validate,
      pageable,
      searchable: {description: "with valid searchable fields: for example status", example: "status==Pending"}
    ]
  /{id}:
    uriParameters:
      id:
        description: The UUID of a batch voucher exports
        type: UUID
    displayName: Batch-voucher-exports
    description: Get, Delete or Update a specific batch-voucher-export
    type:
      collection-item:
        schema: batchVoucherExport
        exampleItem: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
    /upload:
      post:
        description: (Re)upload the batch voucher associated with this voucher export to the configured URI, using the configured credentials
        responses:
          202:
            description: "Batch voucher export record successfully (Re)uploaded"
            body:
              application/json:
                example: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
          400:
            description: "Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
            body:
              text/plain:
                example: "unable to FTP upload of the batch voucher -- malformed JSON at 13:3"
              application/json:
                example:
                  strict: false
                  value: !include raml-util/examples/errors.sample
          401:
            description: "Not authorized to perform requested action"
            body:
              text/plain:
                example: "unable to FTP upload of the batch voucher -- unauthorized"
              application/json:
                example:
                  strict: false
                  value: !include raml-util/examples/errors.sample
          500:
            description: "Internal server error, e.g. due to misconfiguration"
            body:
              text/plain:
                example: "Internal server error, contact administrator"
              application/json:
                example:
                  strict: false
                  value: !include raml-util/examples/errors.sample
    get:
      description: Return a batch-voucher-export with given {id}
      is: [validate]
    put:
      description: Update a batch-voucher-export with given {id}
      is: [validate]
    delete:
      description: Delete a batch-voucher-export with given {id}
      is: [validate]

  /scheduled:
    post:
      description: Conditionally creates a batch voucher export
      responses:
        204:
          description: "Checks configuration successfully"
        202:
          description: "Batch voucher export record successfully (Re)uploaded"
          body:
            application/json:
              example: !include acq-models/mod-invoice-storage/examples/batch_voucher_export.sample
        400:
          description: "Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response."
          body:
            text/plain:
              example: "unable to FTP upload of the batch voucher -- malformed JSON at 13:3"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
        401:
          description: "Not authorized to perform requested action"
          body:
            text/plain:
              example: "unable to FTP upload of the batch voucher -- unauthorized"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
            application/json:
              example:
                strict: false
                value: !include raml-util/examples/errors.sample