Update image swagger docs to represent the API correctly

4 years ago · 3ec5d1ef3d
parent 203d735a85
commit 3ec5d1ef3d
1 changed files with 10 additions and 5 deletions
--- a/src/Radarr.Api.V3/swagger.json
+++ b/src/Radarr.Api.V3/swagger.json
@ -3883,13 +3883,18 @@
        "properties": {
          "coverType": {
            "type": "string",
-            "enum": [
-              "poster",
-              "fanart"
-            ]
+            "enum": ["poster", "fanart"],
+            "example": "poster"
          },
          "url": {
-            "type": "string"
+            "type": "string",
+            "summary": "A path that can be used together with the host to find the image - requires API key",
+            "example": "/radarr/MediaCover/39/poster.jpg?lastWrite=637618111851086964"
+          },
+          "remoteUrl": {
+            "type": "string",
+            "summary": "A full URL of the TMDB source",
+            "example": "https://image.tmdb.org/t/p/original/i0FHyNF9VvQTXOi4yKnZJ1zql1.jpg"
          }
        },
        "xml": {