chore: replace with current

NillionNetwork · Jan 29, 2025 · 9289f5a · 9289f5a
1 parent d8f41f9
commit 9289f5a
Show file tree

Hide file tree

Showing 12 changed files with 1,166 additions and 397 deletions.
diff --git a/docs/api/nildb/delete-data-records-that-match-a-given-filter.api.mdx b/docs/api/nildb/delete-data-records-that-match-a-given-filter.api.mdx
@@ -1,71 +1,139 @@
 ---
 id: delete-data-records-that-match-a-given-filter
-title: "Delete data records that match a given filter"
-description: "Delete data records that match a given filter"
-sidebar_label: "Delete data records that match a given filter"
+title: 'Delete data records that match a given filter'
+description: 'Delete data records that match a given filter'
+sidebar_label: 'Delete'
 hide_title: true
 hide_table_of_contents: true
 api: eJytVl1vYjkM/StRXnZWKtDSltnlrTN0pO6Hppq2Mw8zfTA3BtLem9xNcmkR4r/vcS60UKqtdrU8QBI79rF97LDUkYsm2LTQw+9LffeQ8Hu7uj3QiaYRaz2iRBr7wH81HNMHb6C61IV3iV2SJdV1aQtK1rveXfROzmIx44pklRY166H24zsukj7QdfA1h2Q57uoZjkWwtViB+plqnJ1ziFSWC1nDubIGHu3EclATH1Sa4Shx1YXVtZeYgnVT7CGvCOh001gjcptKUbi5uRjpFeS2TBxew/cCh1OtRAWuA0cB4Kaqva6giB9LGQ4QBkQlaMgYKwaovNyJ9g1falLyox2XvPGJ4P2D+CO3UPe86MypRB5qsiEeqIcZB1b5KKqCnBrj4iTriqOuxLmJ+1Mb7yp/pJix9i62qPqHh/sFuEZyXVONESVsGl80FWKPSEPl5ywp/c8MECbZABtgl1mza5cV+fT5ZovjCfzJa3i/UmlNRqBQC5grOEZJHYfgQ/y/8CaxtDa5BzttF3mfioDHnWQr3qu8JFsEkmphdXagqCh8MBJD8vnYedNWdQ1gLwl/2JjERnu/QgZoyvG5PSgEWmArXZOvgyufJ7nzd1GvDt5q3AJY9qMFtrXXV2Sr1W2u34aT54JSb2p6tB/On7YtIWKxbi4FVr99u9aiv6s44pITK6ENCCpZi0gYJYXEFzNFaopZ4tZdqwVjmnnUU9c+5tAozbDrUW1786Oe2OmZbBPCyEEGUc5SE0rozVKq47DXc7Y0445BR3SxLIGl6zg9+HCvZYJuJuuVMKvNWp6vT4kRO+Igy7EfM4WMr1182hBHgt4fFqOLUQcS1eQcCT/Or/qng98xNaYefmdVHkvUQISpBbqzUexM7S0aufvDyeWaFqUno6oGzLGuKBvDwx+uoyylobqIscElJFLYGRNVtcj4sR6q88fahrbhnoTqnWS/wqQwbH4WVWrMUF1TmHLK9FWGC6AJKGaE5a2J/g7x5Cso+lB9LC0kP8U39TMbpIe/PL9P54/AUvJ2V+vjCf1yOhmcdE7fH73vnJwO+p3x8aTo9ItfB8eTwYAmNNBb74KYtW7ic7nWhEWRRx/U2eUFFIUSbSUOu/1uX5gvZKooDxNHuaD/lpc7JX6iSeLH1KtLsk68ZAou15T9jlFmBc2R3JapKUYycUHAmbAbOsvlmCLfhHK1kmN5qOS5x3JOeL3GEhwefVxgMhI9mI7XBq4/tjOzcy1IRB1vjcyRl/NT5kV746wouE7/qHu71YCXn6+E2+P1v4oqTxUd6EHmLr6HGgufM5IbKJ8tdUlu2uQpo1ubUi5h+lbaXnTT9pTD2NtCiPRkjWt/zw4pOliHkmSv89D6G5mfJuw=
