Attachment 116960 Details for Bug 26633 – Bug 26633: Convert transfer_limit.json to YAML

[patch] Bug 26633: Convert transfer_limit.json to YAML

Bug-26633-Convert-transferlimitjson-to-YAML.patch (text/plain), 19.13 KB, created by Katrin Fischer on 2021-02-17 19:04:28 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Katrin Fischer

Created: 2021-02-17 19:04:28 UTC

Size: 19.13 KB

patch

obsolete

>From de8d7cfb318830397e6ba1aa5c5d93070df3d597 Mon Sep 17 00:00:00 2001
>From: Kyle M Hall <kyle@bywatersolutions.com>
>Date: Fri, 6 Nov 2020 10:37:35 -0500
>Subject: [PATCH] Bug 26633: Convert transfer_limit.json to YAML
>
>Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
>---
> api/v1/swagger/paths.json                 |   6 +-
> api/v1/swagger/paths/transfer_limits.json | 376 ------------------------------
> api/v1/swagger/paths/transfer_limits.yaml | 254 ++++++++++++++++++++
> 3 files changed, 257 insertions(+), 379 deletions(-)
> delete mode 100644 api/v1/swagger/paths/transfer_limits.json
> create mode 100644 api/v1/swagger/paths/transfer_limits.yaml
>
>diff --git a/api/v1/swagger/paths.json b/api/v1/swagger/paths.json
>index 8eabdcba85..a845313fc8 100644
>--- a/api/v1/swagger/paths.json
>+++ b/api/v1/swagger/paths.json
>@@ -81,13 +81,13 @@
>     "$ref": "paths/libraries.json#/~1libraries"
>   },
>   "/transfer_limits": {
>-    "$ref": "paths/transfer_limits.json#/~1transfer_limits"
>+    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits"
>   },
>   "/transfer_limits/{limit_id}": {
>-    "$ref": "paths/transfer_limits.json#/~1transfer_limits~1{limit_id}"
>+    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}"
>   },
>   "/transfer_limits/batch": {
>-    "$ref": "paths/transfer_limits.json#/~1transfer_limits~1batch"
>+    "$ref": "paths/transfer_limits.yaml#/~1transfer_limits~1batch"
>   },
>   "/libraries/{library_id}": {
>     "$ref": "paths/libraries.json#/~1libraries~1{library_id}"
>diff --git a/api/v1/swagger/paths/transfer_limits.json b/api/v1/swagger/paths/transfer_limits.json
>deleted file mode 100644
>index d0f89559ac..0000000000
>--- a/api/v1/swagger/paths/transfer_limits.json
>+++ /dev/null
>@@ -1,376 +0,0 @@
>-{
>-  "/transfer_limits": {
>-    "get": {
>-      "x-mojo-to": "TransferLimits#list",
>-      "operationId": "listTransferLimits",
>-      "tags": [
>-        "transfer"
>-      ],
>-      "parameters": [
>-        {
>-          "name": "to_library_id",
>-          "in": "query",
>-          "description": "Search on to_library_id",
>-          "required": false,
>-          "type": "string"
>-        },
>-        {
>-          "name": "from_library_id",
>-          "in": "query",
>-          "description": "Search on from_library_id",
>-          "required": false,
>-          "type": "string"
>-        },
>-        {
>-          "name": "item_type",
>-          "in": "query",
>-          "description": "Search on item_type",
>-          "required": false,
>-          "type": "string"
>-        },
>-        {
>-          "name": "collection_code",
>-          "in": "query",
>-          "description": "Search on collection_code",
>-          "required": false,
>-          "type": "string"
>-        },
>-        {
>-          "$ref": "../parameters.json#/match"
>-        },
>-        {
>-          "$ref": "../parameters.json#/order_by"
>-        },
>-        {
>-          "$ref": "../parameters.json#/page"
>-        },
>-        {
>-          "$ref": "../parameters.json#/per_page"
>-        },
>-        {
>-          "$ref": "../parameters.json#/q_param"
>-        },
>-        {
>-          "$ref": "../parameters.json#/q_body"
>-        },
>-        {
>-          "$ref": "../parameters.json#/q_header"
>-        }
>-      ],
>-      "produces": [
>-        "application/json"
>-      ],
>-      "responses": {
>-        "200": {
>-          "description": "A list of transfer limits",
>-          "schema": {
>-            "type": "array",
>-            "items": {
>-              "$ref": "../definitions.json#/transfer_limit"
>-            }
>-          }
>-        },
>-        "500": {
>-          "description": "Internal error",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "503": {
>-          "description": "Under maintenance",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        }
>-      },
>-      "x-koha-authorization": {
>-        "permissions": {
>-          "parameters": "manage_transfers"
>-        }
>-      }
>-    },
>-    "post": {
>-      "x-mojo-to": "TransferLimits#add",
>-      "operationId": "addTransferLimit",
>-      "tags": [
>-        "transfer"
>-      ],
>-      "parameters": [
>-        {
>-          "name": "body",
>-          "in": "body",
>-          "description": "A JSON object containing information about a new transfer limit",
>-          "required": true,
>-          "schema": {
>-            "$ref": "../definitions.json#/transfer_limit"
>-          }
>-        }
>-      ],
>-      "produces": [
>-        "application/json"
>-      ],
>-      "responses": {
>-        "201": {
>-          "description": "Transfer limit added",
>-          "schema": {
>-            "$ref": "../definitions.json#/transfer_limit"
>-          }
>-        },
>-        "400": {
>-          "description": "Bad request",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "401": {
>-          "description": "Authentication required",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "403": {
>-          "description": "Access forbidden",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "409": {
>-          "description": "Conflict in creating resource",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "500": {
>-          "description": "Internal error",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "503": {
>-          "description": "Under maintenance",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        }
>-      },
>-      "x-koha-authorization": {
>-        "permissions": {
>-          "parameters": "manage_transfers"
>-        }
>-      }
>-    }
>-  },
>-  "/transfer_limits/{limit_id}": {
>-    "delete": {
>-      "x-mojo-to": "TransferLimits#delete",
>-      "operationId": "deleteTransferLimit",
>-      "tags": [
>-        "transfer"
>-      ],
>-      "parameters": [
>-        {
>-          "$ref": "../parameters.json#/transfer_limit_id_pp"
>-        }
>-      ],
>-      "produces": [
>-        "application/json"
>-      ],
>-      "responses": {
>-        "204": {
>-          "description": "Transfer limit deleted",
>-          "schema": {
>-            "type": "string"
>-          }
>-        },
>-        "401": {
>-          "description": "Authentication required",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "403": {
>-          "description": "Access forbidden",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "404": {
>-          "description": "Library not found",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "500": {
>-          "description": "Internal error",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "503": {
>-          "description": "Under maintenance",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        }
>-      },
>-      "x-koha-authorization": {
>-        "permissions": {
>-          "parameters": "manage_transfers"
>-        }
>-      }
>-    }
>-  },
>-  "/transfer_limits/batch": {
>-    "post": {
>-      "x-mojo-to": "TransferLimits#batch_add",
>-      "operationId": "batchAddTransferLimits",
>-      "tags": [
>-        "transfer"
>-      ],
>-      "parameters": [
>-        {
>-          "name": "body",
>-          "in": "body",
>-          "description": "A JSON object containing information about new transfer limits.",
>-          "required": true,
>-          "schema": {
>-          "type": "object",
>-          "properties": {
>-              "to_library_id": {
>-                "type": "string",
>-                "description": "Internal library id for which library the item is going to"
>-              },
>-              "from_library_id": {
>-                "type": "string",
>-                "description": "Internal library id for which library the item is coming from"
>-              },
>-              "item_type": {
>-                "type": ["string", "null"],
>-                "description": "Itemtype defining the type for this limi"
>-              },
>-              "collection_code": {
>-                "type": ["string", "null"],
>-                "description": "Authorized value for the collection code associated with this limit"
>-              }
>-            },
>-            "additionalProperties": false
>-          }
>-        }
>-      ],
>-      "produces": [
>-        "application/json"
>-      ],
>-      "responses": {
>-        "201": {
>-          "description": "A list of transfer limits",
>-          "schema": {
>-            "type": "array",
>-            "items": {
>-              "$ref": "../definitions.json#/transfer_limit"
>-            }
>-          }
>-        },
>-        "500": {
>-          "description": "Internal error",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "503": {
>-          "description": "Under maintenance",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        }
>-      },
>-      "x-koha-authorization": {
>-        "permissions": {
>-          "parameters": "manage_transfers"
>-        }
>-      }
>-    },
>-    "delete": {
>-      "x-mojo-to": "TransferLimits#batch_delete",
>-      "operationId": "batchDeleteTransferLimits",
>-      "tags": [
>-        "transfer"
>-      ],
>-      "parameters": [
>-        {
>-          "name": "body",
>-          "in": "body",
>-          "description": "A JSON object containing information about new transfer limits.",
>-          "required": true,
>-          "schema": {
>-            "type": "object",
>-            "properties": {
>-              "to_library_id": {
>-                "type": "string",
>-                "description": "Internal library id for which library the item is going to"
>-              },
>-              "from_library_id": {
>-                "type": "string",
>-                "description": "Internal library id for which library the item is coming from"
>-              },
>-              "item_type": {
>-                "type": ["string", "null"],
>-                "description": "Itemtype defining the type for this limi"
>-              },
>-              "collection_code": {
>-                "type": ["string", "null"],
>-                "description": "Authorized value for the collection code associated with this limit"
>-              }
>-            },
>-            "additionalProperties": false
>-          }
>-        }
>-      ],
>-      "produces": [
>-        "application/json"
>-      ],
>-      "responses": {
>-        "204": {
>-          "description": "Transfer limits deleted",
>-          "schema": {
>-            "type": "string"
>-          }
>-        },
>-        "401": {
>-          "description": "Authentication required",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "403": {
>-          "description": "Access forbidden",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "404": {
>-          "description": "Library not found",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "500": {
>-          "description": "Internal error",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        },
>-        "503": {
>-          "description": "Under maintenance",
>-          "schema": {
>-            "$ref": "../definitions.json#/error"
>-          }
>-        }
>-      },
>-      "x-koha-authorization": {
>-        "permissions": {
>-          "parameters": "manage_transfers"
>-        }
>-      }
>-    }
>-  }
>-}
>diff --git a/api/v1/swagger/paths/transfer_limits.yaml b/api/v1/swagger/paths/transfer_limits.yaml
>new file mode 100644
>index 0000000000..e83817ff7b
>--- /dev/null
>+++ b/api/v1/swagger/paths/transfer_limits.yaml
>@@ -0,0 +1,254 @@
>+---
>+"/transfer_limits":
>+  get:
>+    x-mojo-to: TransferLimits#list
>+    operationId: listTransferLimits
>+    tags:
>+    - transfer
>+    parameters:
>+    - name: to_library_id
>+      in: query
>+      description: Search on to_library_id
>+      required: false
>+      type: string
>+    - name: from_library_id
>+      in: query
>+      description: Search on from_library_id
>+      required: false
>+      type: string
>+    - name: item_type
>+      in: query
>+      description: Search on item_type
>+      required: false
>+      type: string
>+    - name: collection_code
>+      in: query
>+      description: Search on collection_code
>+      required: false
>+      type: string
>+    - "$ref": "../parameters.json#/match"
>+    - "$ref": "../parameters.json#/order_by"
>+    - "$ref": "../parameters.json#/page"
>+    - "$ref": "../parameters.json#/per_page"
>+    - "$ref": "../parameters.json#/q_param"
>+    - "$ref": "../parameters.json#/q_body"
>+    - "$ref": "../parameters.json#/q_header"
>+    produces:
>+    - application/json
>+    responses:
>+      '200':
>+        description: A list of transfer limits
>+        schema:
>+          type: array
>+          items:
>+            "$ref": "../definitions.json#/transfer_limit"
>+      '500':
>+        description: Internal error
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '503':
>+        description: Under maintenance
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+    x-koha-authorization:
>+      permissions:
>+        parameters: manage_transfers
>+  post:
>+    x-mojo-to: TransferLimits#add
>+    operationId: addTransferLimit
>+    tags:
>+    - transfer
>+    parameters:
>+    - name: body
>+      in: body
>+      description: A JSON object containing information about a new transfer limit
>+      required: true
>+      schema:
>+        "$ref": "../definitions.json#/transfer_limit"
>+    produces:
>+    - application/json
>+    responses:
>+      '201':
>+        description: Transfer limit added
>+        schema:
>+          "$ref": "../definitions.json#/transfer_limit"
>+      '400':
>+        description: Bad request
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '401':
>+        description: Authentication required
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '403':
>+        description: Access forbidden
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '409':
>+        description: Conflict in creating resource
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '500':
>+        description: Internal error
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '503':
>+        description: Under maintenance
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+    x-koha-authorization:
>+      permissions:
>+        parameters: manage_transfers
>+"/transfer_limits/{limit_id}":
>+  delete:
>+    x-mojo-to: TransferLimits#delete
>+    operationId: deleteTransferLimit
>+    tags:
>+    - transfer
>+    parameters:
>+    - "$ref": "../parameters.json#/transfer_limit_id_pp"
>+    produces:
>+    - application/json
>+    responses:
>+      '204':
>+        description: Transfer limit deleted
>+        schema:
>+          type: string
>+      '401':
>+        description: Authentication required
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '403':
>+        description: Access forbidden
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '404':
>+        description: Library not found
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '500':
>+        description: Internal error
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '503':
>+        description: Under maintenance
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+    x-koha-authorization:
>+      permissions:
>+        parameters: manage_transfers
>+"/transfer_limits/batch":
>+  post:
>+    x-mojo-to: TransferLimits#batch_add
>+    operationId: batchAddTransferLimits
>+    tags:
>+    - transfer
>+    parameters:
>+    - name: body
>+      in: body
>+      description: A JSON object containing information about new transfer limits.
>+      required: true
>+      schema:
>+        type: object
>+        properties:
>+          to_library_id:
>+            type: string
>+            description: Internal library id for which library the item is going to
>+          from_library_id:
>+            type: string
>+            description: Internal library id for which library the item is coming
>+              from
>+          item_type:
>+            type:
>+            - string
>+            - 'null'
>+            description: Itemtype defining the type for this limi
>+          collection_code:
>+            type:
>+            - string
>+            - 'null'
>+            description: Authorized value for the collection code associated with
>+              this limit
>+        additionalProperties: false
>+    produces:
>+    - application/json
>+    responses:
>+      '201':
>+        description: A list of transfer limits
>+        schema:
>+          type: array
>+          items:
>+            "$ref": "../definitions.json#/transfer_limit"
>+      '500':
>+        description: Internal error
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '503':
>+        description: Under maintenance
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+    x-koha-authorization:
>+      permissions:
>+        parameters: manage_transfers
>+  delete:
>+    x-mojo-to: TransferLimits#batch_delete
>+    operationId: batchDeleteTransferLimits
>+    tags:
>+    - transfer
>+    parameters:
>+    - name: body
>+      in: body
>+      description: A JSON object containing information about new transfer limits.
>+      required: true
>+      schema:
>+        type: object
>+        properties:
>+          to_library_id:
>+            type: string
>+            description: Internal library id for which library the item is going to
>+          from_library_id:
>+            type: string
>+            description: Internal library id for which library the item is coming
>+              from
>+          item_type:
>+            type:
>+            - string
>+            - 'null'
>+            description: Itemtype defining the type for this limi
>+          collection_code:
>+            type:
>+            - string
>+            - 'null'
>+            description: Authorized value for the collection code associated with
>+              this limit
>+        additionalProperties: false
>+    produces:
>+    - application/json
>+    responses:
>+      '204':
>+        description: Transfer limits deleted
>+        schema:
>+          type: string
>+      '401':
>+        description: Authentication required
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '403':
>+        description: Access forbidden
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '404':
>+        description: Library not found
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '500':
>+        description: Internal error
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+      '503':
>+        description: Under maintenance
>+        schema:
>+          "$ref": "../definitions.json#/error"
>+    x-koha-authorization:
>+      permissions:
>+        parameters: manage_transfers
>-- 
>2.11.0

Actions: View | Diff | Splinter Review

Attachments on bug 26633: 111380 | 111381 | 112327 | 112328 | 112330 | 112437 | 112438 | 112587 | 112778 | 112779 | 112780 | 112781 | 112782 | 112923 | 112924 | 112925 | 112926 | 112927 | 112928 | 112929 | 113053 | 113265 | 113266 | 113267 | 113268 | 113269 | 113270 | 113271 | 113272 | 113273 | 113274 | 113275 | 113676 | 113677 | 113961 | 116612 | 116613 | 116952 | 116953 | 116954 | 116955 | 116956 | 116957 | 116958 | 116959 | 116960 | 116961 | 116962 | 116963 | 116964