Koha/api/v1/swagger/paths/acquisitions_edifiles.yaml
Tomas Cohen Arazi f2204a1744
Bug 36565: EDI files API docs fixes (bug 30070 follow-up)
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2024-04-29 09:35:36 +02:00

63 lines
1.8 KiB
YAML

---
/acquisitions/edifiles:
get:
x-mojo-to: Acquisitions::Vendor::Edifact::Files#list
operationId: listEdifactFiles
tags:
- edi_files
summary: List EDIFACT files
produces:
- application/json
parameters:
- $ref: "../swagger.yaml#/parameters/match"
- $ref: "../swagger.yaml#/parameters/order_by"
- $ref: "../swagger.yaml#/parameters/page"
- $ref: "../swagger.yaml#/parameters/per_page"
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
- $ref: "../swagger.yaml#/parameters/request_id_header"
- name: x-koha-embed
in: header
required: false
description: Embed list sent as a request header
type: array
items:
type: string
enum:
- vendor
- basket
collectionFormat: csv
responses:
"200":
description: A list of EDIFACT files
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/edifact_file"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: EDIFACT file not found
schema:
$ref: "../swagger.yaml#/definitions/error"
"500":
description: |
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
"503":
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
acquisition: edi_manage