Pull request fixes

simzzz · simzzz · commit f0f1b0316aa2 · 2022-08-05T13:14:28.000+03:00
diff --git a/primitives/examples/analytics_response.rs b/primitives/examples/analytics_response.rs
@@ -17,9 +17,7 @@ fn main() {
         "time": 1659592800,
         "value": "100000000",
         "segment": "country"
-      }],
-      "totalPages": 1,
-      "page": 0
+      }]
     });
 
     assert!(from_value::<AnalyticsResponse>(json).is_ok());
diff --git a/sentry/src/routes/analytics.rs b/sentry/src/routes/analytics.rs
@@ -19,7 +19,7 @@ use primitives::{
 };
 
 /// GET `/v5/analytics` routes
-/// with query parameters: [`primitives::analytics::AnalyticsQuery`].
+/// Request query parameters: [`primitives::analytics::AnalyticsQuery`].
 ///
 /// Response: [`primitives::sentry::AnalyticsResponse`]
 ///
diff --git a/sentry/src/routes/campaign.rs b/sentry/src/routes/campaign.rs
@@ -144,9 +144,9 @@ pub async fn fetch_campaign_ids_for_channel(
 
 /// POST `/v5/campaign`
 ///
-/// Expected request body: [`CreateCampaign`](`primitives::sentry::campaign_create::CreateCampaign`)
+/// Request body (json): [`CreateCampaign`](`primitives::sentry::campaign_create::CreateCampaign`)
 ///
-/// Expected response: [Campaign](`primitives::Campaign`)
+/// Response: [Campaign](`primitives::Campaign`)
 pub async fn create_campaign<C>(
     req: Request<Body>,
     app: &Application<C>,
@@ -374,10 +374,10 @@ pub mod update_campaign {
 
     /// POST `/v5/campaign/:id` (auth required)
     ///
-    /// Request body is [`ModifyCampaign`](`primitives::sentry::campaign_modify::ModifyCampaign`)
-    /// which consists of all the editable fields of the [`Campaign`]
+    /// Request body (json): [`ModifyCampaign`](`primitives::sentry::campaign_modify::ModifyCampaign`)
+    /// consists of all of the editable fields of the [`Campaign`]
     ///
-    /// Returns the updated [`Campaign`] serialized
+    /// Response[`Campaign`](`primitives::Campaign`)
     ///
     /// Ensures that the remaining funds for all campaigns <= total remaining funds (total deposited - total spent)
     ///
@@ -642,9 +642,15 @@ pub mod insert_events {
 
     /// POST `/v5/campaign/:id/events`
     ///
-    /// The expected request body is `Vec<[Event](primitives::Event)>`
+    /// Request body (json):
     ///
-    /// The expected Response is [`SuccessResponse`](primitives::sentry::SuccessResponse)
+    /// ```json
+    /// {
+    ///     "events": [[`Event`](`primitives::Event`)]
+    /// }
+    /// ```
+    ///
+    /// Response: [`SuccessResponse`](primitives::sentry::SuccessResponse)
     pub async fn handle_route<C: Locked + 'static>(
         req: Request<Body>,
         app: &Application<C>,
