Removed use of "canary" in schema names/ids

naz · naz · commit 97935911e7e8 · 2022-05-12T15:21:26.000+08:00
refs https://github.com/TryGhost/Toolbox/issues/314 - "canary" is a artifact of the versioning and should not be used in any bit of the code as there's no such thing as versioning any longer
diff --git a/packages/admin-api-schema/lib/schemas/images-upload.json b/packages/admin-api-schema/lib/schemas/images-upload.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "images.upload.canary",
+  "$id": "images.upload",
   "title": "images.upload",
   "description": "Schema for images.upload",
-  "$ref": "images.canary#/definitions/image"
+  "$ref": "images#/definitions/image"
 }
diff --git a/packages/admin-api-schema/lib/schemas/images.json b/packages/admin-api-schema/lib/schemas/images.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "images.canary",
+  "$id": "images",
   "title": "images",
   "description": "Base images definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/labels-add.json b/packages/admin-api-schema/lib/schemas/labels-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.add.canary",
+  "$id": "labels.add",
   "title": "labels.add",
   "description": "Schema for labels.add",
   "type": "object",
@@ -13,7 +13,7 @@
       "additionalProperties": false,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "labels.canary#/definitions/label" }],
+        "allOf": [{ "$ref": "labels#/definitions/label" }],
         "required": ["name"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/labels-edit.json b/packages/admin-api-schema/lib/schemas/labels-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.edit.canary",
+  "$id": "labels.edit",
   "title": "labels.edit",
   "description": "Schema for labels.edit",
   "type": "object",
@@ -10,7 +10,7 @@
       "type": "array",
       "minItems": 1,
       "maxItems": 1,
-      "items": { "$ref": "labels.canary#/definitions/label" }
+      "items": { "$ref": "labels#/definitions/label" }
     }
   },
   "required": ["labels"]
diff --git a/packages/admin-api-schema/lib/schemas/labels.json b/packages/admin-api-schema/lib/schemas/labels.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "labels.canary",
+  "$id": "labels",
   "title": "labels",
   "description": "Base labels definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/media-upload.json b/packages/admin-api-schema/lib/schemas/media-upload.json
@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "media.upload.canary",
+  "$id": "media.upload",
   "title": "media.upload",
   "description": "Schema for media.upload",
-  "$ref": "media.canary#/definitions/media"
+  "$ref": "media#/definitions/media"
 }
diff --git a/packages/admin-api-schema/lib/schemas/media.json b/packages/admin-api-schema/lib/schemas/media.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "media.canary",
+  "$id": "media",
   "title": "media",
   "description": "Base media definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/members-add.json b/packages/admin-api-schema/lib/schemas/members-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.add.canary",
+  "$id": "members.add",
   "title": "members.add",
   "description": "Schema for members.add",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "members.canary#/definitions/member" }],
+        "allOf": [{ "$ref": "members#/definitions/member" }],
         "required": ["email"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/members-edit.json b/packages/admin-api-schema/lib/schemas/members-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.edit.canary",
+  "$id": "members.edit",
   "title": "members.edit",
   "description": "Schema for members.edit",
   "type": "object",
@@ -46,16 +46,16 @@
             "strip": true
           },
           "products": {
-            "$ref": "members.canary#/definitions/member-products"
+            "$ref": "members#/definitions/member-products"
           },
           "tiers": {
-            "$ref": "members.canary#/definitions/member-products"
+            "$ref": "members#/definitions/member-products"
           },
           "newsletters": {
-            "$ref": "members.canary#/definitions/member-newsletters"
+            "$ref": "members#/definitions/member-newsletters"
           },
           "labels": {
-            "$ref": "members.canary#/definitions/member-labels"
+            "$ref": "members#/definitions/member-labels"
           },
           "email_count": {
             "strip": true
diff --git a/packages/admin-api-schema/lib/schemas/members-upload.json b/packages/admin-api-schema/lib/schemas/members-upload.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.upload.canary",
+  "$id": "members.upload",
   "title": "members.upload",
   "description": "Schema for members.upload",
   "type": "array",
diff --git a/packages/admin-api-schema/lib/schemas/members.json b/packages/admin-api-schema/lib/schemas/members.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "members.canary",
+  "$id": "members",
   "title": "members",
   "description": "Base members definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/pages-add.json b/packages/admin-api-schema/lib/schemas/pages-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "pages.add.canary",
+  "$id": "pages.add",
   "title": "pages.add",
   "description": "Schema for pages.add",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "pages.canary#/definitions/page" }],
+        "allOf": [{ "$ref": "pages#/definitions/page" }],
         "required": ["title"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/pages-edit.json b/packages/admin-api-schema/lib/schemas/pages-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "pages.edit.canary",
+  "$id": "pages.edit",
   "title": "pages.edit",
   "description": "Schema for pages.edit",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "pages.canary#/definitions/page" }],