-sidebar_class_name: "post api-method"
+sidebar_class_name: 'post api-method'
 info_path: api/nildb/nildb-api
 custom_edit_url: null
 ---
 
-import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
-import ParamsDetails from "@theme/ParamsDetails";
-import RequestSchema from "@theme/RequestSchema";
-import StatusCodes from "@theme/StatusCodes";
-import OperationTabs from "@theme/OperationTabs";
-import TabItem from "@theme/TabItem";
-import Heading from "@theme/Heading";
+import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint';
+import ParamsDetails from '@theme/ParamsDetails';
+import RequestSchema from '@theme/RequestSchema';
+import StatusCodes from '@theme/StatusCodes';
+import OperationTabs from '@theme/OperationTabs';
+import TabItem from '@theme/TabItem';
+import Heading from '@theme/Heading';
 
 <Heading
-  as={"h1"}
-  className={"openapi__heading"}
-  children={"Delete data records that match a given filter"}
->
-</Heading>
+  as={'h1'}
+  className={'openapi__heading'}
+  children={'Delete data records that match a given filter'}
+></Heading>
 
 <MethodEndpoint
-  method={"post"}
-  path={"/api/v1/data/delete"}
-  context={"endpoint"}
->
-
-</MethodEndpoint>
+  method={'post'}
+  path={'/api/v1/data/delete'}
+  context={'endpoint'}
+></MethodEndpoint>
 
+Delete data records that match a given filter
 
+:::info
+You may use this test Bearer token we have created for development
 
-Delete data records that match a given filter
+```
+eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ
+```
+
+:::
 
 <Heading
-  id={"request"}
-  as={"h2"}
-  className={"openapi-tabs__heading"}
-  children={"Request"}
->
-</Heading>
+  id={'request'}
+  as={'h2'}
+  className={'openapi-tabs__heading'}
+  children={'Request'}
+></Heading>
 
-<ParamsDetails
-  parameters={undefined}
->
-
-</ParamsDetails>
+<ParamsDetails parameters={undefined}></ParamsDetails>
 
 <RequestSchema
-  title={"Body"}
-  body={{"content":{"application/json":{"schema":{"type":"object","properties":{"schema":{"description":"A universally unique identifier for the item.","type":"string","format":"uuid","title":"UUID"},"filter":{"type":"object","description":"An object representing filter criteria for queries.","additionalProperties":{"type":"object","description":"A flexible object allowing any key-value pairs, where values can be of any type."},"title":"Filter"}}}}}}}
->
-
-</RequestSchema>
+  title={'Body'}
+  body={{
+    content: {
+      'application/json': {
+        schema: {
+          type: 'object',
+          properties: {
+            schema: {
+              description: 'A universally unique identifier for the item.',
+              type: 'string',
+              format: 'uuid',
+              title: 'UUID',
+            },
+            filter: {
+              type: 'object',
+              description:
+                'An object representing filter criteria for queries.',
+              additionalProperties: {
+                type: 'object',
+                description:
+                  'A flexible object allowing any key-value pairs, where values can be of any type.',
+              },
+              title: 'Filter',
+            },
+          },
+        },
+      },
+    },
+  }}
+></RequestSchema>
 
 <StatusCodes
   id={undefined}
   label={undefined}
-  responses={{"200":{"description":"The number of documents removed","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"number"}}}}}},"400":{"description":"Validation or processing errors","content":{"application/json":{"schema":{"type":"object","required":["ts","errors"],"properties":{"ts":{"type":"string","format":"date-time","description":"The time of the error according to the node."},"errors":{"description":"List of error messages","type":"array","items":{"anyOf":[{"type":"string"},{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}]}}},"title":"Error"}}}},"401":{"description":"Missing or invalid JWT"}}}
->
-
-</StatusCodes>
-
-
-
+  responses={{
+    '200': {
+      description: 'The number of documents removed',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            required: ['data'],
+            properties: { data: { type: 'number' } },
+          },
+        },
+      },
+    },
+    '400': {
+      description: 'Validation or processing errors',
+      content: {
+        'application/json': {
+          schema: {
+            type: 'object',
+            required: ['ts', 'errors'],
+            properties: {
+              ts: {
+                type: 'string',
+                format: 'date-time',
+                description: 'The time of the error according to the node.',
+              },
+              errors: {
+                description: 'List of error messages',
+                type: 'array',
+                items: {
+                  anyOf: [
+                    { type: 'string' },
+                    {
+                      type: 'object',
+                      properties: {
+                        code: { type: 'string' },
+                        message: { type: 'string' },
+                      },
+                    },
+                  ],
+                },
+              },
+            },
+            title: 'Error',
+          },
+        },
+      },
+    },
+    '401': { description: 'Missing or invalid JWT' },
+  }}
+></StatusCodes>
diff --git a/docs/api/nildb/get-health-status.api.mdx b/docs/api/nildb/get-health-status.api.mdx
@@ -1,63 +1,49 @@
 ---
 id: get-health-status
