Allow filtering by subject in the upstream OAuth links admin API

Author: sandhose

crates/handlers/src/admin/v1/upstream_oauth_links/list.rs

@@ -40,6 +40,10 @@ pub struct FilterParams {
     #[serde(rename = "filter[provider]")]
     #[schemars(with = "Option<crate::admin::schema::Ulid>")]
     provider: Option<Ulid>,
+
+    /// Retrieve the items with the given subject
+    #[serde(rename = "filter[subject]")]
+    subject: Option<String>,
 }
 
 impl std::fmt::Display for FilterParams {
@@ -56,6 +60,11 @@ impl std::fmt::Display for FilterParams {
             sep = '&';
         }
 
+        if let Some(subject) = &self.subject {
+            write!(f, "{sep}filter[subject]={subject}")?;
+            sep = '&';
+        }
+
         let _ = sep;
         Ok(())
     }
@@ -166,6 +175,12 @@ pub async fn handler(
         filter
     };
 
+    let filter = if let Some(subject) = &params.subject {
+        filter.for_subject(subject)
+    } else {
+        filter
+    };
+
     let page = repo.upstream_oauth_link().list(filter, pagination).await?;
     let count = repo.upstream_oauth_link().count(filter).await?;
 
@@ -443,5 +458,45 @@ mod tests {
           }
         }
         "###);
+
+        // Filter by subject
+        let request = Request::get(format!(
+            "/api/admin/v1/upstream-oauth-links?filter[subject]={}",
+            "subject1"
+        ))
+        .bearer(&token)
+        .empty();
+
+        let response = state.request(request).await;
+        response.assert_status(StatusCode::OK);
+        let body: serde_json::Value = response.json();
+        assert_json_snapshot!(body, @r###"
+        {
+          "meta": {
+            "count": 1
+          },
+          "data": [
+            {
+              "type": "upstream-oauth-link",
+              "id": "01FSHN9AG0AQZQP8DX40GD59PW",
+              "attributes": {
+                "created_at": "2022-01-16T14:40:00Z",
+                "provider_id": "01FSHN9AG09NMZYX8MFYH578R9",
+                "subject": "subject1",
+                "user_id": "01FSHN9AG0MZAA6S4AF7CTV32E",
+                "human_account_name": "alice@acme"
+              },
+              "links": {
+                "self": "/api/admin/v1/upstream-oauth-links/01FSHN9AG0AQZQP8DX40GD59PW"
+              }
+            }
+          ],
+          "links": {
+            "self": "/api/admin/v1/upstream-oauth-links?filter[subject]=subject1&page[first]=10",
+            "first": "/api/admin/v1/upstream-oauth-links?filter[subject]=subject1&page[first]=10",
+            "last": "/api/admin/v1/upstream-oauth-links?filter[subject]=subject1&page[last]=10"
+          }
+        }
+        "###);
     }
 }

docs/api/spec.json

@@ -1837,6 +1837,17 @@
               "nullable": true
             },
             "style": "form"
+          },
+          {
+            "in": "query",
+            "name": "filter[subject]",
+            "description": "Retrieve the items with the given subject",
+            "schema": {
+              "description": "Retrieve the items with the given subject",
+              "type": "string",
+              "nullable": true
+            },
+            "style": "form"
           }
         ],
         "responses": {
@@ -2931,6 +2942,11 @@
             "description": "Retrieve the items for the given provider",
             "$ref": "#/components/schemas/ULID",
             "nullable": true
+          },
+          "filter[subject]": {
+            "description": "Retrieve the items with the given subject",
+            "type": "string",
+            "nullable": true
           }
         }
       },