@tryghost/admin-api-schema 2.17.0 → 3.2.0

package/lib/{v3 → schemas}/webhooks.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.v3",
+  "$id": "webhooks",
   "title": "webhooks",
   "description": "Base webhooks definitions",
   "definitions": {

package/lib/utils/json-schema.js

@@ -7,6 +7,7 @@ const errors = require('@tryghost/errors');
 const ajv = new Ajv({
     allErrors: true,
     useDefaults: true,
+    removeAdditional: true,
     formats: {
         'json-string': (data) => {
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/admin-api-schema",
-  "version": "2.17.0",
+  "version": "3.2.0",
   "repository": "https://github.com/TryGhost/SDK/tree/master/packages/admin-api-schema",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -28,5 +28,5 @@
     "@tryghost/errors": "^1.0.0",
     "lodash": "^4.17.11"
   },
-  "gitHead": "dd641499aeaaae6f491cc55e0f37be400f300a3c"
+  "gitHead": "12de80df035edcb0d174cdab5d6ba7da67c19f3d"
 }

package/lib/canary/images-upload.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "images.upload.canary",
-  "title": "images.upload",
-  "description": "Schema for images.upload",
-  "$ref": "images.canary#/definitions/image"
-}

package/lib/canary/images.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "images.canary",
-  "title": "images",
-  "description": "Base images definitions",
-  "definitions": {
-    "image": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "purpose": {
-          "type": "string",
-          "enum": ["image", "profile_image", "icon"],
-          "default": "image"
-        },
-        "ref": {
-          "type": ["string", "null"],
-          "maxLength": 2000
-        }
-      }
-    }
-  }
-}

package/lib/canary/labels-add.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.add.canary",
-  "title": "labels.add",
-  "description": "Schema for labels.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "labels": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "additionalProperties": false,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "labels.canary#/definitions/label" }],
-        "required": ["name"]
-      }
-    }
-  },
-  "required": ["labels"]
-}

package/lib/canary/labels-edit.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.edit.canary",
-  "title": "labels.edit",
-  "description": "Schema for labels.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "labels": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": { "$ref": "labels.canary#/definitions/label" }
-    }
-  },
-  "required": ["labels"]
-}

package/lib/canary/labels.json

@@ -1,39 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.canary",
-  "title": "labels",
-  "description": "Base labels definitions",
-  "definitions": {
-    "label": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "name": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 191,
-          "pattern": "^([^,]|$)"
-        },
-        "slug": {
-          "type": ["string", "null"],
-          "maxLength": 191
-        },
-        "id": {
-          "strip": true
-        },
-        "created_at": {
-          "strip": true
-        },
-        "created_by": {
-          "strip": true
-        },
-        "updated_at": {
-          "strip": true
-        },
-        "updated_by": {
-          "strip": true
-        }
-      }
-    }
-  }
-}

package/lib/canary/members-add.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.add.canary",
-  "title": "members.add",
-  "description": "Schema for members.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "members": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "members.canary#/definitions/member" }],
-        "required": ["email"]
-      }
-    }
-  },
-  "required": ["members"]
-}

package/lib/canary/pages-add.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "pages.add.canary",
-  "title": "pages.add",
-  "description": "Schema for pages.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "pages": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "pages.canary#/definitions/page" }],
-        "required": ["title"]
-      }
-    }
-  },
-  "required": ["pages"]
-}

package/lib/canary/pages-edit.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "pages.edit.canary",
-  "title": "pages.edit",
-  "description": "Schema for pages.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "pages": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "pages.canary#/definitions/page" }],
-        "required": ["updated_at"]
-      }
-    }
-  },
-  "required": ["pages"]
-}

package/lib/canary/posts-add.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "posts.add.canary",
-  "title": "posts.add",
-  "description": "Schema for posts.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "posts": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "posts.canary#/definitions/post" }],
-        "required": ["title"]
-      }
-    }
-  },
-  "required": ["posts"]
-}

package/lib/canary/posts-edit.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "posts.edit.canary",
-  "title": "posts.edit",
-  "description": "Schema for posts.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "posts": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "posts.canary#/definitions/post" }],
-        "required": ["updated_at"]
-      }
-    }
-  },
-  "required": ["posts"]
-}

