Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* Admin API Docs Endpoints
* API documentation collections, history, and saved requests
*/
import type { ApiEndpoint } from '@/types/api-docs';
export const adminApiDocsEndpoints: ApiEndpoint[] = [
{
id: 'admin-api-docs-collections-list',
method: 'GET',
path: '/api/admin/api-docs/collections',
summary: 'List API collections',
description: 'Returns saved API request collections',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
responses: [
{ status: 200, description: 'List of collections' },
],
},
{
id: 'admin-api-docs-collections-create',
method: 'POST',
path: '/api/admin/api-docs/collections',
summary: 'Create collection',
description: 'Creates a new API request collection',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'name', type: 'string', required: true, description: 'Collection name' },
{ name: 'description', type: 'string', required: false, description: 'Collection description' },
],
},
responses: [
{ status: 201, description: 'Collection created' },
],
},
{
id: 'admin-api-docs-collections-delete',
method: 'DELETE',
path: '/api/admin/api-docs/collections',
summary: 'Delete collection',
description: 'Deletes an API request collection',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'id', type: 'string', required: true, description: 'Collection ID' },
],
},
responses: [
{ status: 200, description: 'Collection deleted' },
{ status: 404, description: 'Collection not found' },
],
},
{
id: 'admin-api-docs-history',
method: 'GET',
path: '/api/admin/api-docs/history',
summary: 'Get request history',
description: 'Returns history of API requests made in the playground',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
parameters: [
{ name: 'limit', type: 'number', required: false, location: 'query', description: 'Number of entries' },
],
responses: [
{ status: 200, description: 'Request history' },
],
},
{
id: 'admin-api-docs-saved-requests-list',
method: 'GET',
path: '/api/admin/api-docs/saved-requests',
summary: 'List saved requests',
description: 'Returns saved API requests',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
parameters: [
{ name: 'collectionId', type: 'string', required: false, location: 'query', description: 'Filter by collection' },
],
responses: [
{ status: 200, description: 'List of saved requests' },
],
},
{
id: 'admin-api-docs-saved-requests-create',
method: 'POST',
path: '/api/admin/api-docs/saved-requests',
summary: 'Save request',
description: 'Saves an API request for later use',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'name', type: 'string', required: true, description: 'Request name' },
{ name: 'method', type: 'string', required: true, description: 'HTTP method' },
{ name: 'path', type: 'string', required: true, description: 'API path' },
{ name: 'headers', type: 'object', required: false, description: 'Request headers' },
{ name: 'body', type: 'object', required: false, description: 'Request body' },
{ name: 'collectionId', type: 'string', required: false, description: 'Collection to add to' },
],
},
responses: [
{ status: 201, description: 'Request saved' },
],
},
{
id: 'admin-api-docs-saved-requests-delete',
method: 'DELETE',
path: '/api/admin/api-docs/saved-requests',
summary: 'Delete saved request',
description: 'Deletes a saved API request',
category: 'admin-api-docs',
requiresAuth: true,
adminOnly: true,
requestBody: {
contentType: 'application/json',
fields: [
{ name: 'id', type: 'string', required: true, description: 'Request ID' },
],
},
responses: [
{ status: 200, description: 'Request deleted' },
],
},
];
|