+        "allOf": [{ "$ref": "pages#/definitions/page" }],
         "required": ["updated_at"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/pages.json b/packages/admin-api-schema/lib/schemas/pages.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "pages.canary",
+  "$id": "pages",
   "title": "pages",
   "description": "Base pages definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/posts-add.json b/packages/admin-api-schema/lib/schemas/posts-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "posts.add.canary",
+  "$id": "posts.add",
   "title": "posts.add",
   "description": "Schema for posts.add",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "posts.canary#/definitions/post" }],
+        "allOf": [{ "$ref": "posts#/definitions/post" }],
         "required": ["title"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/posts-edit.json b/packages/admin-api-schema/lib/schemas/posts-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "posts.edit.canary",
+  "$id": "posts.edit",
   "title": "posts.edit",
   "description": "Schema for posts.edit",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "posts.canary#/definitions/post" }],
+        "allOf": [{ "$ref": "posts#/definitions/post" }],
         "required": ["updated_at"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/posts.json b/packages/admin-api-schema/lib/schemas/posts.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "posts.canary",
+  "$id": "posts",
   "title": "posts",
   "description": "Base posts definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/products-add.json b/packages/admin-api-schema/lib/schemas/products-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "products.add.canary",
+  "$id": "products.add",
   "title": "products.add",
   "description": "Schema for products.add",
   "type": "object",
@@ -11,7 +11,7 @@
       "minItems": 1,
       "maxItems": 1,
       "items": {
-        "type": "products.canary#/definitions/product"
+        "type": "products#/definitions/product"
       }
     }
   },
diff --git a/packages/admin-api-schema/lib/schemas/products-edit.json b/packages/admin-api-schema/lib/schemas/products-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "products.edit.canary",
+  "$id": "products.edit",
   "title": "products.edit",
   "description": "Schema for products.edit",
   "type": "object",
@@ -11,7 +11,7 @@
       "minItems": 1,
       "maxItems": 1,
       "items": {
-        "type": "products.canary#/definitions/product"
+        "type": "products#/definitions/product"
       }
     }
   },
diff --git a/packages/admin-api-schema/lib/schemas/products.json b/packages/admin-api-schema/lib/schemas/products.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "products.canary",
+  "$id": "products",
   "title": "products",
   "description": "Base products definitions",
   "definitions": {
@@ -33,13 +33,13 @@
         "stripe_prices": {
           "type": ["array", "null"],
           "items": {
-            "type": "producs.canary#/definitions/stripe_price"
+            "type": "producs#/definitions/stripe_price"
           }
         },
         "benefits": {
           "type": ["array", "null"],
           "items": {
-            "type": "producs.canary#/definitions/product-benefit"
+            "type": "producs#/definitions/product-benefit"
           }
         }
       }
diff --git a/packages/admin-api-schema/lib/schemas/snippets-add.json b/packages/admin-api-schema/lib/schemas/snippets-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.add.canary",
+  "$id": "snippets.add",
   "title": "snippets.add",
   "description": "Schema for snippets.add",
   "type": "object",
@@ -13,7 +13,7 @@
       "additionalProperties": false,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "snippets.canary#/definitions/snippet" }],
+        "allOf": [{ "$ref": "snippets#/definitions/snippet" }],
         "required": ["name", "mobiledoc"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/snippets-edit.json b/packages/admin-api-schema/lib/schemas/snippets-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.edit.canary",
+  "$id": "snippets.edit",
   "title": "snippets.edit",
   "description": "Schema for snippets.edit",
   "type": "object",
@@ -13,7 +13,7 @@
       "additionalProperties": false,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "snippets.canary#/definitions/snippet" }],
+        "allOf": [{ "$ref": "snippets#/definitions/snippet" }],
         "required": ["name", "mobiledoc"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/snippets.json b/packages/admin-api-schema/lib/schemas/snippets.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "snippets.canary",
+  "$id": "snippets",
   "title": "snippets",
   "description": "Base snippets definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/tags-add.json b/packages/admin-api-schema/lib/schemas/tags-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.add.canary",
+  "$id": "tags.add",
   "title": "tags.add",
   "description": "Schema for tags.add",
   "type": "object",
@@ -13,7 +13,7 @@
       "additionalProperties": false,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "tags.canary#/definitions/tag" }],
+        "allOf": [{ "$ref": "tags#/definitions/tag" }],
         "required": ["name"]
       }
     }
diff --git a/packages/admin-api-schema/lib/schemas/tags-edit.json b/packages/admin-api-schema/lib/schemas/tags-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.edit.canary",
+  "$id": "tags.edit",
   "title": "tags.edit",
   "description": "Schema for tags.edit",
   "type": "object",
@@ -10,7 +10,7 @@
       "type": "array",
       "minItems": 1,
       "maxItems": 1,
-      "items": { "$ref": "tags.canary#/definitions/tag" }
+      "items": { "$ref": "tags#/definitions/tag" }
     }
   },
   "required": ["tags"]
diff --git a/packages/admin-api-schema/lib/schemas/tags.json b/packages/admin-api-schema/lib/schemas/tags.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tags.canary",
+  "$id": "tags",
   "title": "tags",
   "description": "Base tags definitions",
   "definitions": {
diff --git a/packages/admin-api-schema/lib/schemas/tiers-add.json b/packages/admin-api-schema/lib/schemas/tiers-add.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tiers.add.canary",
+  "$id": "tiers.add",
   "title": "tiers.add",
   "description": "Schema for tiers.add",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "tiers.canary#/definitions/tier" }]
+        "allOf": [{ "$ref": "tiers#/definitions/tier" }]
       }
     }
   },
diff --git a/packages/admin-api-schema/lib/schemas/tiers-edit.json b/packages/admin-api-schema/lib/schemas/tiers-edit.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "tiers.edit.canary",
+  "$id": "tiers.edit",
   "title": "tiers.edit",
   "description": "Schema for tiers.edit",
   "type": "object",
@@ -12,7 +12,7 @@
       "maxItems": 1,
       "items": {
         "type": "object",
-        "allOf": [{ "$ref": "tiers.canary#/definitions/tier" }]
+        "allOf": [{ "$ref": "tiers#/definitions/tier" }]
       }
     }
   },
diff --git a/packages/admin-api-schema/lib/schemas/tiers.json b/packages/admin-api-schema/lib/schemas/tiers.json
diff --git a/packages/admin-api-schema/lib/schemas/webhooks-add.json b/packages/admin-api-schema/lib/schemas/webhooks-add.json
diff --git a/packages/admin-api-schema/lib/schemas/webhooks-edit.json b/packages/admin-api-schema/lib/schemas/webhooks-edit.json
diff --git a/packages/admin-api-schema/lib/schemas/webhooks.json b/packages/admin-api-schema/lib/schemas/webhooks.json
diff --git a/packages/admin-api-schema/test/api.test.js b/packages/admin-api-schema/test/api.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "images.upload.canary",`
	`3`	`+ "$id": "images.upload",`
`4`	`4`	`"title": "images.upload",`
`5`	`5`	`"description": "Schema for images.upload",`
`6`		`- "$ref": "images.canary#/definitions/image"`
	`6`	`+ "$ref": "images#/definitions/image"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "images.canary",`
	`3`	`+ "$id": "images",`
`4`	`4`	`"title": "images",`
`5`	`5`	`"description": "Base images definitions",`
`6`	`6`	`"definitions": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "labels.add.canary",`
	`3`	`+ "$id": "labels.add",`
`4`	`4`	`"title": "labels.add",`
`5`	`5`	`"description": "Schema for labels.add",`
`6`	`6`	`"type": "object",`
`@@ -13,7 +13,7 @@`
`13`	`13`	`"additionalProperties": false,`
`14`	`14`	`"items": {`
`15`	`15`	`"type": "object",`
`16`		`- "allOf": [{ "$ref": "labels.canary#/definitions/label" }],`
	`16`	`+ "allOf": [{ "$ref": "labels#/definitions/label" }],`
`17`	`17`	`"required": ["name"]`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "labels.canary",`
	`3`	`+ "$id": "labels",`
`4`	`4`	`"title": "labels",`
`5`	`5`	`"description": "Base labels definitions",`
`6`	`6`	`"definitions": {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "media.upload.canary",`
	`3`	`+ "$id": "media.upload",`
`4`	`4`	`"title": "media.upload",`
`5`	`5`	`"description": "Schema for media.upload",`
`6`		`- "$ref": "media.canary#/definitions/media"`
	`6`	`+ "$ref": "media#/definitions/media"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "media.canary",`
	`3`	`+ "$id": "media",`
`4`	`4`	`"title": "media",`
`5`	`5`	`"description": "Base media definitions",`
`6`	`6`	`"definitions": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "members.add.canary",`
	`3`	`+ "$id": "members.add",`
`4`	`4`	`"title": "members.add",`
`5`	`5`	`"description": "Schema for members.add",`
`6`	`6`	`"type": "object",`
`@@ -12,7 +12,7 @@`
`12`	`12`	`"maxItems": 1,`
`13`	`13`	`"items": {`
`14`	`14`	`"type": "object",`
`15`		`- "allOf": [{ "$ref": "members.canary#/definitions/member" }],`
	`15`	`+ "allOf": [{ "$ref": "members#/definitions/member" }],`
`16`	`16`	`"required": ["email"]`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-07/schema#",`
`3`		`- "$id": "members.upload.canary",`
	`3`	`+ "$id": "members.upload",`
`4`	`4`	`"title": "members.upload",`
`5`	`5`	`"description": "Schema for members.upload",`
`6`	`6`	`"type": "array",`