From 74e84cf8fad85c698299768b0b444dd074f62604 Mon Sep 17 00:00:00 2001
From: Vyr Cossont <VyrCossont@users.noreply.github.com>
Date: Thu, 7 Mar 2024 02:28:57 -0800
Subject: [PATCH] [docs/chore] Swagger fixes for filters (#2730)

* Swagger: filtersV1Get should return an array

* Swagger: context must use multi format
---
 docs/api/swagger.yaml                        | 14 +++++++++-----
 internal/api/client/filters/v1/filterpost.go |  3 ++-
 internal/api/client/filters/v1/filterput.go  |  3 ++-
 internal/api/client/filters/v1/filtersget.go |  6 ++++--
 4 files changed, 17 insertions(+), 9 deletions(-)

diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml
index be833cf51..0fe932daa 100644
--- a/docs/api/swagger.yaml
+++ b/docs/api/swagger.yaml
@@ -5296,7 +5296,9 @@ paths:
                 "200":
                     description: Requested filters.
                     schema:
-                        $ref: '#/definitions/filterV1'
+                        items:
+                            $ref: '#/definitions/filterV1'
+                        type: array
                 "400":
                     description: bad request
                 "401":
@@ -5329,7 +5331,8 @@ paths:
                   name: phrase
                   required: true
                   type: string
-                - description: |-
+                - collectionFormat: multi
+                  description: |-
                     The contexts in which the filter should be applied.
 
                     Sample: home, public
@@ -5343,7 +5346,7 @@ paths:
                   items:
                     type: string
                   minItems: 1
-                  name: context
+                  name: context[]
                   required: true
                   type: array
                   uniqueItems: true
@@ -5477,7 +5480,8 @@ paths:
                   name: phrase
                   required: true
                   type: string
-                - description: |-
+                - collectionFormat: multi
+                  description: |-
                     The contexts in which the filter should be applied.
 
                     Sample: home, public
@@ -5491,7 +5495,7 @@ paths:
                   items:
                     type: string
                   minItems: 1
-                  name: context
+                  name: context[]
                   required: true
                   type: array
                   uniqueItems: true
diff --git a/internal/api/client/filters/v1/filterpost.go b/internal/api/client/filters/v1/filterpost.go
index e150e8609..4c71eeddb 100644
--- a/internal/api/client/filters/v1/filterpost.go
+++ b/internal/api/client/filters/v1/filterpost.go
@@ -55,7 +55,7 @@
 //		maxLength: 40
 //		type: string
 //	-
-//		name: context
+//		name: context[]
 //		in: formData
 //		required: true
 //		description: |-
@@ -72,6 +72,7 @@
 //		items:
 //			type:
 //				string
+//		collectionFormat: multi
 //		minItems: 1
 //		uniqueItems: true
 //	-
diff --git a/internal/api/client/filters/v1/filterput.go b/internal/api/client/filters/v1/filterput.go
index 1822efb6d..b7164936b 100644
--- a/internal/api/client/filters/v1/filterput.go
+++ b/internal/api/client/filters/v1/filterput.go
@@ -61,7 +61,7 @@
 //		maxLength: 40
 //		type: string
 //	-
-//		name: context
+//		name: context[]
 //		in: formData
 //		required: true
 //		description: |-
@@ -78,6 +78,7 @@
 //		items:
 //			type:
 //				string
+//		collectionFormat: multi
 //		minItems: 1
 //		uniqueItems: true
 //	-
diff --git a/internal/api/client/filters/v1/filtersget.go b/internal/api/client/filters/v1/filtersget.go
index 84d638676..f1e07a2da 100644
--- a/internal/api/client/filters/v1/filtersget.go
+++ b/internal/api/client/filters/v1/filtersget.go
@@ -43,10 +43,12 @@
 //
 //	responses:
 //		'200':
-//			name: filter
+//			name: filters
 //			description: Requested filters.
 //			schema:
-//				"$ref": "#/definitions/filterV1"
+//				type: array
+//				items:
+//					"$ref": "#/definitions/filterV1"
 //		'400':
 //			description: bad request
 //		'401':