Browse Source

Bug 16699: Split parameters and paths in Swagger

Parameters and paths should be split in our Swagger specification, because
otherwise swagger.json would become messy with all the paths and their
further specification in the same file. Also parameters should be split
for the same reason.

Instead of using index.json for definitions, parameters and paths, we define
new files "definitions.json", "parameters.json" and "paths.json" in order to
simplify the references. If we kept using index.json and try to reference
"/definitions/error.json" from "/paths/holds.json", reference would be
"../definitions/index.json#/error" instead of now simplified version,
"../definitions.json#/error".

Here is the proposed structure:

.
├── swagger.json
├── definitions.json
├── paths.json
├── parameters.json
├── definitions
│   └── error.json
│   └── patron.json
├── parameters
│   └── patron.json
├── paths
│   └── patrons.json
├── minifySwagger.pl
└── swagger.min.js

The swagger.json paths, definitions and parameters will look as follows:
...
  "paths": {
    "$ref": "paths.json"
  },
  "definitions": {
    "$ref": "definitions.json"
  },
  "parameters": {
    "$ref": "parameters.json"
  }
...

A problem with splitting specification into multiple files directly from
swagger.json (e.g. "paths": { "$ref": "paths.json" }) is that it is not
following the Swagger specification and an error will be thrown by the
Swagger-UI default validator (online.swagger.io/validator).

To overcome this problem, we use the minifySwagger.pl script from Buug 16212.
This allows the developers to work with the structure introduced in this patch
thus allowing developers to split the specification nicely, and still have a
valid Swagger specification in the minified swagger.min.json.

To test:
-2: Apply the minifier-patch in Buug 16212.
-1: Make sure you can validate your specification with Swagger2 validator at
    online.swagger.io/validator/debug?url=url_to_swaggerjson, or install it
    locally from https://github.com/swagger-api/validator-badge.

1. Don't apply this patch yet, but first validate swagger.json
   with swagger.io-validator (or your local version, if you installed it)
2. Observe that validation errors are given
3. Run minifySwagger.pl
4. Validate swagger.min.json with the validator you used in step 1
5. Observe that validation passes and we overcame the invalid specification
   problem in swagger.min.json
6. Apply this patch
7. Run minifySwagger.pl
8. Repeat step 4
9. Observe that validation passes with new structure
10. Run REST tests at t/db_dependents/api/v1

(11. Study the new structure of our Swagger specifications :))

Signed-off-by: Olli-Antti Kivilahti <olli-antti.kivilahti@jns.fi>

My name is Olli-Antti Kivilahti and I approve this commit.
We have been using the Swagger2.0-driven REST API on Mojolicious for 1 year now
in production and I am certain we have a pretty good idea on how to work with
the limitations of Swagger2.0
We participated in the development of the Mojolicious::Plugin::Swagger and know
it well. We have made an extension to the plugin to provide full CORS support
and have been building all our in-house features on the new REST API.

Signed-off-by: Johanna Raisa <johanna.raisa@gmail.com>

My name is Johanna Räisä and I approve this commit.
We have been using Swagger2.0-driven REST API in production successfully.

Signed-off-by: Benjamin Rokseth <benjamin.rokseth@kul.oslo.kommune.no>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
16.11.x
Lari Taskula 7 years ago
committed by Kyle M Hall
parent
commit
0eaf72ab26
  1. 14
      api/v1/definitions.json
  2. 6
      api/v1/definitions/index.json
  3. 8
      api/v1/parameters.json
  4. 9
      api/v1/parameters/hold.json
  5. 9
      api/v1/parameters/patron.json
  6. 14
      api/v1/paths.json
  7. 283
      api/v1/paths/holds.json
  8. 61
      api/v1/paths/patrons.json
  9. 337
      api/v1/swagger.json

14
api/v1/definitions.json

@ -0,0 +1,14 @@
{
"patron": {
"$ref": "definitions/patron.json"
},
"holds": {
"$ref": "definitions/holds.json"
},
"hold": {
"$ref": "definitions/hold.json"
},
"error": {
"$ref": "definitions/error.json"
}
}

6
api/v1/definitions/index.json