package/lib/canary/snippets-add.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.add.canary",
-  "title": "snippets.add",
-  "description": "Schema for snippets.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "snippets": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "additionalProperties": false,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "snippets.canary#/definitions/snippet" }],
-        "required": ["name", "mobiledoc"]
-      }
-    }
-  },
-  "required": ["snippets"]
-}

package/lib/canary/snippets-edit.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.edit.canary",
-  "title": "snippets.edit",
-  "description": "Schema for snippets.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "snippets": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "additionalProperties": false,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "snippets.canary#/definitions/snippet" }],
-        "required": ["name", "mobiledoc"]
-      }
-    }
-  },
-  "required": ["snippets"]
-}

package/lib/canary/snippets.json

@@ -1,39 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.canary",
-  "title": "snippets",
-  "description": "Base snippets definitions",
-  "definitions": {
-    "snippet": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "name": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 191
-        },
-        "mobiledoc": {
-          "type": "string",
-          "format": "json-string",
-          "maxLength": 1000000000
-        },
-        "id": {
-          "strip": true
-        },
-        "created_at": {
-          "strip": true
-        },
-        "created_by": {
-          "strip": true
-        },
-        "updated_at": {
-          "strip": true
-        },
-        "updated_by": {
-          "strip": true
-        }
-      }
-    }
-  }
-}

package/lib/canary/tags-add.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.add.canary",
-  "title": "tags.add",
-  "description": "Schema for tags.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "tags": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "additionalProperties": false,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "tags.canary#/definitions/tag" }],
-        "required": ["name"]
-      }
-    }
-  },
-  "required": ["tags"]
-}

package/lib/canary/tags-edit.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.edit.canary",
-  "title": "tags.edit",
-  "description": "Schema for tags.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "tags": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": { "$ref": "tags.canary#/definitions/tag" }
-    }
-  },
-  "required": ["tags"]
-}

package/lib/canary/tags.json

@@ -1,112 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.canary",
-  "title": "tags",
-  "description": "Base tags definitions",
-  "definitions": {
-    "tag": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "name": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 191,
-          "pattern": "^([^,]|$)"
-        },
-        "slug": {
-          "type": ["string", "null"],
-          "maxLength": 191
-        },
-        "description": {
-          "type": ["string", "null"],
-          "maxLength": 500
-        },
-        "feature_image": {
-          "type": ["string", "null"],
-          "format": "uri-reference",
-          "maxLength": 2000
-        },
-        "visibility": {
-          "type": "string",
-          "enum": ["public", "internal"]
-        },
-        "meta_title": {
-          "type": ["string", "null"],
-          "maxLength": 300
-        },
-        "meta_description": {
-          "type": ["string", "null"],
-          "maxLength": 500
-        },
-        "og_image": {
-          "type": ["string", "null"],
-          "format": "uri-reference",
-          "maxLength": 2000
-        },
-        "og_title": {
-          "type": ["string", "null"],
-          "maxLength": 300
-        },
-        "og_description": {
-          "type": ["string", "null"],
-          "maxLength": 500
-        },
-        "twitter_image": {
-          "type": ["string", "null"],
-          "format": "uri-reference",
-          "maxLength": 2000
-        },
-        "twitter_title": {
-          "type": ["string", "null"],
-          "maxLength": 300
-        },
-        "twitter_description": {
-          "type": ["string", "null"],
-          "maxLength": 500
-        },
-        "codeinjection_head": {
-          "type": ["string", "null"],
-          "maxLength": 65535
-        },
-        "codeinjection_foot": {
-          "type": ["string", "null"],
-          "maxLength": 65535
-        },
-        "canonical_url": {
-          "type": ["string", "null"],
-          "format": "uri-reference",
-          "maxLength": 2000
-        },
-        "accent_color": {
-          "type": ["string", "null"],
-          "maxLength": 50
-        },
-        "id": {
-          "strip": true
-        },
-        "parent": {
-          "strip": true
-        },
-        "parent_id": {
-          "strip": true
-        },
-        "created_at": {
-          "strip": true
-        },
-        "created_by": {
-          "strip": true
-        },
-        "updated_at": {
-          "strip": true
-        },
-        "updated_by": {
-          "strip": true
-        },
-        "url": {
-          "strip": true
-        }
-      }
-    }
-  }
-}

