Bug 33036: REST API: Merge biblio records implements merging of records
[koha.git] / api / v1 / swagger / definitions / merge_biblios.yaml
1 ---
2 type: object
3 properties:
4   biblio_id_to_merge:
5     type: integer
6     description: Biblionumber from which to merge
7   rules:
8     type:
9       - string
10       - "null"
11     description: Internally identifier of a merge algoritm. Now two identifier are supported, 'override' and 'override_ext'.
12       'override' is to use when you the bibliographic data of biblio_id as resulting bibliographic data. The null value is equivalent
13        of 'override'.
14       'override_ext' is to use only with a value in datarecord field. In fact is mandatory to use if you insert a record inside datarecord field.
15   framework_to_use:
16     type:
17       - string
18       - "null"
19     description: Framework code, you can use it only with a value in datarecord field. With null value it uses the framework
20       code of record to be merged into.
21   datarecord:
22     description: Bibliographic record used as result of the merge. It uses the format MARC-in-JSON
23     type:
24       - object
25       - "null"
26 additionalProperties: false
27 required:
28   - biblio_id_to_merge