Attachment 85468 Details for Bug 22206 – Bug 22206: OpenAPI spec

[patch] Bug 22206: OpenAPI spec

Bug-22206-OpenAPI-spec.patch (text/plain), 4.55 KB, created by Josef Moravec on 2019-02-21 17:15:21 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Josef Moravec

Created: 2019-02-21 17:15:21 UTC

Size: 4.55 KB

patch

obsolete

>From 6a23f4221df9d6ad33289b653101fbfa7bb0f263 Mon Sep 17 00:00:00 2001
>From: Tomas Cohen Arazi <tomascohen@theke.io>
>Date: Mon, 28 Jan 2019 07:39:27 -0300
>Subject: [PATCH] Bug 22206: OpenAPI spec
>
>Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
>---
> api/v1/swagger/paths.json       |   3 +
> api/v1/swagger/paths/holds.json | 132 ++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 135 insertions(+)
>
>diff --git a/api/v1/swagger/paths.json b/api/v1/swagger/paths.json
>index 48452ec..3eab013 100644
>--- a/api/v1/swagger/paths.json
>+++ b/api/v1/swagger/paths.json
>@@ -20,6 +20,9 @@
>   "/holds/{hold_id}": {
>     "$ref": "paths/holds.json#/~1holds~1{hold_id}"
>   },
>+  "/holds/{hold_id}/suspension": {
>+    "$ref": "paths/holds.json#/~1holds~1{hold_id}~1suspension"
>+  },
>   "/libraries": {
>     "$ref": "paths/libraries.json#/~1libraries"
>   },
>diff --git a/api/v1/swagger/paths/holds.json b/api/v1/swagger/paths/holds.json
>index afeaac4..2dea98c 100644
>--- a/api/v1/swagger/paths/holds.json
>+++ b/api/v1/swagger/paths/holds.json
>@@ -386,5 +386,137 @@
>         }
>       }
>     }
>+  },
>+  "/holds/{hold_id}/suspension": {
>+    "post": {
>+      "x-mojo-to": "Holds#suspend",
>+      "operationId": "suspendHold",
>+      "tags": ["holds"],
>+      "parameters": [{
>+          "$ref": "../parameters.json#/hold_id_pp"
>+        }, {
>+          "name": "body",
>+          "in": "body",
>+          "description": "A JSON object containing fields to modify",
>+          "required": false,
>+          "schema": {
>+            "type": "object",
>+            "properties": {
>+              "expiration_date": {
>+                "description": "Date the hold suspension expires",
>+                "type": "string",
>+                "format": "date"
>+              }
>+            }
>+          }
>+        }
>+      ],
>+      "consumes": ["application/json"],
>+      "produces": ["application/json"],
>+      "responses": {
>+        "201": {
>+          "description": "Hold suspended"
>+        },
>+        "400": {
>+          "description": "Missing or wrong parameters",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "401": {
>+          "description": "Authentication required",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "403": {
>+          "description": "Hold not allowed",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "404": {
>+          "description": "Hold not found",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "500": {
>+          "description": "Internal server error",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "503": {
>+          "description": "Under maintenance",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        }
>+      },
>+      "x-koha-authorization": {
>+        "permissions": {
>+          "reserveforothers": "1"
>+        }
>+      }
>+    },
>+    "delete": {
>+      "x-mojo-to": "Holds#resume",
>+      "operationId": "resumeHold",
>+      "tags": ["holds"],
>+      "parameters": [
>+        {
>+          "$ref": "../parameters.json#/hold_id_pp"
>+        }
>+      ],
>+      "consumes": ["application/json"],
>+      "produces": ["application/json"],
>+      "responses": {
>+        "204": {
>+          "description": "Hold resumed"
>+        },
>+        "400": {
>+          "description": "Missing or wrong parameters",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "401": {
>+          "description": "Authentication required",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "403": {
>+          "description": "Hold not allowed",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "404": {
>+          "description": "Hold not found",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "500": {
>+          "description": "Internal server error",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        },
>+        "503": {
>+          "description": "Under maintenance",
>+          "schema": {
>+            "$ref": "../definitions.json#/error"
>+          }
>+        }
>+      },
>+      "x-koha-authorization": {
>+        "permissions": {
>+          "reserveforothers": "1"
>+        }
>+      }
>+    }
>   }
> }
>-- 
>2.1.4

Actions: View | Diff | Splinter Review

Attachments on bug 22206: 84473 | 84474 | 84475 | 85056 | 85057 | 85058 | 85468 | 85469 | 85470 | 85471 | 85862 | 85864 | 85865 | 85866 | 85867 | 85868