nillion-docs/sidebar-api.js at main · deepugami/nillion-docs · GitHub

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
module.exports = [
  {
    type: 'html',
    className: 'sidebar-title',
    value: 'API',
    defaultStyle: true,
  },
  'api/overview',
  {
    type: 'category',
    label: 'NilDB API',
    items: [
      'api/nildb/overview',
      {
        type: 'category',
        label: 'System',
        items: [
          'api/nildb/get-health-status', // Health
          'api/nildb/get-node-details', // About
          'api/nildb/retrieve-an-organizations-account-details', // Accounts
        ],
      },
      {
        type: 'category',
        label: 'Data',
        items: [
          'api/nildb/upload-data-to-the-specified-schema-collection', // Upload /
          'api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter', // Read
          'api/nildb/retrieve-recently-added-documents-from-a-schema-collection', // Tail
          'api/nildb/update-documents-within-a-schema-collection-that-match-the-given-filter', // Update
          'api/nildb/delete-data-records-that-match-a-given-filter', // Detail
          'api/nildb/remove-all-documents-in-a-schema-collection', // Flush
          'api/nildb/list-the-organizations-schemas', // List Schemas
        ],
      },
      {
        type: 'category',
        label: 'Queries',
        items: [
          'api/nildb/list-the-organizations-queries', // List
          'api/nildb/execute-the-specified-query', // Execute
        ],
      },
    ],
  },
];