Skip to content

Commit a386c41

Browse files
committed
added testing section
1 parent 256c7ce commit a386c41

File tree

7 files changed

+37
-12
lines changed

7 files changed

+37
-12
lines changed

.DS_Store

0 Bytes
Binary file not shown.

build/index.html

+19-6
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,9 @@
384384
<li>
385385
<a href="#authentication" class="toc-h1 toc-link" data-title="Authentication">Authentication</a>
386386
</li>
387+
<li>
388+
<a href="#testing" class="toc-h1 toc-link" data-title="Testing">Testing</a>
389+
</li>
387390
<li>
388391
<a href="#security" class="toc-h1 toc-link" data-title="Security">Security</a>
389392
</li>
@@ -626,6 +629,12 @@ <h1 id='authentication'>Authentication</h1>
626629
<aside class="notice">
627630
Rolled Secret Keys will remain valid for the duration specified before they are permanently expired.
628631
</aside>
632+
<h1 id='testing'>Testing</h1>
633+
<p>API requests may be tested in a live environment simply by using the API Test Key provided in the <a href="https://developer.paket.tv">Paket Developer Portal</a>. Test keys begin with the prefix <code>test_sk</code> and inherit the same behaviors as live API Secret Keys, save that they call test responses. </p>
634+
635+
<p>Test API requests are validated identically to live requests and although the response schema are identical to live requests, the responses themselves are dynamically generated. </p>
636+
637+
<p>The <code>Paket-Response-Type: Test</code> header indicates whether or not the response is via the API Test Key.</p>
629638
<h1 id='security'>Security</h1>
630639
<p>Securing API requests is critical to ensure data integrity. The Paket API employs the following methods to ensure that requests made to its API are authenticated and secure:</p>
631640

@@ -754,13 +763,17 @@ <h3 id='core-api-api-status-the-status-object'>The Status Object</h3>
754763
<p>The Status Object</p>
755764
</blockquote>
756765
<div class="highlight"><pre class="highlight plaintext"><code>{
757-
"message": "The API is healthy!"
766+
"message": "The API is healthy!",
767+
"client_id: "fab3d02606122a08"
758768
}
759769
</code></pre></div>
760770
<p><strong>Attributes</strong></p>
761771

762772
<p><strong><code>message</code></strong> <span style='margin: 0 5px;font-size:.9em'>string</span><br>
763-
The API Status.</p>
773+
The API Status message.</p>
774+
775+
<p><strong><code>client_id</code></strong> <span style='margin: 0 5px;font-size:.9em'>string</span><br>
776+
The unique identifier of the requesting Client.</p>
764777
<h3 id='core-api-api-status-retrieve-api-status'>Retrieve API Status</h3>
765778
<blockquote>
766779
<p>GET https://api.paket.tv/v1</p>
@@ -1256,7 +1269,7 @@ <h3 id='upnext-api-sessions-get-an-aggregated-list'>Get an Aggregated List</h3>
12561269
<p><strong>Parameters</strong></p>
12571270

12581271
<p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
1259-
Optional. Limits items returned (default is <code>50</code>).</p>
1272+
Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p>
12601273

12611274
<p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
12621275
Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
@@ -1317,7 +1330,7 @@ <h3 id='upnext-api-sessions-get-a-specific-list'>Get a Specific List</h3>
13171330
<p><strong>Parameters</strong></p>
13181331

13191332
<p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
1320-
Optional. Limits items returned (default is <code>50</code>).</p>
1333+
Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p>
13211334

13221335
<p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
13231336
Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
@@ -1363,7 +1376,7 @@ <h3 id='upnext-api-sessions-get-session-participants'>Get Session Participants</
13631376
<p><strong>Parameters</strong></p>
13641377

13651378
<p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
1366-
Optional. Limits items returned (default is <code>50</code>).</p>
1379+
Optional. Limits items returned (default and maximum is <code>50</code>).</p>
13671380

