Document the collection mapping, for future us

artsy · Sep 1, 2019 · 1fef6c8 · 1fef6c8
1 parent a71ad93
commit 1fef6c8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/src/commands/identify.ts b/src/commands/identify.ts
@@ -10,7 +10,7 @@ export default class Identify extends Command {
 
   static args = [{ name: "id" }]
 
-  static collectionsToCheck = [
+  static collectionsToCheck: CollectionMapping[] = [
     { name: "Artist", endpoint: "artist" },
     { name: "Artwork", endpoint: "artwork" },
     { name: "Partner", endpoint: "partner" },
@@ -39,3 +39,11 @@ export default class Identify extends Command {
     }
   }
 }
+
+interface CollectionMapping {
+  /** Name of the Gravity resource */
+  name: string
+
+  /** The name of the collection as it appears in the GET endpoint for the resource, i.e. /api/v1/<endpoint>/:id */
+  endpoint: string
+}
diff --git a/tslint.json b/tslint.json
@@ -16,6 +16,7 @@
     "trailing-comma": false,
     "variable-name": [true, "ban-keywords", "allow-leading-underscore"],
     "jsdoc-format": false,
-    "radix": false
+    "radix": false,
+    "no-single-line-block-comment": false
   }
 }