@ -1,6 +0,0 @@
{
"patron": { "$ref": "patron.json" },
"holds": { "$ref": "holds.json" },
"hold": { "$ref": "hold.json" },
"error": { "$ref": "error.json" }
}

8
api/v1/parameters.json

@ -0,0 +1,8 @@
{
"borrowernumberPathParam": {
"$ref": "parameters/patron.json#/borrowernumberPathParam"
},
"holdIdPathParam": {
"$ref": "parameters/hold.json#/holdIdPathParam"
}
}

9
api/v1/parameters/hold.json

@ -0,0 +1,9 @@
{
"holdIdPathParam": {
"name": "reserve_id",
"in": "path",
"description": "Internal hold identifier",
"required": true,
"type": "integer"
}
}

9
api/v1/parameters/patron.json

@ -0,0 +1,9 @@
{
"borrowernumberPathParam": {
"name": "borrowernumber",
"in": "path",
"description": "Internal patron identifier",
"required": true,
"type": "integer"
}
}

14
api/v1/paths.json

@ -0,0 +1,14 @@
{
"/holds": {
"$ref": "paths/holds.json#/~1holds"
},
"/holds/{reserve_id}": {
"$ref": "paths/holds.json#/~1holds~1{reserve_id}"
},
"/patrons": {
"$ref": "paths/patrons.json#/~1patrons"
},
"/patrons/{borrowernumber}": {
"$ref": "paths/patrons.json#/~1patrons~1{borrowernumber}"
}
}

283
api/v1/paths/holds.json

