From 02ba1f9475772918c1751082d3e224d08fe22888 Mon Sep 17 00:00:00 2001 From: Martin Renvoize Date: Wed, 7 Oct 2015 15:20:25 +0000 Subject: [PATCH] Bug 13799 - Followup: Refactor spec file Spreading the specification over multiple files should lead to a more manageable specification long term --- api/v1/definitions/borrower.json | 21 +++++++++++++++++++++ api/v1/definitions/error.json | 9 +++++++++ api/v1/definitions/index.json | 4 ++++ api/v1/swagger.json | 30 +----------------------------- 4 files changed, 35 insertions(+), 29 deletions(-) create mode 100644 api/v1/definitions/borrower.json create mode 100644 api/v1/definitions/error.json create mode 100644 api/v1/definitions/index.json diff --git a/api/v1/definitions/borrower.json b/api/v1/definitions/borrower.json new file mode 100644 index 0000000..0523d4b --- /dev/null +++ b/api/v1/definitions/borrower.json @@ -0,0 +1,21 @@ +{ + "type": "object", + "properties": { + "borrowernumber": { + "type": "integer", + "description": "Internally assigned user identifier" + }, + "cardnumber": { + "type": "string", + "description": "Library assigned user identifier" + }, + "surname": { + "type": "string", + "description": "User's last name" + }, + "firstname": { + "type": "string", + "description": "User's first name" + } + } +} diff --git a/api/v1/definitions/error.json b/api/v1/definitions/error.json new file mode 100644 index 0000000..e43673f --- /dev/null +++ b/api/v1/definitions/error.json @@ -0,0 +1,9 @@ +{ + "type": "object", + "properties": { + "error": { + "description": "Error message", + "type": "string" + } + } +} diff --git a/api/v1/definitions/index.json b/api/v1/definitions/index.json new file mode 100644 index 0000000..719e5cb --- /dev/null +++ b/api/v1/definitions/index.json @@ -0,0 +1,4 @@ +{ + "borrower": "borrower.json", + "error": "error.json" +} diff --git a/api/v1/swagger.json b/api/v1/swagger.json index e7e61ee..d9466e4 100644 --- a/api/v1/swagger.json +++ b/api/v1/swagger.json @@ -76,35 +76,7 @@ } }, "definitions": { - "borrower": { - "type": "object", - "properties": { - "borrowernumber": { - "$ref": "#/definitions/borrowernumber" - }, - "cardnumber": { - "description": "library assigned ID number for borrowers" - }, - "surname": { - "description": "borrower's last name" - }, - "firstname": { - "description": "borrower's first name" - } - } - }, - "borrowernumber": { - "description": "Borrower internal identifier" - }, - "error": { - "type": "object", - "properties": { - "error": { - "description": "Error message", - "type": "string" - } - } - } + "$ref": "./definitions/index.json" }, "parameters": { "borrowernumberPathParam": { -- 2.1.4