From 75cd9774b750ad104478c740ddbc19f04a16a9b5 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Sun, 2 Feb 2020 09:15:43 +0100
Subject: [PATCH] Added optional domain query param to documentation for all
 rest endpoints that need it

---
 docs/swagger/parameters/domain.json                |  9 +++++++++
 docs/swagger/paths/v1_short-urls_{shortCode}.json  | 14 +++++++-------
 .../paths/v1_short-urls_{shortCode}_tags.json      |  3 +++
 .../paths/v1_short-urls_{shortCode}_visits.json    |  3 +++
 4 files changed, 22 insertions(+), 7 deletions(-)
 create mode 100644 docs/swagger/parameters/domain.json

diff --git a/docs/swagger/parameters/domain.json b/docs/swagger/parameters/domain.json
new file mode 100644
index 00000000..9a9b41b9
--- /dev/null
+++ b/docs/swagger/parameters/domain.json
@@ -0,0 +1,9 @@
+{
+    "name": "domain",
+    "description": "The domain in which the short code should be searched for.",
+    "in": "query",
+    "required": false,
+    "schema": {
+        "type": "string"
+    }
+}
diff --git a/docs/swagger/paths/v1_short-urls_{shortCode}.json b/docs/swagger/paths/v1_short-urls_{shortCode}.json
index 4fbdeb8e..b9baad92 100644
--- a/docs/swagger/paths/v1_short-urls_{shortCode}.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}.json
@@ -20,13 +20,7 @@
                 }
             },
             {
-                "name": "domain",
-                "in": "query",
-                "description": "The domain in which the short code should be searched for. Will fall back to default domain if not found.",
-                "required": false,
-                "schema": {
-                    "type": "string"
-                }
+                "$ref": "../parameters/domain.json"
             }
         ],
         "security": [
@@ -105,6 +99,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "requestBody": {
@@ -215,6 +212,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "security": [
diff --git a/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json b/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
index 4065f718..fd497380 100644
--- a/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}_tags.json
@@ -18,6 +18,9 @@
                 "schema": {
                     "type": "string"
                 }
+            },
+            {
+                "$ref": "../parameters/domain.json"
             }
         ],
         "requestBody": {
diff --git a/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json b/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
index 2369ba13..03d66a99 100644
--- a/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
+++ b/docs/swagger/paths/v1_short-urls_{shortCode}_visits.json
@@ -19,6 +19,9 @@
                     "type": "string"
                 }
             },
+            {
+                "$ref": "../parameters/domain.json"
+            },
             {
                 "name": "startDate",
                 "in": "query",