From 9990af0e393491ba61032d01c55889c413b1a814 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Mon, 20 Mar 2023 08:48:22 -0300 Subject: [PATCH] Bug 33227: (follow-up) Improve docs Signed-off-by: Tomas Cohen Arazi Signed-off-by: Martin Renvoize --- api/v1/swagger/paths/biblios.yaml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/api/v1/swagger/paths/biblios.yaml b/api/v1/swagger/paths/biblios.yaml index 5fdf83bc07..8b7da78cb6 100644 --- a/api/v1/swagger/paths/biblios.yaml +++ b/api/v1/swagger/paths/biblios.yaml @@ -6,6 +6,18 @@ tags: - biblios summary: Add biblio + description: | + Add a bibliographic record to Koha. An optional `x-framework-id` + may be passed to specify the cataloguing framework to be used (instead + of the default). + + The request body is expected to contain a MARC record in the format specified in + the `Content-type` header you pass. Possible values for this header and the corresponding + record formats expected are listed below: + + * application/marcxml+xml: MARCXML + * application/marc-in-json: MARC-in-JSON + * application/marc: Raw USMARC binary data parameters: - $ref: "../swagger.yaml#/parameters/framework_id_header" - $ref: "../swagger.yaml#/parameters/marc_schema_header" @@ -204,6 +216,18 @@ tags: - biblios summary: Update biblio + description: | + Updates a bibliographic record to Koha. An optional `x-framework-id` + may be passed, to specify the cataloguing framework to be used (instead + of the default). + + The request body is expected to contain a MARC record in the format specified by + the `Content-type` header passed. Possible values for this headers and the corresponding + record formats expected are listed below: + + * application/marcxml+xml: MARCXML + * application/marc-in-json: MARC-in-JSON + * application/marc: Raw USMARC binary data parameters: - $ref: "../swagger.yaml#/parameters/biblio_id_pp" - $ref: "../swagger.yaml#/parameters/framework_id_header" -- 2.39.2