Add accordion to API documentation
This commit is contained in:
joker-x
parent
de065f9db7
commit
bec0660d02
1 changed files with 124 additions and 41 deletions
|
|
@ -86,8 +86,13 @@ export default class API extends Component {
|
|||
</div>
|
||||
</div>
|
||||
|
||||
<h4>POST /api/subscribe/:listCid – {t('addSubscription')}</h4>
|
||||
|
||||
<div class="accordion" id="apicalls">
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<h4><button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moresubscribe"><h4>POST /api/subscribe/:listCid – {t('addSubscription')}</h4></button></h4>
|
||||
</div>
|
||||
<div id="moresubscribe" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallEitherInsertsANewSubscription')}
|
||||
</p>
|
||||
|
|
@ -136,8 +141,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
<pre>"data": ("id":"TTrw41znK")</pre>
|
||||
|
||||
<h4>POST /api/unsubscribe/:listCId – {t('removeSubscription')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moreunsubscribe"><h4>POST /api/unsubscribe/:listCId – {t('removeSubscription')}</h4></button>
|
||||
</div>
|
||||
<div id="moreunsubscribe" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallMarksASubscriptionAs')}
|
||||
</p>
|
||||
|
|
@ -168,9 +180,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
<pre>"data": ("id":"TTrw41znK", "unsubscribed":true)</pre>
|
||||
|
||||
|
||||
<h4>POST /api/delete/:listCId – {t('deleteSubscription')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moredelete"><h4>POST /api/delete/:listCId – {t('deleteSubscription')}</h4></button>
|
||||
</div>
|
||||
<div id="moredelete" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallDeletesASubscription')}
|
||||
</p>
|
||||
|
|
@ -200,10 +218,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
<pre>"data": ("id":"TTrw41znK", "deleted":true)</pre>
|
||||
|
||||
|
||||
|
||||
<h4>POST /api/field/:listId – {t('addNewCustomField')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morefield"><h4>POST /api/field/:listId – {t('addNewCustomField')}</h4></button>
|
||||
</div>
|
||||
<div id="morefield" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallCreatesANewCustomFieldForA')}
|
||||
</p>
|
||||
|
|
@ -253,10 +276,16 @@ export default class API extends Component {
|
|||
{t('Response example')}:
|
||||
</p>
|
||||
<pre>"data": ("id":22, "tag":"MERGE_COMMENT")</pre>
|
||||
|
||||
<h4>GET /api/blacklist/get – {t('getListOfBlacklistedEmails')}</h4>
|
||||
|
||||
<p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moreblacklistget"><h4>GET /api/blacklist/get – {t('getListOfBlacklistedEmails')}</h4></button>
|
||||
</div>
|
||||
<div id="moreblacklistget" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallGetListOfBlacklistedEmails')}
|
||||
</p>
|
||||
|
||||
|
|
@ -279,8 +308,15 @@ export default class API extends Component {
|
|||
|
||||
<pre>curl -XGET '{getUrl(`api/blacklist/get?access_token=${accessToken}&limit=10&start=10&search=gmail`)}' </pre>
|
||||
|
||||
<h4>POST /api/blacklist/add – {t('addEmailToBlacklist')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moreblacklistadd"><h4>POST /api/blacklist/add – {t('addEmailToBlacklist')}</h4></button>
|
||||
</div>
|
||||
<div id="moreblacklistadd" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallEitherAddEmailsToBlacklist')}
|
||||
</p>
|
||||
|
|
@ -305,9 +341,15 @@ export default class API extends Component {
|
|||
|
||||
<pre>curl -XPOST '{getUrl(`api/blacklist/add?access_token=${accessToken}`)}' \<br/>
|
||||
--data 'EMAIL=test@example.com'</pre>
|
||||
|
||||
<h4>POST /api/blacklist/delete – {t('deleteEmailFromBlacklist')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moreblacklistdelete"><h4>POST /api/blacklist/delete – {t('deleteEmailFromBlacklist')}</h4></button>
|
||||
</div>
|
||||
<div id="moreblacklistdelete" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('thisApiCallEitherDeleteEmailsFrom')}
|
||||
</p>
|
||||
|
|
@ -332,9 +374,15 @@ export default class API extends Component {
|
|||
|
||||
<pre>curl -XPOST '{getUrl(`api/blacklist/delete?access_token=${accessToken}`)}' \<br/>
|
||||
--data 'EMAIL=test@example.com'</pre>
|
||||
|
||||
<h4>GET /api/lists/:email – {t('getTheListsAUserHasSubscribedTo')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morelistsemail"><h4>GET /api/lists/:email – {t('getTheListsAUserHasSubscribedTo')}</h4></button>
|
||||
</div>
|
||||
<div id="morelistsemail" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('retrieveTheListsThatTheUserWithEmailHas')}
|
||||
</p>
|
||||
|
|
@ -351,10 +399,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
|
||||
<pre>curl -XGET '{getUrl(`api/lists/test@example.com?access_token=${accessToken}`)}'</pre>
|
||||
|
||||
|
||||
<h4>GET /api/lists-by-namespace/:namespaceId – {t('getListsInNamespace')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morelistsnamespace"><h4>GET /api/lists-by-namespace/:namespaceId – {t('getListsInNamespace')}</h4></button>
|
||||
</div>
|
||||
<div id="morelistsnamespace" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('retrieveTheListsThatTheNamespaceHas')}
|
||||
</p>
|
||||
|
|
@ -371,10 +424,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
|
||||
<pre>curl -XGET '{getUrl(`api/lists-by-namespace/1?access_token=${accessToken}`)}'</pre>
|
||||
|
||||
|
||||
<h4>POST /api/list – {t('createList')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morecreatelist"><h4>POST /api/list – {t('createList')}</h4></button>
|
||||
</div>
|
||||
<div id="morecreatelist" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('createListDescription')}
|
||||
</p>
|
||||
|
|
@ -438,9 +496,15 @@ export default class API extends Component {
|
|||
{t('Response example')}:
|
||||
</p>
|
||||
<pre>"data": ("id":"WSGjaP1fY")</pre>
|
||||
|
||||
<h4>DELETE /api/list/:listCId – {t('deleteList')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#moredeletelist"><h4>DELETE /api/list/:listCId – {t('deleteList')}</h4></button>
|
||||
</div>
|
||||
<div id="moredeletelist" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('deleteListDescription')}
|
||||
</p>
|
||||
|
|
@ -460,10 +524,16 @@ export default class API extends Component {
|
|||
<p>
|
||||
{t('Response example')}:
|
||||
</p>
|
||||
<pre>t('Empty object')</pre>
|
||||
|
||||
<h4>GET /api/rss/fetch/:campaignCid – {t('triggerFetchOfACampaign')}</h4>
|
||||
|
||||
<pre>{t('Empty object')}</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morerss"><h4>GET /api/rss/fetch/:campaignCid – {t('triggerFetchOfACampaign')}</h4></button>
|
||||
</div>
|
||||
<div id="morerss" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('forcesTheRssFeedCheckToImmediatelyCheck')}
|
||||
</p>
|
||||
|
|
@ -480,9 +550,15 @@ export default class API extends Component {
|
|||
</p>
|
||||
|
||||
<pre>curl -XGET '{getUrl(`api/rss/fetch/5OOnZKrp0?access_token=${accessToken}`)}'</pre>
|
||||
|
||||
<h4>POST /api/templates/:templateId/send – {t('sendTransactionalEmail')}</h4>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<button type="button" class="btn btn-link" data-toggle="collapse" data-target="#morerss"><h4>POST /api/templates/:templateId/send – {t('sendTransactionalEmail')}</h4></button>
|
||||
</div>
|
||||
<div id="morerss" class="collapse" data-parent="#apicalls">
|
||||
<div class="card-body">
|
||||
<p>
|
||||
{t('sendSingleEmailByTemplateWithGiven')}
|
||||
</p>
|
||||
|
|
@ -511,6 +587,13 @@ export default class API extends Component {
|
|||
|
||||
<pre>curl -XPOST '{getUrl(`api/templates/1/send?access_token=${accessToken}`)}' \<br/>
|
||||
--data 'EMAIL=test@example.com&SUBJECT=Test&TAGS[FOO]=bar&TAGS[TEST]=example'</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue