Koha/api/v1/swagger/definitions/import_batch_profile.yaml
Tomas Cohen Arazi d6c67eddd3 Bug 29620: Move the OpenAPI spec to YAML format
This patch moves all the REST API spec pieces into YAML.

To test:
1. Run:
   $ kshell
  k$ prove t/db_dependent/api/v1/*
=> SUCCESS: Tests pass
2. Apply this patch
3. Repeat 1
=> SUCCESS: Tests still pass!
4. Sign off :-D

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2021-12-07 12:33:35 -10:00

60 lines
1.2 KiB
YAML

---
type: object
properties:
profile_id:
type: integer
description: Internal profile identifier
name:
description: name of this profile
type: string
matcher_id:
description: the id of the match rule used (matchpoints.matcher_id)
type:
- integer
- "null"
template_id:
description: the id of the marc modification template
type:
- integer
- "null"
overlay_action:
description: how to handle duplicate records
type:
- string
- "null"
nomatch_action:
description: how to handle records where no match is found
type:
- string
- "null"
item_action:
description: what to do with item records
type:
- string
- "null"
parse_items:
description: should items be parsed
type:
- boolean
- "null"
record_type:
description: type of record in the batch
type:
- string
- "null"
encoding:
description: file encoding
type:
- string
- "null"
format:
description: marc format
type:
- string
- "null"
comments:
description: any comments added when the file was uploaded
type:
- string
- "null"
additionalProperties: false