@tryghost/admin-api-schema 2.15.0 → 3.0.0

package/lib/{canary → schemas}/tiers.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tiers.canary",
+  "$id": "tiers",
   "title": "tiers",
   "description": "Base Tier definitions",
   "definitions": {
@@ -9,12 +9,15 @@
       "type": "object",
       "additionalProperties": false,
       "properties": {
+        "id": {
+          "strip": true
+        },
         "name": {
           "type": "string",
           "maxLength": 191
         },
         "description": {
-          "type": "string",
+          "type": ["string", "null"],
           "maxLength": 191
         },
         "slug": {

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.add.v3",
+  "$id": "webhooks.add",
   "title": "webhooks.add",
   "description": "Schema for webhooks.add",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "webhooks.v3#/definitions/webhook" }],
+        "allOf": [{ "$ref": "webhooks#/definitions/webhook" }],
         "required": ["event", "target_url"]
       }
     }

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

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "webhooks.edit.v3",
+  "$id": "webhooks.edit",
   "title": "webhooks.edit",
   "description": "Schema for webhooks.edit",
   "type": "object",

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/admin-api-schema",
-  "version": "2.15.0",
+  "version": "3.0.0",
   "repository": "https://github.com/TryGhost/SDK/tree/master/packages/admin-api-schema",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -22,11 +22,11 @@
     "c8": "7.11.2",
     "mocha": "10.0.0",
     "should": "13.2.3",
-    "sinon": "13.0.2"
+    "sinon": "14.0.0"
   },
   "dependencies": {
     "@tryghost/errors": "^1.0.0",
     "lodash": "^4.17.11"
   },
-  "gitHead": "1b8c08ab41c317f79bff2b1be65fab6ee638d9d5"
+  "gitHead": "460d932f6ebbe80fb3513f937db65925a7874ae0"
 }

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/members-upload.json

@@ -1,48 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.upload.canary",
-  "title": "members.upload",
-  "description": "Schema for members.upload",
-  "type": "array",
-  "items": {
-    "type": "object",
-    "additionalProperties": true,
-    "required": ["email"],
-    "properties": {
-      "name": {
-        "type": ["string", "null"],
-        "maxLength": 191,
-        "pattern": "^([^,]|$)"
-      },
-      "email": {
-        "type": "string",
-        "minLength": 1,
-        "maxLength": 191,
-        "pattern": "^([^,]|$)"
-      },
-      "note": {
-        "type": ["string", "null"],
-        "minLength": 0,
-        "maxLength": 2000
-      },
-      "subscribed": {
-        "type": ["string", "null"],
-        "enum": ["true", "false", "TRUE", "FALSE", "", null]
-      },
-      "labels": {
-        "type": ["string", "null"]
-      },
-      "created_at": {
-        "type": ["string", "null"],
-        "format": "date-time"
-      },
-      "stripe_customer_id": {
-        "type": ["string", "null"]
-      },
-      "complimentary_plan": {
-        "type": ["string", "null"],
-        "enum": ["true", "false", "TRUE", "FALSE", "", null]
-      }
-    }
-  }
-}

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"]
-}