package/lib/canary/webhooks-add.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.add.canary",
-  "title": "webhooks.add",
-  "description": "Schema for webhooks.add",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "webhooks": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "allOf": [{ "$ref": "webhooks.canary#/definitions/webhook" }],
-        "required": ["event", "target_url"]
-      }
-    }
-  },
-  "required": ["webhooks"]
-}

package/lib/canary/webhooks-edit.json

@@ -1,74 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.edit.canary",
-  "title": "webhooks.edit",
-  "description": "Schema for webhooks.edit",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "webhooks": {
-      "type": "array",
-      "minItems": 1,
-      "maxItems": 1,
-      "items": {
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "event": {
-            "type": "string",
-            "maxLength": 50,
-            "isLowercase": true
-          },
-          "target_url": {
-            "type": "string",
-            "format": "uri-reference",
-            "maxLength": 2000
-          },
-          "name": {
-            "type": ["string", "null"],
-            "maxLength": 191
-          },
-          "secret": {
-            "type": ["string", "null"],
-            "maxLength": 191
-          },
-          "api_version": {
-            "type": ["string", "null"],
-            "maxLength": 50
-          },
-          "integration_id": {
-            "strip": true
-          },
-          "id": {
-            "strip": true
-          },
-          "status": {
-            "strip": true
-          },
-          "last_triggered_at": {
-            "strip": true
-          },
-          "last_triggered_status": {
-            "strip": true
-          },
-          "last_triggered_error": {
-            "strip": true
-          },
-          "created_at": {
-            "strip": true
-          },
-          "created_by": {
-            "strip": true
-          },
-          "updated_at": {
-            "strip": true
-          },
-          "updated_by": {
-            "strip": true
-          }
-        }
-      }
-    }
-  },
-  "required": ["webhooks"]
-}

package/lib/canary/webhooks.json

@@ -1,67 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.canary",
-  "title": "webhooks",
-  "description": "Base webhooks definitions",
-  "definitions": {
-    "webhook": {
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "event": {
-          "type": "string",
-          "maxLength": 50,
-          "isLowercase": true
-        },
-        "target_url": {
-          "type": "string",
-          "format": "uri-reference",
-          "maxLength": 2000
-        },
-        "name": {
-          "type": ["string", "null"],
-          "maxLength": 191
-        },
-        "secret": {
-          "type": ["string", "null"],
-          "maxLength": 191
-        },
-        "api_version": {
-          "type": ["string", "null"],
-          "maxLength": 50
-        },
-        "integration_id": {
-          "type": ["string", "null"],
-          "maxLength": 24
-        },
-        "id": {
-          "strip": true
-        },
-        "status": {
-          "strip": true
-        },
-        "last_triggered_at": {
-          "strip": true
-        },
-        "last_triggered_status": {
-          "strip": true
-        },
-        "last_triggered_error": {
-          "strip": true
-        },
-        "created_at": {
-          "strip": true
-        },
-        "created_by": {
-          "strip": true
-        },
-        "updated_at": {
-          "strip": true
-        },
-        "updated_by": {
-          "strip": true
-        }
-      }
-    }
-  }
-}

package/lib/v2/README.md

@@ -1,8 +0,0 @@
-# JSON Schema structuring convention
-
-When adding a new schema or definition following naming convention should be followed:
-1. Name the file containing JSON definitions in the same way as resource is named in the API (aka "docName" in controller config). For example, for [tags](https://github.com/TryGhost/Ghost/blob/2a921b86598184fcd5a2d95fefae4283bba1042a/core/server/api/canary/tags.js#L9) the definitions file would be `tags.json`
-2. Name the file containing JSON schema (which usually references "definitions") using following convention `{resourceName}-{methodName}.json`. For example, for [tags.edit](https://github.com/TryGhost/Ghost/blob/master/core/server/api/canary/tags.js#L89) method file would be named `tags-edit.json`
-3. Update `index.js` list with a new definition name
-
-The need to have separate "definitions" and "schema" files comes from [schema reusability pattern](https://cswr.github.io/JsonSchema/spec/definitions_references/) that JSON schema allows for through $ref keyword. In some cases, the pattern doesn't quite work out because of limitations of the syntax (cannot override parts of referenced definition). Generally try to reuse as much schema as possible to avoid duplication unless it becomes painful to do so.