-title: "Check service health status"
-description: "Returns 200 OK if the service is healthy"
-sidebar_label: "Check service health status"
+title: 'Check service health status'
+description: 'Returns 200 OK if the service is healthy'
+sidebar_label: 'Health'
 hide_title: true
 hide_table_of_contents: true
 api: eJyVU8FuEzEQ/ZWRLxSpTaJIcNhbaQOEHopIEYc2h4k9yZp4bWPPtlmt8u+MN4GmCAmRS+w38zxvZt72ylDWyUa2watKfSFuk88wnUzg9gbsGrgmyJQerSawGWpCx3WnzlWIlLDQ5kaIG+KPQ2jByG2WOOMmq+peLbrM1KjluUqUY/CZBO6VVCh/L8sv/lZIB8/kuWQz7XgcHVpfblnX1OCAd5GEnjlZvxEK7bCJrkC3N2pffueqIa7DUaqkRORaLuNDHQFKk5SK5F61yUmsZo65Go+9dWZ1YagJIzk6kTryxE8hbdV+WYi6TZa7RZFzaO77E5/IKu+UAkNc7ivCREmQw+F9SA1Kvvr07U7AlxO5hOv59YVEoM3S27CO2WL65u0NoNsEqVs3sA4JsJWQZ6uRyQB5E4P1nEcPvpAjdi6ggabNDNZr1xqqHvwFWOQK5jm3QkIGttIBy/BKjHaxgtku2sOen4NwlkiHppEqZF6XVGxNBXeYZLbggyEwpEVNQmezvGxNkba2lOBM+hkoNucKrpyVyKv8z3xVVmj9OgxztTwsV7Zx/Q4uP89lbGV3h5FNRtPRVEl6DJkbHKzicZj8VU16+9vOh9VD/uXYF5Pvn333P1/FceUnRhUhg536o+Xu1dFyYp1aFBak71eY6Wty+32Bf7SUOsHl+IjJ4qp0e7+Ul4RqxDrFo1vqij+0plj8/Iiu/bPy8sT1H2Z3MsOf20VZNw==
-sidebar_class_name: "get api-method"
+sidebar_class_name: 'get api-method'
 info_path: api/nildb/nildb-api
 custom_edit_url: null
 ---
 
-import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
-import ParamsDetails from "@theme/ParamsDetails";
-import RequestSchema from "@theme/RequestSchema";
-import StatusCodes from "@theme/StatusCodes";
-import OperationTabs from "@theme/OperationTabs";
-import TabItem from "@theme/TabItem";
-import Heading from "@theme/Heading";
+import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint';
+import ParamsDetails from '@theme/ParamsDetails';
+import RequestSchema from '@theme/RequestSchema';
+import StatusCodes from '@theme/StatusCodes';
+import OperationTabs from '@theme/OperationTabs';
+import TabItem from '@theme/TabItem';
+import Heading from '@theme/Heading';
 
 <Heading
-  as={"h1"}
-  className={"openapi__heading"}
-  children={"Check service health status"}
->
-</Heading>
+  as={'h1'}
+  className={'openapi__heading'}
+  children={'Check service health status'}
+></Heading>
 
 <MethodEndpoint
-  method={"get"}
-  path={"/health"}
-  context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
+  method={'get'}
+  path={'/health'}
+  context={'endpoint'}
+></MethodEndpoint>
 
 Returns 200 OK if the service is healthy
 
-<ParamsDetails
-  parameters={undefined}
->
-
-</ParamsDetails>
+<ParamsDetails parameters={undefined}></ParamsDetails>
 
