Merge branch 'master' of github.com:Radarr/RadarrAPI.TMDB

Author: galli-leo

mappings/brainstorming.md

@@ -2,24 +2,26 @@
 
 Master Table:
 
-| id | tmdbid | imdbid | report_count | locked  |
-|---|----|----|---|---|
-| 1 | 11     | tt000011 |  13           | true  |
-| 2 | 2      | tt000002 | -4           |  true |
-| 3 | 11     | tt000011 |  -5           | true   |
-| 4 | 2     | tt000002 | 4            | false  |
+| id | tmdbid | imdbid | report_count | total_reports | locked  |
+|---|----|----|---|---|---|
+| 1 | 11     | tt000011 |  13         | 15  | true  |
+| 2 | 2      | tt000002 | -4          | 6 |  true |
+| 3 | 11     | tt000011 |  -5         | 10  | true   |
+| 4 | 2     | tt000002 | 4            | 50 | false  |
 
 Title Mappings:
 
-| master_id (Foreign Key) | aka_title           | 
-|----------|---------------------|
-| 1 | Star Wars: Whatevs  |
-| 2 | Ariel: What a beach | 
-| | |
+| mappingsid (Foreign Key) | aka_title | aka_clean_title |
+|----------|---------------------|---------|
+| 1 | Star Wars: Whatevs  | starwarswhatevs |
+| 2 | Ariel: What a beach | arielwhatbeach |
+| | | |
+
+**Note:** Clean title is used to ensure that only one mapping per aka_title exists (should be unique). It also should help mapping with e.g. files.
 
 Year Mappings:
 
-| master_id (Foreign Key) | aka_year |
+| mappingsid (Foreign Key) | aka_year |
 |----------|----------|
 | 3 | 1978     |
 | 4 | 1999     | 
@@ -54,7 +56,9 @@ Add new Mapping
   "type" : "title",
   "tmdbid" : 11,
   "imdbid" : "tt0000011",
-  "aka_title" : "Star Wars"
+  "aka_title" : "Star Wars",
+  "report_count" : 1,
+  "total_reports" : 1
 }
 ```
 
@@ -63,7 +67,9 @@ Add new Mapping
   "type" : "year",
   "tmdbid" : 11,
   "imdbid" : "tt0000011",
-  "aka_year" : 1978
+  "aka_year" : 1978,
+  "report_count" : 1,
+  "total_reports" : 1
 }
 ```
 
@@ -76,29 +82,58 @@ Retrieve mappings for movie
 |--------|----------|---------------------|------|
 | tmdbid | int | only when imdbid is present | -  |
 | imdbid | string (must match: /tt\d{7}/) | only when tmdbid is present | - |
+| type | string (either "title", "year" or "all" | yes | all |
 | min_report | int |      yes    |       3              |
 
 #### Sample Request
 
-`GET /mappings/get?tmdbid=11&min_report=5`
+`GET /mappings/get?tmdbid=11&min_report=-50`
+`GET /mappings/get?tmdbid=11&min_report=5&type=title`
 
 #### Sample Response
 
 ```
-[
-  {
-    "type" : "title",
-    "tmdbid" : 11,
-    "imdbid" : "tt0000011",
-    "aka_title" : "Star Wars"
-  },
-  {
-    "type" : "year",
-    "tmdbid" : 11,
-    "imdbid" : "tt0000011",
-    "aka_year" : 1978
-  }
-]
+{
+  "tmdbid" : 11,
+  "imdbid" : "tt0000011",
+  "titles" : [
+    {
+      "id" : 1,
+      "type" : "title",
+      "aka_title" : "Star Wars",
+      "report_count" : 15,
+      "total_reports" : 20,
+      "locked" : false
+    }
+  ],
+  "years" : [
+    {
+      "id" : 2,
+      "type" : "year",
+      "aka_year" : 1978,
+      "report_count" : -4,
+      "total_reports" : 6,
+      "locked" : true
+    }
+  ]
+}
+```
+
+```
+{
+  "tmdbid" : 11,
+  "imdbid" : "tt0000011",
+  "titles" : [
+    {
+      "id" : 1,
+      "type" : "title",
+      "aka_title" : "Star Wars",
+      "report_count" : 15,
+      "total_reports" : 20,
+      "locked" : false
+    }
+  ]
+}
 ```
 
 ## "Rate Limiting"
@@ -107,7 +142,7 @@ Each IP Address can only "vote" on a mapping once a day.
 
 ### Table for IP Addresses
 
-| ip | masterid |
+| ip | mappingsid |
 |--|--|
 | 192.168.1.117 | 2 |