13681381
<p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
13691382
Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>
@@ -1673,7 +1686,7 @@ <h3 id='upnext-api-participants-get-a-participant-list'>Get a Participant List</
16731686
<p><strong>Parameters</strong></p>
16741687

16751688
<p><strong><code>limit</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
1676-
Optional. Limits items returned (default is <code>50</code>).</p>
1689+
Optional. Limits items returned (default is <code>50</code>, maximum is <code>200</code>).</p>
16771690

16781691
<p><strong><code>next_key</code></strong> <span style='margin: 0 5px;font-size:.9em'>integer</span><br>
16791692
Optional. Key returned in previous call if <a href="#pagination">additional items</a> are available.</p>

source/.DS_Store

0 Bytes
Binary file not shown.

source/includes/_core_api.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,18 @@ Retrieves the API status by making an authenticated `GET` request to the API's r
1818
1919
```
2020
{
21-
"message": "The API is healthy!"
21+
"message": "The API is healthy!",
22+
"client_id: "fab3d02606122a08"
2223
}
2324
```
2425

2526
**Attributes**
2627

2728
**`message`** <span style='margin: 0 5px;font-size:.9em'>string</span>
28-
The API Status.
29+
The API Status message.
30+
31+
**`client_id`** <span style='margin: 0 5px;font-size:.9em'>string</span>
32+
The unique identifier of the requesting Client.
2933

3034
### Retrieve API Status
3135

source/includes/_testing.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Testing
2+
3+
API requests may be tested in a live environment simply by using the API Test Key provided in the [Paket Developer Portal](https://developer.paket.tv). Test keys begin with the prefix `test_sk` and inherit the same behaviors as live API Secret Keys, save that they call test responses.
4+
5+
Test API requests are validated identically to live requests and although the response schema are identical to live requests, the responses themselves are dynamically generated.
6+
7+
The `Paket-Response-Type: Test` header indicates whether or not the response is via the API Test Key.

source/includes/_upnext_api.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ curl --location 'https://api.paket.tv/v1/upnext/sessions/:session_id' \
347347
**Parameters**
348348

349349
**`limit`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
350-
Optional. Limits items returned (default is `50`).
350+
Optional. Limits items returned (default is `50`, maximum is `200`).
351351

352352
**`next_key`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
353353
Optional. Key returned in previous call if [additional items](#pagination) are available.
@@ -415,7 +415,7 @@ curl --location 'https://api.paket.tv/v1/upnext/sessions/:session_id/:participan
415415
**Parameters**
416416

417417
**`limit`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
418-
Optional. Limits items returned (default is `50`).
418+
Optional. Limits items returned (default is `50`, maximum is `200`).
419419

420420
**`next_key`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
421421
Optional. Key returned in previous call if [additional items](#pagination) are available.
@@ -467,7 +467,7 @@ curl --location 'https://api.paket.tv/v1/upnext/sessions/:session_id/participant
467467
**Parameters**
468468

469469
**`limit`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
470-
Optional. Limits items returned (default is `50`).
470+
Optional. Limits items returned (default and maximum is `50`).
471471

472472
**`next_key`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
473473
Optional. Key returned in previous call if [additional items](#pagination) are available.
@@ -789,7 +789,7 @@ curl --location 'https://api.paket.tv/v1/upnext/participants/:participant_id' \
789789
**Parameters**
790790

791791
**`limit`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
792-
Optional. Limits items returned (default is `50`).
792+
Optional. Limits items returned (default is `50`, maximum is `200`).
793793

794794
**`next_key`** <span style='margin: 0 5px;font-size:.9em'>integer</span>
795795
Optional. Key returned in previous call if [additional items](#pagination) are available.

source/index.html.md

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ includes:
2121
- introduction
2222
- clients
2323
- authentication
24+
- testing
2425
- security
2526
- errors
2627
- idempotency

0 commit comments

Comments
 (0)