Bug 33227: (follow-up) Improve docs

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

diff --git a/api/v1/swagger/paths/biblios.yaml b/api/v1/swagger/paths/biblios.yaml
index 5fdf83b..8b7da78 100644 (file)
--- 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"