Skip to content

Commit 68459e4

Browse files
committed
Merge branch 'api-routes-documentation' into pr-review
2 parents ae42e68 + 72bb5af commit 68459e4

File tree

9 files changed

+7
-183
lines changed

9 files changed

+7
-183
lines changed

.DS_Store

10 KB
Binary file not shown.

sentry/.DS_Store

6 KB
Binary file not shown.

sentry/docs/create_campaign/examples.js

Lines changed: 0 additions & 61 deletions
This file was deleted.

sentry/docs/create_campaign/examples.rs

Lines changed: 0 additions & 88 deletions
This file was deleted.

sentry/docs/create_campaign/glossary.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

sentry/docs/create_campaign/tutorial.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

sentry/src/routes/analytics.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ use primitives::{
1919
};
2020

2121
/// GET `/v5/analytics` routes
22-
/// with query parameters: [`primitives::analytics::AnalyticsQuery`].
22+
/// Request query parameters: [`primitives::analytics::AnalyticsQuery`].
2323
///
2424
/// Response: [`primitives::sentry::AnalyticsResponse`]
2525
///

sentry/src/routes/campaign.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@ pub async fn fetch_campaign_ids_for_channel(
144144

145145
/// POST `/v5/campaign`
146146
///
147-
/// Expected request body: [`CreateCampaign`](`primitives::sentry::campaign_create::CreateCampaign`)
147+
/// Request body (json): [`CreateCampaign`](primitives::sentry::campaign_create::CreateCampaign)
148148
///
149-
/// Expected response: [`Campaign`](primitives::Campaign)
149+
/// Response: [`Campaign`](primitives::Campaign)
150150
pub async fn create_campaign<C>(
151151
req: Request<Body>,
152152
app: &Application<C>,
@@ -374,10 +374,10 @@ pub mod update_campaign {
374374

375375
/// POST `/v5/campaign/:id` (auth required)
376376
///
377-
/// Request body is [`ModifyCampaign`](`primitives::sentry::campaign_modify::ModifyCampaign`)
378-
/// which consists of all the editable fields of the [`Campaign`]
377+
/// Request body (json): [`ModifyCampaign`](`primitives::sentry::campaign_modify::ModifyCampaign`)
378+
/// consists of all of the editable fields of the [`Campaign`]
379379
///
380-
/// Returns the updated [`Campaign`] serialized
380+
/// Response[`Campaign`](`primitives::Campaign`)
381381
///
382382
/// Ensures that the remaining funds for all campaigns <= total remaining funds (total deposited - total spent)
383383
///

0 commit comments

Comments
 (0)