Merge pull request #169 from modulr-software/deprecate/api-keys

toasted226 · web-flow · commit 63dc10823ac6 · 2026-02-16T12:25:55.000+02:00
deprecate API keys
diff --git a/Source.postman_collection.json b/Source.postman_collection.json
diff --git a/src/source/middleware/auth/core.clj b/src/source/middleware/auth/core.clj
@@ -60,21 +60,6 @@
          (res/response {:message "The bundle you are looking for does not exist."})
          (res/status 404))))))
 
-(defn wrap-auth-api-key
-  "validates the api key from the Authorization header for unauthenticated 
-  users and attaches the bundle-id to the request"
-  [handler]
-  (fn [request]
-    (let [ds (db.util/conn :master)
-          token (util/auth-token request)
-          existing-bundle (bundles/bundle ds {:where [:= :hash token]})]
-      (if (some? existing-bundle)
-        (-> request
-            (assoc :bundle-id (:id existing-bundle))
-            (handler))
-        (-> (res/response {:message "The bundle you are looking for does not exist."})
-            (res/status 404))))))
-
 (comment
   (let [authed-request {:headers {"Authorization"
                                   (str
diff --git a/src/source/middleware/core.clj b/src/source/middleware/core.clj
@@ -137,7 +137,3 @@
 (defn apply-bundle [app]
   (-> app
       (auth/wrap-bundle-id)))
-
-(defn apply-api-key [app]
-  (-> app
-      (auth/wrap-auth-api-key)))
diff --git a/src/source/middleware/interface.clj b/src/source/middleware/interface.clj
@@ -12,8 +12,5 @@
 (defn apply-bundle [app]
   (mw/apply-bundle app))
 
-(defn apply-api-key [app]
-  (mw/apply-api-key app))
-
 (defn apply-validation [app openapi-meta]
   (mw/wrap-input-validation app openapi-meta))
diff --git a/src/source/routes/bundle.clj b/src/source/routes/bundle.clj
@@ -3,8 +3,8 @@
             [source.db.honey :as hon]))
 
 (defn get
-  {:summary "get metadata for the associated uuid-authorized bundle"
-   :parameters {:query [:map [:uuid :string]]}
+  {:summary "Get metadata for the associated uuid-authorized bundle."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]}
    :responses {200 {:body [:map
                            [:id :int]
                            [:name :string]
diff --git a/src/source/routes/bundle_categories.clj b/src/source/routes/bundle_categories.clj
@@ -3,8 +3,8 @@
             [ring.util.response :as res]))
 
 (defn get
-  {:summary "get all categories for content present in the uuid-authorized bundle"
-   :parameters {:query [:map [:uuid :string]]}
+  {:summary "Get all categories for which content is present in the uuid-authorized bundle (RSS feeds / posts)."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]}
    :responses {200 {:body [:vector
                            [:map
                             [:id :int]
diff --git a/src/source/routes/bundle_feed.clj b/src/source/routes/bundle_feed.clj
@@ -4,10 +4,11 @@
             [source.services.analytics.interface :as analytics]))
 
 (defn get
-  {:summary "get feed associated with the uuid-authorized bundle by id, updates click analytics for the given feed"
-   :parameters {:query [:map [:uuid :string]]
+  {:summary "Get a single RSS feed by id from RSS feeds within the uuid-authorized bundle. 
+   This endpoint will update click analytics for the returned RSS feed."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]
                 :path [:map [:id {:title "id"
-                                  :description "feed id"} :int]]}
+                                  :description "Feed ID"} :int]]}
    :responses  {200 {:body [:map
                             [:id :int]
                             [:title :string]
diff --git a/src/source/routes/bundle_feed_post.clj b/src/source/routes/bundle_feed_post.clj
@@ -4,10 +4,11 @@
             [source.services.analytics.interface :as analytics]))
 
 (defn get
-  {:summary "get post in outgoing feed for the associated uuid-authorized bundle by post id, updates click analytics"
-   :parameters {:query [:map [:uuid :string]]
-                :path [:map [:post-id {:title "post-id"
-                                       :description "post id"} :int]]}
+  {:summary "Get a single post by post id belonging to an RSS feed in the associated uuid-authorized bundle. 
+   This endpoint updates click analytics for the returned post."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]
+                :path [:map [:post-id {:title "postId"
+                                       :description "Post ID"} :int]]}
    :responses {200 {:body
                     [:map
                      [:id :int]
diff --git a/src/source/routes/bundle_feed_posts.clj b/src/source/routes/bundle_feed_posts.clj
@@ -4,10 +4,11 @@
             [source.services.analytics.interface :as analytics]))
 
 (defn get
-  {:summary "get all posts in the outgoing feed for the associated uuid-authorized bundle by feed id"
-   :parameters {:query [:map [:uuid :string]]
+  {:summary "Get all posts present within a given RSS feed by feed id, within the uuid-authorized bundle.
+   This endpoint will update impressions analytics for the returned posts."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]
                 :path [:map [:id {:title "id"
-                                  :description "feed id"} :int]]}
+                                  :description "Feed ID"} :int]]}
    :responses {200 {:body [:vector
                            [:map
                             [:id :int]
diff --git a/src/source/routes/bundle_feeds.clj b/src/source/routes/bundle_feeds.clj
@@ -5,12 +5,16 @@
             [source.services.analytics.interface :as analytics]))
 
 (defn post
-  {:summary "get all feeds present in the bundle authorised by uuid, updating impression analytics."
+  {:summary "Get all RSS feeds present in the bundle authorised by uuid.
+   This endpoint will update impressions analytics for the returned RSS feeds."
    :parameters {:query [:map
-                        [:uuid :string]
-                        [:type {:optional true} :int]
-                        [:latest {:optional true} :boolean]
-                        [:nonfiltered {:optional true} :boolean]]
+                        [:uuid {:description "Bundle UUID"} :string]
+                        [:type {:optional true
+                                :description "Filters by content type ID"} :int]
+                        [:latest {:optional true
+                                  :description "Filters by most recently uploaded feeds"} :boolean]
+                        [:nonfiltered {:optional true
+                                       :description "Marking this field as true will disable all filters"} :boolean]]
                 :body [:map [:category-ids [:vector :int]]]}
    :responses {200 {:body [:vector
                            [:map
diff --git a/src/source/routes/bundle_post.clj b/src/source/routes/bundle_post.clj
@@ -6,10 +6,12 @@
             [honey.sql.helpers :as hsql]))
 
 (defn get
-  {:summary "get a single outgoing post in the uuid-authorized bundle by post id, updates click analytics"
-   :parameters {:query [:map [:uuid :string]]
+  {:summary "Get a single post by post id in the uuid-authorized bundle.
+   Used to return a single post present in the bundle.
+   This endpoint updates click analytics for the returned post."
+   :parameters {:query [:map [:uuid {:description "Bundle UUID"} :string]]
                 :path [:map [:id {:title "id"
-                                  :description "post id"} :int]]}
+                                  :description "Post ID"} :int]]}
    :responses {200 {:body [:map
                            [:id :int]
                            [:post-id :string]
diff --git a/src/source/routes/bundle_posts.clj b/src/source/routes/bundle_posts.clj
@@ -5,14 +5,25 @@
             [source.workers.bundles :as bundles]))
 
 (defn post
-  {:summary "get all (optionally filtered) outgoing posts in the uuid-authorized bundle, updates impression analytics"
+  {:summary "Get a list of posts in the uuid-authorized bundle, determined by analytics.
+   This endpoint updates impression analytics for the returned posts."
    :parameters {:body [:map [:category-ids [:vector :int]]]
                 :query [:map
-                        [:uuid :string]
-                        [:limit {:optional true} :int]
-                        [:start {:optional true} :int]
-                        [:type {:optional true} :int]
-                        [:latest {:optional true} [:enum "true" "false"]]]}
+                        [:uuid {:description "Bundle UUID"} :string]
+                        [:limit
+                         {:optional true
+                          :description "Used for pagination. Specifies a number of posts to be returned."}
+                         :int]
+                        [:start
+                         {:optional true
+                          :description "Used for pagination. Specifies the starting point for the returned posts, incremented by the limit."}
+                         :int]
+                        [:type {:optional true
+                                :description "Filters by content type ID"} :int]
+                        [:latest
+                         {:optional true
+                          :description "Filters by most recently uploaded posts, not determined by analytics"}
+                         [:enum "true" "false"]]]}
    :responses {200 {:body [:vector
                            [:map
                             [:id :int]
diff --git a/src/source/routes/integration_key.clj b/src/source/routes/integration_key.clj
diff --git a/src/source/routes/integrations.clj b/src/source/routes/integrations.clj
@@ -28,7 +28,7 @@
   (res/response (bundles/bundles ds {:where [:= :user-id (:id user)]})))
 
 (defn post
-  {:summary "add an integration"
+  {:summary "creates an integration and the associated bundle in which content is stored"
    :parameters {:body [:map
                        [:name :string]
                        [:ts-and-cs {:optional true} :int]
diff --git a/src/source/routes/reitit.clj b/src/source/routes/reitit.clj
@@ -47,7 +47,6 @@
             [source.routes.analytics.bundle.posts.-id-.views :as analytics-bundle-posts-id-views]
             [source.routes.integrations :as integrations]
             [source.routes.integration :as integration]
-            [source.routes.integration-key :as integration-key]
             [source.routes.integration-categories :as integration-categories]
             [source.routes.integration-filter-feeds :as integration-filter-feeds]
             [source.routes.integration-filter-feed :as integration-filter-feed]
@@ -175,12 +174,11 @@
       ["/:id" (-> (get integration/get)
                   (post integration/post)
                   (delete integration/delete))]
-      ["/:id/key" (post integration-key/post)]
-      ["/:id/categories" (->  (get integration-categories/get)
-                              (post integration-categories/post))]
+      ["/:id/categories" (-> (get integration-categories/get)
+                             (post integration-categories/post))]
       ["/:id/filter/feeds" (get integration-filter-feeds/get)]
-      ["/:id/filter/feeds/:feed-id" (->  (get integration-filter-feed/get)
-                                         (post integration-filter-feed/post))]
+      ["/:id/filter/feeds/:feed-id" (-> (get integration-filter-feed/get)
+                                        (post integration-filter-feed/post))]
       ["/:id/filter/posts" (get integration-filter-posts/get)]
       ["/:id/filter/posts/:post-id" (-> (get integration-filter-post/get)
                                         (post integration-filter-post/post))]]
@@ -227,23 +225,6 @@
       ["/posts" (post bundle-posts/post)]
       ["/posts/:id" (get bundle-post/get)]]
 
-     ["/api" {:middleware [[mw/apply-api-key]]
-              :tags #{"api"}
-              :swagger {:security [{"apiKey" []}]}
-              :openapi {:security [{:apiKey []}]}}
-
-      ["/bundle" {:middleware [[mw/apply-bundle]]}
-       ["" (get bundle/get)]
-       ["/categories" (get bundle-categories/get)]
-       ["/feeds" (post bundle-feeds/post)]
-       ["/feeds/:id" (get bundle-feed/get)]
-       ["/feeds/:id/posts" (get bundle-feed-posts/get)]
-       ["/feeds/:id/posts/:post-id" (get bundle-feed-post/get)]
-       ["/posts" (post bundle-posts/post)]
-       ["/posts/:id" (get bundle-post/get)]]
-      ["/categories" (get categories/get)]
-      ["/categories/:id" (get category/get)]]
-
      ["/admin" {:middleware [[mw/apply-auth {:required-type :admin}]]
                 :tags #{"admin"}
                 :swagger {:security [{"auth" []}]}
diff --git a/src/source/routes/util.clj b/src/source/routes/util.clj
@@ -68,11 +68,18 @@
                                                   :urls.primaryName "swagger"
                                                   :operationsSorter "alpha"}}))
 
+(defn tag-definitions []
+  [{:name "integrations"
+    :description "Management endpoints for integrations and the associated bundle"}
+   {:name "bundles"
+    :description "Content endpoints for the bundle associated with an integration"}])
+
 (defn swagger-route []
   ["/swagger.json" {:get {:no-doc true
                           :swagger {:info {:title "source-api"
-                                           :description "swagger docs for source api with malli and reitit-ring"
-                                           :version "0.0.1"}
+                                           :description "Swagger docs for Source API with Malli and Reitit-Ring. For usage examples, check out our postman collection on our GitHub Repository: https://github.com/modulr-software/source-be"
+                                           :version "0.0.2"}
+                                    :tags (tag-definitions)
                                     :securityDefinitions {"auth" {:type :apiKey
                                                                   :in :header
                                                                   :name "Authorization"}
@@ -85,7 +92,8 @@
   ["/openapi.json" {:get {:no-doc true
                           :openapi {:info {:title "source-api"
                                            :description "openapi3 docs for source api with malli and reitit-ring"
-                                           :version "0.0.1"}
+                                           :version "0.0.2"}
+                                    :tags (tag-definitions)
                                     :components {:securitySchemes {"bearerAuth" {:type :http
                                                                                  :scheme :bearer
                                                                                  :bearerFormat "JWT"
diff --git a/src/source/workers/integrations.clj b/src/source/workers/integrations.clj
@@ -4,7 +4,6 @@
             [source.db.util :as db.util]
             [source.services.bundle-categories :as bundle-categories]
             [source.services.bundle-content-types :as bundle-content-types]
-            [source.util :as utils]
             [source.db.tables :as tables]
             [source.db.honey :as hon]
             [congest.jobs :as congest]))
@@ -45,14 +44,6 @@
                    :where [:= :id bundle-id]})
   (congest/deregister! js job-id))
 
-(defn generate-api-key! [ds user-id bundle-id]
-  (let [uuid (utils/uuid)
-        api-key (utils/sha256 (str user-id bundle-id uuid))]
-    (hon/update! ds {:tname :bundles
-                     :where [:= :id bundle-id]
-                     :data {:hash api-key}})
-    api-key))
-
 (defn update-filtered-feeds! [ds {:keys [filtered bundle-id feed-id]}]
   (if filtered
     (hon/insert! ds {:tname :filtered-feeds