-<RequestSchema
-  title={"Body"}
-  body={undefined}
->
-
-</RequestSchema>
+<RequestSchema title={'Body'} body={undefined}></RequestSchema>
 
 <StatusCodes
   id={undefined}
   label={undefined}
-  responses={{"200":{"description":"Service is healthy","content":{"text/plain":{"schema":{"type":"string","example":"OK"}}}}}}
->
-
-</StatusCodes>
-
-
-      
+  responses={{
+    '200': {
+      description: 'Service is healthy',
+      content: { 'text/plain': { schema: { type: 'string', example: 'OK' } } },
+    },
+  }}
+></StatusCodes>
diff --git a/docs/api/nildb/get-node-details.api.mdx b/docs/api/nildb/get-node-details.api.mdx
@@ -2,7 +2,6 @@
 id: get-node-details
 title: 'About'
 description: 'Returns information about the node including its DID, public key and build details'
-sidebar_label: 'About'
 hide_title: true
 hide_table_of_contents: true
 api: eJy1VW1v2zYQ/iuEvqwFYluS3yR9S+esyDoUReNiwNJ8oMSTxYSiVJKK7Rr+77uTbCtuuhkYMCCIKR5599zd8xx3ngCbGVk7WWkv8T6Da4y2TOq8MiWnXcbTqnHMFcB0JQBNmWqE1CsmnWWL28UVq5tUyYw9wZZxLVjaSCWYAMelst6VV9VgWle3AkOswH1EP4uT2fGV9ZJ7725rHZTew5VnwNaVtoDbOy/0ffo5x3nXZBlYmzeKHQ+ztXRFB7EPnVXagXbkgNc1gmxxjB4tedl5Niug5LRy2xrQb5U+QuY8gvCtkQYEAbOOG4fLK6/NDH+FpP9d2h9gi+vGKEJeG0rWyQ768WLv3zqDlcPzXXlxR3AHAydLILdnOS5xEz2UNVsXoPsGrLllPSTY4AlFvkM/nAyCcBDMln6cjKPEnwz9ePqXtz8Cv5DnAUVWlaUk2zMYS1Be5dUe/G9JvWu54Y6p/TSBcLIMx8k0xr8W/AHQTwKe+34vHevOsoLbglWGSYHdl7kEcxYp8yd+ABDOIINxPg+m01zMoyiaRCnPgzDMhJj7IVZl31fhYnhi9S+W8Vqy452XMf1hOAy9/X7f0eeiuwVi085wJb+DYLenRNgb1NxbVuUnRpyFQd+JlipxWGANjtYKHQbQaAPNd+U2K7WJ880kHqvQRJDPjFCGNxNhhc4o4Z7WFzF+6oX/T3j8UAR5EEcij/lskuc8nGdhPI5mQcoziLLIT8UsDSCY+uD7UTib5/M8ngCHGGbZOPJbTCSvfyNcY+QrcF8+/0HKMdBLJ+OapYAjg6Pwz9VTOFcno5GqMq6Kyrok8iOf2rVvW1aCK6rD+CLpc1fgx6idjfhtwVDPUUW7Dmvrz6JDrL9IBwLKanhoxRDbsq7Mk7d/oIsZYnfbO5pEnboe1y+5Tn4oQGvH7xS4adncLX47VuD3P5evKnBN43mAFtZYGthUh5u7cDr7wLhaVRi3KBnWkPEGTcgvHI/INdCirqR2dvhV0+Wab1XFBSsb6w7jH5KvesAkdwm7tbbBS9z1qiYbbOqE3Wxq2Y3+3sjeGCCVYhQQb+kob0TCltxgaY/z+0h9i57lD9RvI1ubsF+VRAtK7tJ5jzpIT1o3vFzbcOzG4h27/nT7YtKdVIodRg6UvJW95m3l8W00Ep7hxzfmrOa7/sn5fx7TAy0cbNyoVlzqF/LoWHnvdaxEdhGRaWO3S7mFL0bt97T9rQGD6r7H5TM3kqdUkPsHdFQAF8guovETDQDvGt/Zun0MuGoo8KtnlFh8Usf7myUW+29fJ9Nw