Skip to content

Commit

Permalink
Fix typos in comments (#1368)
Browse files Browse the repository at this point in the history 
Co-authored-by: Yatish Mehta <yatish@example.com>
  • Loading branch information
@yatish27
yatish27 and Yatish Mehta committed Jun 20, 2023
1 parent f94c1f3 commit 530165f
Show file tree
Hide file tree
Showing 10 changed files with 100 additions and 100 deletions.
54 changes: 27 additions & 27 deletions docs/docs/content/apis/campaigns.md
View file
@@ -1,16 +1,16 @@
# API / Campaigns

Method | Endpoint | Description
-------|---------------------------------------------------------------------------|-----------------------------
`GET` | [/api/campaigns](#get-apicampaigns) | Gets all campaigns.
`GET` | [/api/campaigns/:`campaign_id`](#get-apicampaignscampaign_id) | Gets a single campaign.
`GET` | [/api/campaigns/:`campaign_id`/preview](#get-apicampaignscampaign_idpreview) | Gets the HTML preview of a campaign body.
`GET` | [/api/campaigns/running/stats](#get-apicampaignsrunningstats) | Gets the stats of a given set of campaigns.
`POST` | [/api/campaigns](#post-apicampaigns) | Creates a new campaign.
`POST` | /api/campaigns/:`campaign_id`/test | Posts campaign message to arbitrary subscribers for testing.
`PUT` | /api/campaigns/:`campaign_id` | Modifies a campaign.
`PUT` | [/api/campaigns/:`campaign_id`/status](#put-apicampaignscampaign_idstatus) | Start / pause / cancel / schedule a campaign.
`DELETE` | [/api/campaigns/:`campaign_id`](#delete-apicampaignscampaign_id) | Deletes a campaign.
Method | Endpoint | Description
---------|------------------------------------------------------------------------------|-------------------------------------------------------------
`GET` | [/api/campaigns](#get-apicampaigns) | Gets all campaigns.
`GET` | [/api/campaigns/:`campaign_id`](#get-apicampaignscampaign_id) | Gets a single campaign.
`GET` | [/api/campaigns/:`campaign_id`/preview](#get-apicampaignscampaign_idpreview) | Gets the HTML preview of a campaign body.
`GET` | [/api/campaigns/running/stats](#get-apicampaignsrunningstats) | Gets the stats of a given set of campaigns.
`POST` | [/api/campaigns](#post-apicampaigns) | Creates a new campaign.
`POST` | /api/campaigns/:`campaign_id`/test | Posts campaign message to arbitrary subscribers for testing.
`PUT` | /api/campaigns/:`campaign_id` | Modifies a campaign.
`PUT` | [/api/campaigns/:`campaign_id`/status](#put-apicampaignscampaign_idstatus) | Start / pause / cancel / schedule a campaign.
`DELETE` | [/api/campaigns/:`campaign_id`](#delete-apicampaignscampaign_id) | Deletes a campaign.

#### ```GET``` /api/campaigns

Expand Down Expand Up @@ -83,9 +83,9 @@ Name | Type | Required/Optional | Description
Gets a single campaign.

##### Parameters
Name | Parameter Type | Data Type | Required/Optional | Description
------------|-------------------|--------------|----------------------|-----------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign you want to get.
Name | Parameter Type | Data Type | Required/Optional | Description
--------------|----------------|-----------|-------------------|-----------------------------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign you want to get.


##### Example Request
Expand Down Expand Up @@ -142,9 +142,9 @@ Gets the html preview of a campaign body.

##### Parameters

Name | Parameter Type | Data Type | Required/Optional | Description
------------|-------------------|--------------|----------------------|-----------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign to be previewed.
Name | Parameter Type | Data Type | Required/Optional | Description
--------------|----------------|-----------|-------------------|----------------------------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign to be previewed.


##### Example Request
Expand All @@ -166,9 +166,9 @@ Gets the running stat of a given set of campaigns.

##### Parameters

Name | Parameter Type | Data Type | Required/Optional | Description
------------|------------------|------------|---------------------|--------------------------------
campaign_id | Query Parameters | Number | Required | The id values of the campaigns whose stat you want to get.
Name | Parameter Type | Data Type | Required/Optional | Description
------------|------------------|-----------|-------------------|-----------------------------------------------------------
campaign_id | Query Parameters | Number | Required | The id values of the campaigns whose stat you want to get.


##### Example Request
Expand Down Expand Up @@ -259,10 +259,10 @@ Modifies a campaign status to start, pause, cancel, or schedule a campaign.

##### Parameters

Name | Parameter Type | Data Type | Required/Optional | Description
------------------|-------------------------|---------------------------|----------------------|-----------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign whose status is to be modified.
`status` | Request Body | String | Required | `scheduled`, `running`, `paused`, `cancelled`.
Name | Parameter Type | Data Type | Required/Optional | Description
--------------|----------------|-----------|-------------------|-------------------------------------------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign whose status is to be modified.
`status` | Request Body | String | Required | `scheduled`, `running`, `paused`, `cancelled`.


###### Note:
Expand Down Expand Up @@ -324,9 +324,9 @@ Deletes a campaign, only scheduled campaigns that have not yet been started can

##### Parameters

Name | Parameter Type | Data Type | Required/Optional | Description
---------|--------------------|----------------|---------------------|------------------------------
`campaign_id`| Path Parameter | Number | Required | The id value of the campaign you want to delete.
Name | Parameter Type | Data Type | Required/Optional | Description
--------------|----------------|-----------|-------------------|-------------------------------------------------
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign you want to delete.


##### Example Request
Expand Down
20 changes: 10 additions & 10 deletions docs/docs/content/apis/import.md
View file
@@ -1,11 +1,11 @@
# API / Import

Method | Endpoint | Description
-----------|----------------------------------------------------------------------|--------------
`GET` | [api/import/subscribers](#get-apiimportsubscribers) | Gets a import statistics.
`GET` | [api/import/subscribers/logs](#get-apiimportsubscriberslogs) | Get a import statistics .
`POST` | [api/import/subscribers](#post-apiimportsubscribers) | Upload a ZIP file or CSV file to bulk import subscribers.
`DELETE` | [api/import/subscribers](#delete-apiimportsubscribers) | Stops and deletes a import.
Method | Endpoint | Description
---------|--------------------------------------------------------------|----------------------------------------------------------
`GET` | [api/import/subscribers](#get-apiimportsubscribers) | Gets a import statistics.
`GET` | [api/import/subscribers/logs](#get-apiimportsubscriberslogs) | Get a import statistics .
`POST` | [api/import/subscribers](#post-apiimportsubscribers) | Upload a ZIP file or CSV file to bulk import subscribers.
`DELETE` | [api/import/subscribers](#delete-apiimportsubscribers) | Stops and deletes a import.


#### **`GET`** api/import/subscribers
Expand Down Expand Up @@ -51,10 +51,10 @@ Post a CSV (optionally zipped) file to do a bulk import. The request should be a

##### Parameters

Name | Parameter type | Data type | Required/Optional | Description
---------|----------------|----------------|-------------------|-----------------------
`params` | Request body | String | Required | Stringified JSON with import params
`file` | Request body | File | Required | File to upload
Name | Parameter type | Data type | Required/Optional | Description
---------|----------------|-----------|-------------------|------------------------------------
`params` | Request body | String | Required | Stringified JSON with import params
`file` | Request body | File | Required | File to upload

***params*** (JSON string)

Expand Down
52 changes: 26 additions & 26 deletions docs/docs/content/apis/media.md
View file
@@ -1,9 +1,9 @@
# API / Media
Method | Endpoint | Description
--------------|--------------------------------------------------------------|----------------------------------------------
`GET` | [/api/media](#get-apimedia) | Gets an uploaded media file.
`POST` | [/api/media](#post-apimedia) | Uploads a media file.
`DELETE` | [/api/media/:`media_id`](#delete-apimediamedia_id) | Deletes uploaded media files.
Method | Endpoint | Description
---------|----------------------------------------------------|------------------------------
`GET` | [/api/media](#get-apimedia) | Gets an uploaded media file.
`POST` | [/api/media](#post-apimedia) | Uploads a media file.
`DELETE` | [/api/media/:`media_id`](#delete-apimediamedia_id) | Deletes uploaded media files.

#### **`GET`** /api/media
Gets an uploaded media file.
Expand Down Expand Up @@ -33,23 +33,23 @@ curl -u "username:username" -X GET 'http://localhost:9000/api/media' \
Response definitions
The following table describes each item in the response.

|Response item |Description |Data type |
|:---------------:|:------------|:----------:|
|data|Array of the media file objects, which contains an information about the uploaded media files|array|
|id|Media file object ID|number (int)|
|uuid|Media file uuuid|string (uuid)|
|filename|Name of the media file|string|
|created_at|Date and time, when the media file object was created|String (localDateTime)|
|thumb_uri|The thumbnail URI of the media file|string|
|uri|URI of the media file|string|
| Response item | Description | Data type |
|:-------------:|:----------------------------------------------------------------------------------------------|:----------------------:|
| data | Array of the media file objects, which contains an information about the uploaded media files | array |
| id | Media file object ID | number (int) |
| uuid | Media file uuid | string (uuid) |
| filename | Name of the media file | string |
| created_at | Date and time, when the media file object was created | String (localDateTime) |
| thumb_uri | The thumbnail URI of the media file | string |
| uri | URI of the media file | string |

#### **`POST`** /api/media
Uploads a media file.

##### Parameters
Nam | Parameter Type | Data Type | Required/Optional | Description
-----------|-----------------------|-------------------|-------------------------|---------------------------------
file | Request body | Media file | Required | The media file to be uploaded.
Name | Parameter Type | Data Type | Required/Optional | Description
-----|----------------|------------|-------------------|-------------------------------
file | Request body | Media file | Required | The media file to be uploaded.


##### Example Request
Expand All @@ -74,17 +74,17 @@ curl -u "username:username" -X POST 'http://localhost:9000/api/media' \
```
Response definitions

|Response item |Description |Data type |
|:---------------:|:------------:|:----------:|
|data|True means that the media file was successfully uploaded |boolean|
| Response item | Description | Data type |
|:-------------:|:--------------------------------------------------------:|:---------:|
| data | True means that the media file was successfully uploaded | boolean |

#### **`DELETE`** /api/media/:`media_id`
Deletes an uploaded media file.

##### Parameters
Name | Parameter Type | Data Type | Required/Optional | Description
----------------|-------------------------|--------------------|-------------------------|--------------------------
`Media_id` | Path Parameter | Number | Required | The id of the media file you want to delete.
Name | Parameter Type | Data Type | Required/Optional | Description
-----------|----------------|-----------|-------------------|---------------------------------------------
`Media_id` | Path Parameter | Number | Required | The id of the media file you want to delete.


##### Example Request
Expand All @@ -102,6 +102,6 @@ curl -u "username:username" -X DELETE 'http://localhost:9000/api/media/1'

Response definitions

|Response item |Description |Data type |
|:---------------:|:------------:|:----------:|
|data|True means that the media file was successfully deleted |boolean|
| Response item | Description | Data type |
|:-------------:|:-------------------------------------------------------:|:---------:|
| data | True means that the media file was successfully deleted | boolean |
16 changes: 8 additions & 8 deletions docs/docs/content/apis/subscribers.md
View file
Expand Up @@ -283,12 +283,12 @@ Creates a new subscriber.

Name | Parameter type | Data type | Required/Optional | Description
-------------------------|------------------|------------|-------------------|----------------------------
email | Request body | String | Required | The email address of the new susbcriber.
email | Request body | String | Required | The email address of the new subscriber.
name | Request body | String | Required | The name of the new subscriber.
status | Request body | String | Required | The status of the new subscriber. Can be enabled, disabled or blocklisted.
lists | Request body | Numbers | Optional | Array of list IDs to subscribe to (marked as `unconfirmed` by default).
attribs | Request body | json | Optional | JSON list containing new subscriber's attributes.
preconfirm_subscriptions | Request body | Bool | Optional | If `true`, marks subscriptsions as `confirmed` and no-optin e-mails are sent for double opt-in lists.
preconfirm_subscriptions | Request body | Bool | Optional | If `true`, marks subscriptions as `confirmed` and no-optin e-mails are sent for double opt-in lists.

##### Example Request
```shell
Expand Down Expand Up @@ -325,12 +325,12 @@ Modify subscribers list memberships.

##### Parameters

Name | Paramter type | Data type | Required/Optional | Description
------------------|---------------|-----------|--------------------|-------------------------------------------------------
`ids` | Request body | Numbers | Required | The ids of the subscribers to be modified.
`action` | Request body | String | Required | Wether to `add`, `remove`, or `unsubscribe` the users.
`target_list_ids` | Request body | Numbers | Required | The ids of the lists to be modified.
`status` | Request body | String | Required for `add` | `confirmed`, `unconfirmed`, or `unsubscribed` status.
Name | Parameter type | Data type | Required/Optional | Description
------------------|----------------|-----------|--------------------|-------------------------------------------------------
`ids` | Request body | Numbers | Required | The ids of the subscribers to be modified.
`action` | Request body | String | Required | Whether to `add`, `remove`, or `unsubscribe` the users.
`target_list_ids` | Request body | Numbers | Required | The ids of the lists to be modified.
`status` | Request body | String | Required for `add` | `confirmed`, `unconfirmed`, or `unsubscribed` status.

##### Example Request

Expand Down

0 comments on commit 530165f

Please sign in to comment.