@ -0,0 +1,283 @@
{
"/holds": {
"get": {
"operationId": "listHolds",
"tags": ["borrowers", "holds"],
"parameters": [
{
"name": "reserve_id",
"in": "query",
"description": "Internal reserve identifier",
"type": "integer"
},
{
"name": "borrowernumber",
"in": "query",
"description": "Internal borrower identifier",
"type": "integer"
},
{
"name": "reservedate",
"in": "query",
"description": "Reserve date",
"type": "string"
},
{
"name": "biblionumber",
"in": "query",
"description": "Internal biblio identifier",
"type": "integer"
},
{
"name": "branchcode",
"in": "query",
"description": "Branch code",
"type": "string"
},
{
"name": "notificationdate",
"in": "query",
"description": "Notification date",
"type": "string"
},
{
"name": "reminderdate",
"in": "query",
"description": "Reminder date",
"type": "string"
},
{
"name": "cancellationdate",
"in": "query",
"description": "Cancellation date",
"type": "string"
},
{
"name": "reservenotes",
"in": "query",
"description": "Reserve notes",
"type": "string"
},
{
"name": "priority",
"in": "query",
"description": "Priority",
"type": "integer"
},
{
"name": "found",
"in": "query",
"description": "Found status",
"type": "string"
},
{
"name": "timestamp",
"in": "query",
"description": "Time of latest update",
"type": "string"
},
{
"name": "itemnumber",
"in": "query",
"description": "Internal item identifier",
"type": "integer"
},
{
"name": "waitingdate",
"in": "query",
"description": "Date the item was marked as waiting for the patron",
"type": "string"
},
{
"name": "expirationdate",
"in": "query",
"description": "Date the hold expires",
"type": "string"
},
{
"name": "lowestPriority",
"in": "query",
"description": "Lowest priority",
"type": "integer"
},
{
"name": "suspend",
"in": "query",
"description": "Suspended",
"type": "integer"
},
{
"name": "suspend_until",
"in": "query",
"description": "Suspended until",
"type": "string"
}
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "A list of holds",
"schema": {
"$ref": "../definitions.json#/holds"
}
},
"404": {
"description": "Borrower not found",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
},
"post": {
"operationId": "addHold",
"tags": ["borrowers", "holds"],
"parameters": [{
"name": "body",
"in": "body",
"description": "A JSON object containing informations about the new hold",
"required": true,
"schema": {
"type": "object",
"properties": {
"borrowernumber": {
"description": "Borrower internal identifier",
"type": "integer"
},
"biblionumber": {
"description": "Biblio internal identifier",
"type": "integer"
},
"itemnumber": {
"description": "Item internal identifier",
"type": "integer"
},
"branchcode": {
"description": "Pickup location",
"type": "string"
},
"expirationdate": {
"description": "Hold end date",
"type": "string",
"format": "date"
}
}
}
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"201": {
"description": "Created hold",
"schema": {
"$ref": "../definitions.json#/hold"
}
},
"400": {
"description": "Missing or wrong parameters",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"403": {
"description": "Hold not allowed",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Borrower not found",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"500": {
"description": "Internal error",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
}
},
"/holds/{reserve_id}": {
"put": {
"operationId": "editHold",
"tags": ["holds"],
"parameters": [{
"$ref": "../parameters.json#/holdIdPathParam"
}, {
"name": "body",
"in": "body",
"description": "A JSON object containing fields to modify",
"required": true,
"schema": {
"type": "object",
"properties": {
"priority": {
"description": "Position in waiting queue",
"type": "integer",
"minimum": 1
},
"branchcode": {
"description": "Pickup location",
"type": "string"
},
"suspend_until": {
"description": "Suspend until",
"type": "string",
"format": "date"
}
}
}
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"200": {
"description": "Updated hold",
"schema": {
"$ref": "../definitions.json#/hold"
}
},
"400": {
"description": "Missing or wrong parameters",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Hold not found",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
},
"delete": {
"operationId": "deleteHold",
"tags": ["holds"],
"parameters": [{
"$ref": "../parameters.json#/holdIdPathParam"
}
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "Successful deletion",
"schema": {
"type": "object"
}
},
"404": {
"description": "Hold not found",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
}
}
}

61
api/v1/paths/patrons.json

@ -0,0 +1,61 @@
{
"/patrons": {
"get": {
"operationId": "listPatrons",
"tags": ["patrons"],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of patrons",
"schema": {
"type": "array",
"items": {
"$ref": "../definitions.json#/patron"
}
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
}
},
"/patrons/{borrowernumber}": {
"get": {
"operationId": "getPatron",
"tags": ["patrons"],
"parameters": [{
"$ref": "../parameters.json#/borrowernumberPathParam"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A patron",
"schema": {
"$ref": "../definitions.json#/patron"
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "../definitions.json#/error"
}
},
"404": {
"description": "Patron not found",
"schema": {
"$ref": "../definitions.json#/error"
}
}
}
}
}
}

337
api/v1/swagger.json

@ -14,343 +14,12 @@
},
"basePath": "/api/v1",
"paths": {
"/patrons": {
"get": {
"operationId": "listPatrons",
"tags": ["patrons"],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of patrons",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/patron"
}
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "#/definitions/error"
}
}
}
}
},
"/patrons/{borrowernumber}": {
"get": {
"operationId": "getPatron",
"tags": ["patrons"],
"parameters": [
{
"$ref": "#/parameters/borrowernumberPathParam"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A patron",
"schema": {
"$ref": "#/definitions/patron"
}
},
"403": {
"description": "Access forbidden",
"schema": {
"$ref": "#/definitions/error"
}
},
"404": {
"description": "Patron not found",
"schema": {
"$ref": "#/definitions/error"
}
}
}
}
},
"/holds": {
"get": {
"operationId": "listHolds",
"tags": ["borrowers", "holds"],
"parameters": [
{
"name": "reserve_id",
"in": "query",
"description": "Internal reserve identifier",
"type": "integer"
},
{
"name": "borrowernumber",
"in": "query",
"description": "Internal borrower identifier",
"type": "integer"
},
{
"name": "reservedate",
"in": "query",
"description": "Reserve date",
"type": "string"
},
{
"name": "biblionumber",
"in": "query",
"description": "Internal biblio identifier",
"type": "integer"
},
{
"name": "branchcode",
"in": "query",
"description": "Branch code",
"type": "string"
},
{
"name": "notificationdate",
"in": "query",
"description": "Notification date",
"type": "string"
},
{
"name": "reminderdate",
"in": "query",
"description": "Reminder date",
"type": "string"
},
{
"name": "cancellationdate",
"in": "query",
"description": "Cancellation date",
"type": "string"
},
{
"name": "reservenotes",
"in": "query",
"description": "Reserve notes",
"type": "string"
},
{
"name": "priority",
"in": "query",
"description": "Priority",
"type": "integer"
},
{
"name": "found",
"in": "query",
"description": "Found status",
"type": "string"
},
{
"name": "timestamp",
"in": "query",
"description": "Time of latest update",
"type": "string"
},
{
"name": "itemnumber",
"in": "query",
"description": "Internal item identifier",
"type": "integer"
},
{
"name": "waitingdate",
"in": "query",
"description": "Date the item was marked as waiting for the patron",
"type": "string"
},
{
"name": "expirationdate",
"in": "query",
"description": "Date the hold expires",
"type": "string"
},
{
"name": "lowestPriority",
"in": "query",
"description": "Lowest priority",
"type": "integer"
},
{
"name": "suspend",
"in": "query",
"description": "Suspended",
"type": "integer"
},
{
"name": "suspend_until",
"in": "query",
"description": "Suspended until",
"type": "string"
}
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "A list of holds",
"schema": { "$ref": "#/definitions/holds" }
},
"404": {
"description": "Borrower not found",
"schema": { "$ref": "#/definitions/error" }
}
}
},
"post": {
"operationId": "addHold",
"tags": ["borrowers", "holds"],
"parameters": [
{
"name": "body",
"in": "body",
"description": "A JSON object containing informations about the new hold",
"required": true,
"schema": {
"type": "object",
"properties": {
"borrowernumber": {
"description": "Borrower internal identifier",
"type": "integer"
},
"biblionumber": {
"description": "Biblio internal identifier",
"type": "integer"
},
"itemnumber": {
"description": "Item internal identifier",
"type": "integer"
},
"branchcode": {
"description": "Pickup location",
"type": "string"
},
"expirationdate": {
"description": "Hold end date",
"type": "string",
"format": "date"
}
}
}
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"201": {
"description": "Created hold",
"schema": { "$ref": "#/definitions/hold" }
},
"400": {
"description": "Missing or wrong parameters",
"schema": { "$ref": "#/definitions/error" }
},
"403": {
"description": "Hold not allowed",
"schema": { "$ref": "#/definitions/error" }
},
"404": {
"description": "Borrower not found",
"schema": { "$ref": "#/definitions/error" }
},
"500": {
"description": "Internal error",
"schema": { "$ref": "#/definitions/error" }
}
}
}
},
"/holds/{reserve_id}": {
"put": {
"operationId": "editHold",
"tags": ["holds"],
"parameters": [
{ "$ref": "#/parameters/holdIdPathParam" },
{
"name": "body",
"in": "body",
"description": "A JSON object containing fields to modify",
"required": true,
"schema": {
"type": "object",
"properties": {
"priority": {
"description": "Position in waiting queue",
"type": "integer",
"minimum": 1
},
"branchcode": {
"description": "Pickup location",
"type": "string"
},
"suspend_until": {
"description": "Suspend until",
"type": "string",
"format": "date"
}
}
}
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"responses": {
"200": {
"description": "Updated hold",
"schema": { "$ref": "#/definitions/hold" }
},
"400": {
"description": "Missing or wrong parameters",
"schema": { "$ref": "#/definitions/error" }
},
"404": {
"description": "Hold not found",
"schema": { "$ref": "#/definitions/error" }
}
}
},
"delete": {
"operationId": "deleteHold",
"tags": ["holds"],
"parameters": [
{ "$ref": "#/parameters/holdIdPathParam" }
],
"produces": ["application/json"],
"responses": {
"200": {
"description": "Successful deletion",
"schema": {
"type": "object"
}
},
"404": {
"description": "Hold not found",
"schema": { "$ref": "#/definitions/error" }
}
}
}
}
"$ref": "paths.json"
},
"definitions": {
"$ref": "./definitions/index.json"
"$ref": "definitions.json"
},
"parameters": {
"borrowernumberPathParam": {
"name": "borrowernumber",
"in": "path",
"description": "Internal patron identifier",
"required": true,
"type": "integer"
},
"holdIdPathParam": {
"name": "reserve_id",
"in": "path",
"description": "Internal hold identifier",
"required": true,
"type": "integer"
}
"$ref": "parameters.json"
}
}

Loading…
Cancel
Save