UPS-4877 remove name from grouppass search

cultuurnet · Dec 9, 2024 · 7e4837f · 7e4837f
1 parent 6e8be33
commit 7e4837f
Showing 1 changed file with 4 additions and 12 deletions.
diff --git a/projects/uitpas/reference/uitpas.json b/projects/uitpas/reference/uitpas.json
@@ -2120,7 +2120,7 @@
           }
         },
         "operationId": "get-grouppasses",
-        "description": "Retrieve grouppasses based on search parameters.\n\nNote: by default grouppasses in the response are alphabetically sorted by name.\n\nThe caller of this request must have `GROUPPASSES_SEARCH` or `GROUPPASSES_SEARCH_ALL` permission.",
+        "description": "Retrieve grouppasses based on search parameters.\n\n**Note**: For now this endpoint requires either `uitpasNumber` or `chipNumber`, so this endpoint currently cannot be used to search _all_ grouppasses.\n\nThe caller of this request must have `GROUPPASSES_SEARCH` permission.",
         "security": [
           {
             "USER_ACCESS_TOKEN": []
@@ -2136,23 +2136,15 @@
             },
             "in": "query",
             "name": "uitpasNumber",
-            "description": "Unique UiTPAS number of the grouppass to look up."
+            "description": "Unique UiTPAS number of the grouppass to look up. Required unless `chipNumber` is used."
           },
           {
             "schema": {
               "type": "string"
             },
             "in": "query",
             "name": "chipNumber",
-            "description": "Hexadecimal notation of the chip number of a grouppass UiTPAS card."
-          },
-          {
-            "schema": {
-              "type": "string"
-            },
-            "in": "query",
-            "name": "name",
-            "description": "Complete or partial name of a grouppass to look up."
+            "description": "Hexadecimal notation of the chip number of a grouppass UiTPAS card. Required unless`uitpasNumber` is used."
           },
           {
             "$ref": "#/components/parameters/start"
@@ -2170,7 +2162,7 @@
             },
             "in": "query",
             "name": "sort[name]",
-            "description": "Sorts the grouppasses by its name in ascending or descending order. By default passholders are sorted by name, ascending order."
+            "description": "Sorts the grouppasses by ti name in ascending or descending order. By default passholders are sorted by name, ascending order."
           }
         ]
       },