diff --git a/apispec/nildb/accounts.openapi.yaml b/apispec/nildb/accounts.openapi.yaml new file mode 100644 index 0000000..ca6ce81 --- /dev/null +++ b/apispec/nildb/accounts.openapi.yaml @@ -0,0 +1,187 @@ +# components: +# schemas: +# Account: +# type: object +# required: +# - _id +# - _type +# - _created +# - _updated +# - publicKey +# - name +# - schemas +# - queries +# properties: +# _id: +# description: The accounts decentralised identifier (DID) +# type: string +# example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' +# _type: +# type: string +# enum: ['admin', 'organization'] +# _created: +# type: string +# format: date-time +# _updated: +# type: string +# format: date-time +# publicKey: +# type: string +# name: +# type: string +# schemas: +# description: A list of schema ids that belong to this account +# type: array +# items: +# $ref: './base.openapi.yaml#/components/schemas/UUID' +# queries: +# description: A list of query ids that belong to this account +# type: array +# items: +# $ref: './base.openapi.yaml#/components/schemas/UUID' + +# paths: +# /api/v1/accounts: +# get: +# summary: Get account information +# description: Retrieve an organization's account details +# tags: +# - Accounts +# security: +# - jwt: [] +# responses: +# '200': +# description: "The organization's account details" +# content: +# application/json: +# schema: +# type: object +# required: +# - data +# properties: +# data: +# $ref: '#/components/schemas/Account' +# '400': +# $ref: './base.openapi.yaml#/components/responses/400' +# '401': +# $ref: './base.openapi.yaml#/components/responses/401' +# '500': +# $ref: './base.openapi.yaml#/components/responses/500' + +openapi: 3.0.0 +info: + title: nilDB API - Accounts + version: 0.5.0 + description: Account management for nilDB API +servers: + - url: https://nildb-demo.nillion.network/api/v1/ +tags: + - name: Accounts + description: Account operations + +components: + securitySchemes: + jwt: + type: http + scheme: bearer + bearerFormat: JWT + description: | + A DID-JWT using the ES256K algorithm for authenticated endpoints. + schemas: + UUID: + description: A universally unique identifier + type: string + format: uuid + Account: + type: object + required: + - _id + - _type + - _created + - _updated + - publicKey + - name + - schemas + - queries + properties: + _id: + description: The accounts decentralised identifier (DID) + type: string + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + _type: + type: string + enum: ['admin', 'organization'] + _created: + type: string + format: date-time + _updated: + type: string + format: date-time + publicKey: + type: string + name: + type: string + schemas: + description: A list of schema ids that belong to this account + type: array + items: + $ref: '#/components/schemas/UUID' + queries: + description: A list of query ids that belong to this account + type: array + items: + $ref: '#/components/schemas/UUID' + responses: + '400': + description: Validation or processing errors + content: + application/json: + schema: + type: object + properties: + ts: + type: string + format: date-time + errors: + type: array + items: + oneOf: + - type: string + - type: object + properties: + code: + type: string + message: + type: string + '401': + description: Missing or invalid JWT + '500': + description: Internal server error + +paths: + /api/v1/accounts: + get: + summary: Get account information + description: Retrieve an organization's account details + tags: + - Accounts + security: + - jwt: [] + responses: + '200': + description: "The organization's account details" + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + $ref: '#/components/schemas/Account' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' diff --git a/apispec/nildb/base.openapi.yaml b/apispec/nildb/base.openapi.yaml new file mode 100644 index 0000000..59b83ba --- /dev/null +++ b/apispec/nildb/base.openapi.yaml @@ -0,0 +1,165 @@ +openapi: 3.0.0 +info: + title: nilDB API + version: 0.5.0 + description: | + Visit [docs.nillion.com](https://docs.nillion.com) and [github.com/NillionNetwork/nildb](https://github.com/NillionNetwork/nildb) to learn more. + +servers: + - url: / + +tags: + - name: Accounts + description: Account details + - name: Data + description: Create, read, update and delete data for specified schemas + - name: Query + description: Manage and execute queries + - name: Schema + description: Manage your schemas + - name: Node + description: Node information + - name: Beta + description: Features under incubation + +components: + securitySchemes: + jwt: + type: http + scheme: bearer + bearerFormat: JWT + description: | + A DID-JWT using the ES256K algorithm for authenticated endpoints. + JWT payload must include: + - iat: Issued at timestamp + - exp: Expiration timestamp (recommended) + - aud: Target node decentralised identifier (DID) + - iss: Client's decentralised identifier (DID) + schemas: + UUID: + description: A universally unique identifier for the item. + type: string + format: uuid + Filter: + type: object + minProperties: 1 + additionalProperties: true + description: MongoDB-style query filter + DocumentBase: + type: object + properties: + _id: + $ref: '#/components/schemas/UUID' + _created: + type: string + format: date-time + description: The creation timestamp. + _updated: + type: string + format: date-time + description: The last update timestamp. + required: + - _id + - _created + - _updated + Schema: + allOf: + - $ref: '#/components/schemas/DocumentBase' + - type: object + required: + - name + - owner + - schema + properties: + name: + description: A user friendly schema name + type: string + owner: + description: The decentralised identifier (DID) of the owning organization + type: string + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + schema: + description: The json schema used to validate data before insertion into the schema collection + type: object + + DataDocument: + allOf: + - $ref: '#/components/schemas/DocumentBase' + - type: object + additionalProperties: true + description: The document's additional properties. Schema dependent. + + Error: + type: object + required: + - ts + - errors + properties: + ts: + type: string + format: date-time + description: The error's timestamp. + errors: + description: A list of error messages + type: array + items: + anyOf: + - type: string + - type: object + properties: + code: + type: string + message: + type: string + responses: + 201: + description: Resource created + 204: + description: Resource deleted + 400: + description: Validation or processing errors + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 401: + description: Missing or invalid JWT + 404: + description: Resource not found + 500: + description: Internal server error + +paths: + # Account endpoints + /api/v1/accounts: + $ref: './accounts.openapi.yaml#/paths/~1api~1v1~1accounts' + + # # Schema endpoints + # /api/v1/schemas: + # $ref: './schemas.openapi.yaml#/paths/~1api~1v1~1schemas' + + # # Query endpoints + # /api/v1/queries: + # $ref: './queries.openapi.yaml#/paths/~1api~1v1~1queries' + # /api/v1/queries/execute: + # $ref: './queries.openapi.yaml#/paths/~1api~1v1~1queries~1execute' + + # # Data endpoints + # /api/v1/data/create: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1create' + # /api/v1/data/read: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1read' + # /api/v1/data/update: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1update' + # /api/v1/data/tail: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1tail' + # /api/v1/data/delete: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1delete' + # /api/v1/data/flush: + # $ref: './data.openapi.yaml#/paths/~1api~1v1~1data~1flush' + + # # System endpoints + # /health: + # $ref: './system.openapi.yaml#/paths/~1health' + # /about: + # $ref: './system.openapi.yaml#/paths/~1about' diff --git a/apispec/nildb/data.openapi.yaml b/apispec/nildb/data.openapi.yaml new file mode 100644 index 0000000..49232e2 --- /dev/null +++ b/apispec/nildb/data.openapi.yaml @@ -0,0 +1,272 @@ +paths: + /api/v1/data/create: + post: + summary: Upload data + description: Upload data to the specified schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - data + properties: + schema: + description: The schema's uuid used to validate data + type: string + format: uuid + data: + type: array + items: + type: object + additionalProperties: + description: An object whose shape matches the targeted schema. + type: object + responses: + '200': + description: The outcome of the data upload operation. The operation can be partially successful. + content: + application/json: + schema: + type: object + required: + - created + - errors + properties: + created: + description: The uuids from successfully created documents + type: array + items: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + errors: + type: array + items: + type: object + required: + - error + - document + properties: + error: + type: string + document: + type: object + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' + /api/v1/data/read: + post: + summary: Read data + description: Retrieve data from the specified schema collection that matches the provided filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - filter + properties: + schema: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + filter: + $ref: '../docs/base.openapi.yaml#/components/schemas/Filter' + responses: + '200': + description: Data documents that match the provided filter. Pagination is not supported. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '../docs/base.openapi.yaml#/components/schemas/DataDocument' + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' + /api/v1/data/update: + post: + summary: Update data + description: Update documents within a schema collection that match the given filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - filter + - update + properties: + schema: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + filter: + $ref: '../docs/base.openapi.yaml#/components/schemas/Filter' + update: + additionalProperties: + type: object + description: A flexible object allowing any key-value pairs, where values can be of any type. + responses: + '200': + description: The result of the update operation + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + required: + - matchedCount + - modifiedCount + properties: + matched: + type: number + updated: + type: number + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' + /api/v1/data/tail: + post: + summary: List new data + description: List recently added documents from a schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + properties: + schema: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + responses: + '200': + description: The last 25 latest documents added to the schema collection + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '../docs/base.openapi.yaml#/components/schemas/DataDocument' + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' + /api/v1/data/delete: + post: + summary: Delete data + description: Delete data records that match a given filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + filter: + $ref: '../docs/base.openapi.yaml#/components/schemas/Filter' + responses: + '200': + description: The result of the delete operations + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + deletedCount: + type: number + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' + /api/v1/data/flush: + post: + summary: Delete all data + description: Remove all documents in a schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + properties: + schema: + $ref: '../docs/base.openapi.yaml#/components/schemas/UUID' + responses: + '200': + description: The total documents removed + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + properties: + deletedCount: + type: number + '400': + $ref: '../docs/base.openapi.yaml#/components/responses/400' + '401': + $ref: '../docs/base.openapi.yaml#/components/responses/401' + '500': + $ref: '../docs/base.openapi.yaml#/components/responses/500' diff --git a/apispec/nildb/nildb-combined.yaml b/apispec/nildb/nildb-combined.yaml new file mode 100644 index 0000000..0e311a5 --- /dev/null +++ b/apispec/nildb/nildb-combined.yaml @@ -0,0 +1,836 @@ +openapi: 3.0.0 +info: + title: nilDB API + version: 0.4.0 + description: | + Visit [docs.nillion.com](https://docs.nillion.com) and [github.com/NillionNetwork/nildb](https://github.com/NillionNetwork/nildb) to learn more. + +servers: + - url: https://nildb-demo.nillion.network + +tags: + - name: Accounts + description: Account details + - name: Data + description: Create, read, update and delete data for specified schemas + - name: Query + description: Manage and execute queries + - name: Schema + description: Manage your schemas + - name: Node + description: Node information + +components: + securitySchemes: + jwt: + type: http + scheme: bearer + bearerFormat: JWT + description: | + A DID-JWT using the ES256K algorithm for authenticated endpoints. + JWT payload must include: + - iat: Issued at timestamp + - exp: Expiration timestamp (recommended) + - aud: Target node decentralised identifier (DID) + - iss: Client's decentralised identifier (DID) + schemas: + UUID: + description: A universally unique identifier for the item. + type: string + format: uuid + Filter: + type: object + minProperties: 1 + additionalProperties: true + description: MongoDB-style query filter + DocumentBase: + type: object + properties: + _id: + $ref: '#/components/schemas/UUID' + _created: + type: string + format: date-time + description: The creation timestamp. + _updated: + type: string + format: date-time + description: The last update timestamp. + required: + - _id + - _created + - _updated + Schema: + allOf: + - $ref: '#/components/schemas/DocumentBase' + - type: object + required: + - name + - owner + - schema + properties: + name: + description: A user friendly schema name + type: string + owner: + description: The decentralised identifier (DID) of the owning organization + type: string + example: did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc + schema: + description: The json schema used to validate data before insertion into the schema collection + type: object + DataDocument: + allOf: + - $ref: '#/components/schemas/DocumentBase' + - type: object + additionalProperties: true + description: The document's additional properties. Schema dependent. + Error: + type: object + required: + - ts + - errors + properties: + ts: + type: string + format: date-time + description: The error's timestamp. + errors: + description: A list of error messages + type: array + items: + anyOf: + - type: string + - type: object + properties: + code: + type: string + message: + type: string + Account: + type: object + required: + - _id + - _type + - _created + - _updated + - publicKey + - name + - schemas + - queries + properties: + _id: + description: The accounts decentralised identifier (DID) + type: string + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + _type: + type: string + enum: ['admin', 'organization'] + _created: + type: string + format: date-time + _updated: + type: string + format: date-time + publicKey: + type: string + name: + type: string + schemas: + description: A list of schema ids that belong to this account + type: array + items: + $ref: '#/components/schemas/UUID' + queries: + description: A list of query ids that belong to this account + type: array + items: + $ref: '#/components/schemas/UUID' + AboutNode: + type: object + required: + - started + - build + - did + - publicKey + - url + properties: + started: + type: string + format: date-time + description: Timestamp when the node was started + example: '2024-12-16T09:38:04.095Z' + build: + type: object + required: + - time + - commit + - version + properties: + time: + type: string + format: date-time + description: Build timestamp + example: '2024-12-24T23:59:59Z' + commit: + type: string + description: Git commit hash or identifier + example: c0401ee26ece3f7155fd788848baf122cdd702ed + version: + type: string + description: Node's api version + example: 0.4.0 + did: + type: string + description: Decentralized Identifier (DID) of the node + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + publicKey: + type: string + description: Public key of the node + example: 02d1f198df9a64ffa27c293861bace8c80bd6b1e150e008267f7f94eae9e6c380c + url: + type: string + format: uri + description: URL where the node can be reached + example: 'https://nildb-demo.nillion.network' + Query: + allOf: + - $ref: '#/components/schemas/DocumentBase' + - type: object + required: + - name + - owner + - schema + - variables + properties: + name: + description: A user friendly query name + type: string + owner: + description: The decentralised identifier (DID) of the owning organization + type: string + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + schema: + description: The starting schema collection for this query's aggregation pipeline + type: string + format: uuid + variables: + description: The query's required runtime variables + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariable' + - $ref: '#/components/schemas/QueryArrayVariable' + pipeline: + description: An query's execution pipline defined as an array of objects + type: array + items: + type: object + QueryVariable: + type: object + required: + - type + - description + properties: + type: + type: string + enum: ['string', 'number', 'boolean', 'date'] + description: + type: string + QueryArrayVariable: + type: object + required: + - type + - description + - items + properties: + type: + type: string + enum: ['array'] + description: + type: string + items: + type: object + required: + - type + properties: + type: + type: string + enum: ['string', 'number', 'boolean', 'date'] + responses: + '201': + description: Resource created + '204': + description: Resource deleted + '400': + description: Validation or processing errors + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '401': + description: Missing or invalid JWT + '404': + description: Resource not found + '500': + description: Internal server error + +paths: + /api/v1/accounts: + get: + summary: Accounts + description: Retrieve an organization's account details + tags: + - Accounts + security: + - jwt: [] + responses: + '200': + description: "The organization's account details" + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + $ref: '#/components/schemas/Account' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + + /health: + get: + summary: Health + description: Returns 200 OK if the service is healthy + operationId: getHealthStatus + tags: + - Node + responses: + '200': + description: Service is healthy + /about: + get: + summary: Node Details + description: Returns information about the node including its DID, public key and build details + operationId: getNodeDetails + tags: + - Node + responses: + '200': + description: Details about the node + content: + application/json: + schema: + $ref: '#/components/schemas/AboutNode' + /api/v1/data/create: + post: + summary: Upload data + description: Upload data to the specified schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - data + properties: + schema: + description: The schema's uuid used to validate data + type: string + format: uuid + data: + type: array + items: + type: object + additionalProperties: + description: An object whose shape matches the targeted schema. + type: object + responses: + '200': + description: The outcome of the data upload operation. The operation can be partially successful. + content: + application/json: + schema: + type: object + required: + - created + - errors + properties: + created: + description: The uuids from successfully created documents + type: array + items: + $ref: '#/components/schemas/UUID' + errors: + type: array + items: + type: object + required: + - error + - document + properties: + error: + type: string + document: + type: object + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/data/read: + post: + summary: Read data + description: Retrieve data from the specified schema collection that matches the provided filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - filter + properties: + schema: + $ref: '#/components/schemas/UUID' + filter: + $ref: '#/components/schemas/Filter' + responses: + '200': + description: Data documents that match the provided filter. Pagination is not supported. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/DataDocument' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/data/update: + post: + summary: Update data + description: Update documents within a schema collection that match the given filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + - filter + - update + properties: + schema: + $ref: '#/components/schemas/UUID' + filter: + $ref: '#/components/schemas/Filter' + update: + additionalProperties: + type: object + description: A flexible object allowing any key-value pairs, where values can be of any type. + responses: + '200': + description: The result of the update operation + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + required: + - matchedCount + - modifiedCount + properties: + matched: + type: number + updated: + type: number + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/data/tail: + post: + summary: List new data + description: List recently added documents from a schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - schema + properties: + schema: + $ref: '#/components/schemas/UUID' + responses: + '200': + description: The last 25 latest documents added to the schema collection + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/DataDocument' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/data/delete: + post: + summary: Delete data + description: Delete data records that match a given filter + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + properties: + schema: + $ref: '#/components/schemas/UUID' + filter: + $ref: '#/components/schemas/Filter' + responses: + '200': + description: The result of the delete operations + content: + application/json: + schema: + type: object + properties: + acknowledged: + type: boolean + deletedCount: + type: number + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/data/flush: + post: + summary: Delete all data + description: Remove all documents in a schema collection + security: + - jwt: [] + tags: + - Data + requestBody: + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + properties: + schema: + $ref: '#/components/schemas/UUID' + responses: + '200': + description: The total documents removed + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: object + properties: + deletedCount: + type: number + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/schemas: + get: + summary: Get schemas + description: List accounts' schemas + security: + - jwt: [] + tags: + - Schema + responses: + '200': + description: The organization's schemas + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/Schema' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + post: + summary: Add schema + description: Add a new schema + security: + - jwt: [] + tags: + - Schema + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - _id + - name + - schema + properties: + _id: + $ref: '#/components/schemas/UUID' + name: + type: string + minLength: 1 + schema: + type: object + additionalProperties: true + responses: + '201': + $ref: '#/components/responses/201' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + + delete: + summary: Delete schema + description: Delete a schema + security: + - jwt: [] + tags: + - Schema + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + $ref: '#/components/schemas/UUID' + responses: + '204': + $ref: '#/components/responses/204' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/queries: + get: + summary: Get queries + description: List account queries + security: + - jwt: [] + tags: + - Query + responses: + '200': + description: "The account's queries" + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/Query' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + post: + summary: Add query + description: Add a new query + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - _id + - name + - schema + - variables + - pipeline + properties: + _id: + $ref: '#/components/schemas/UUID' + name: + type: string + schema: + $ref: '#/components/schemas/UUID' + variables: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariable' + - $ref: '#/components/schemas/QueryArrayVariable' + pipeline: + type: array + items: + type: object + additionalProperties: true + responses: + '201': + $ref: '#/components/responses/201' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '.#/components/responses/401' + '500': + $ref: '#/components/responses/500' + delete: + summary: Delete query + description: Delete a query + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + $ref: '#/components/schemas/UUID' + responses: + '204': + $ref: '#/components/responses/204' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' + /api/v1/queries/execute: + post: + summary: Execute query + description: Execute a query with variables + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + - variables + properties: + id: + $ref: '#/components/schemas/UUID' + variables: + type: object + additionalProperties: true + responses: + '200': + description: Query executed successfully + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + type: object + additionalProperties: true + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '500': + $ref: '#/components/responses/500' diff --git a/apispec/nildb/queries.openapi.yaml b/apispec/nildb/queries.openapi.yaml new file mode 100644 index 0000000..1ce5d70 --- /dev/null +++ b/apispec/nildb/queries.openapi.yaml @@ -0,0 +1,216 @@ +components: + schemas: + Query: + allOf: + - $ref: './base.openapi.yaml#/components/schemas/DocumentBase' + - type: object + required: + - name + - owner + - schema + - variables + properties: + name: + description: A user friendly query name + type: string + owner: + description: The decentralised identifier (DID) of the owning organization + type: string + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + schema: + description: The starting schema collection for this query's aggregation pipeline + type: string + format: uuid + variables: + description: The query's required runtime variables + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariable' + - $ref: '#/components/schemas/QueryArrayVariable' + pipeline: + description: An query's execution pipline defined as an array of objects + type: array + items: + type: object + + QueryVariable: + type: object + required: + - type + - description + properties: + type: + type: string + enum: ['string', 'number', 'boolean', 'date'] + description: + type: string + + QueryArrayVariable: + type: object + required: + - type + - description + - items + properties: + type: + type: string + enum: ['array'] + description: + type: string + items: + type: object + required: + - type + properties: + type: + type: string + enum: ['string', 'number', 'boolean', 'date'] + +paths: + /api/v1/queries: + get: + summary: Get queries + description: List account queries + security: + - jwt: [] + tags: + - Query + responses: + '200': + description: "The account's queries" + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: '#/components/schemas/Query' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' + post: + summary: Add query + description: Add a new query + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - _id + - name + - schema + - variables + - pipeline + properties: + _id: + $ref: './base.openapi.yaml#/components/schemas/UUID' + name: + type: string + schema: + $ref: './base.openapi.yaml#/components/schemas/UUID' + variables: + type: object + additionalProperties: + oneOf: + - $ref: '#/components/schemas/QueryVariable' + - $ref: '#/components/schemas/QueryArrayVariable' + pipeline: + type: array + items: + type: object + additionalProperties: true + responses: + '201': + $ref: './base.openapi.yaml#/components/responses/201' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: '../base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' + delete: + summary: Delete query + description: Delete a query + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + $ref: './base.openapi.yaml#/components/schemas/UUID' + responses: + '204': + $ref: './base.openapi.yaml#/components/responses/204' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' + + /api/v1/queries/execute: + post: + summary: Execute query + description: Execute a query with variables + security: + - jwt: [] + tags: + - Query + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + - variables + properties: + id: + $ref: './base.openapi.yaml#/components/schemas/UUID' + variables: + type: object + additionalProperties: true + responses: + '200': + description: Query executed successfully + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + type: object + additionalProperties: true + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' diff --git a/apispec/nildb/schemas.openapi.yaml b/apispec/nildb/schemas.openapi.yaml new file mode 100644 index 0000000..6f49a3a --- /dev/null +++ b/apispec/nildb/schemas.openapi.yaml @@ -0,0 +1,92 @@ +paths: + /api/v1/schemas: + get: + summary: Get schemas + description: List accounts' schemas + security: + - jwt: [] + tags: + - Schema + responses: + '200': + description: The organization's schemas + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: './base.openapi.yaml#/components/schemas/Schema' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' + post: + summary: Add schema + description: Add a new schema + security: + - jwt: [] + tags: + - Schema + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - _id + - name + - schema + properties: + _id: + $ref: './base.openapi.yaml#/components/schemas/UUID' + name: + type: string + minLength: 1 + schema: + type: object + additionalProperties: true + responses: + '201': + $ref: './base.openapi.yaml#/components/responses/201' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' + + delete: + summary: Delete schema + description: Delete a schema + security: + - jwt: [] + tags: + - Schema + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + $ref: './base.openapi.yaml#/components/schemas/UUID' + responses: + '204': + $ref: './base.openapi.yaml#/components/responses/204' + '400': + $ref: './base.openapi.yaml#/components/responses/400' + '401': + $ref: './base.openapi.yaml#/components/responses/401' + '500': + $ref: './base.openapi.yaml#/components/responses/500' diff --git a/apispec/nildb/system.openapi.yaml b/apispec/nildb/system.openapi.yaml new file mode 100644 index 0000000..2e86f6e --- /dev/null +++ b/apispec/nildb/system.openapi.yaml @@ -0,0 +1,75 @@ +components: + schemas: + AboutNode: + type: object + required: + - started + - build + - did + - publicKey + - url + properties: + started: + type: string + format: date-time + description: Timestamp when the node was started + example: '2024-12-16T09:38:04.095Z' + build: + type: object + required: + - time + - commit + - version + properties: + time: + type: string + format: date-time + description: Build timestamp + example: '2024-12-24T23:59:59Z' + commit: + type: string + description: Git commit hash or identifier + example: c0401ee26ece3f7155fd788848baf122cdd702ed + version: + type: string + description: Node's api version + example: 0.4.0 + did: + type: string + description: Decentralized Identifier (DID) of the node + example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc' + publicKey: + type: string + description: Public key of the node + example: 02d1f198df9a64ffa27c293861bace8c80bd6b1e150e008267f7f94eae9e6c380c + url: + type: string + format: uri + description: URL where the node can be reached + example: 'https://nildb-demo.nillion.network' + +paths: + /health: + get: + summary: Node health check + description: Returns 200 OK if the service is healthy + operationId: getHealthStatus + tags: + - Node + responses: + '200': + description: Service is healthy + /about: + get: + summary: Node information + description: Returns information about the node including its DID, public key and build details + operationId: getNodeDetails + tags: + - Node + responses: + '200': + description: Details about the node + content: + application/json: + schema: + $ref: '#/components/schemas/AboutNode' diff --git a/docs/api/nildb/accounts.api.mdx b/docs/api/nildb/accounts.api.mdx new file mode 100644 index 0000000..a9f980f --- /dev/null +++ b/docs/api/nildb/accounts.api.mdx @@ -0,0 +1,155 @@ +--- +id: accounts +title: 'Accounts' +description: "Retrieve an organization's account details" +sidebar_label: 'Accounts' +hide_title: true +hide_table_of_contents: true +api: eJzVVt1vGzcM/1cEvTQBEjvJ0mK9t2zJhqxYN6xJ+5AYBX2ibSU66aqP1K5x/3tJ3fkjthF3wF72YkukKJK/H0ndXCoMpdd11M7KQv6D0Wt8QgFWOD8Gq78Bq14FAWXpko1CYQRtgjySEcZBFnfyotUEOTiSAcvkdZyRfC4fvkb6HzQk9xhqZwOSwVyenZzw33PXNxPc77J0NqKNbA11bXSZj/YfAl8xl6GcYAW8irMa6VI3fMAySvb/JWmPiuNVEIFjrb2r0UfdBpWleyw/a0WSz/kI/ZceIWIWpVp1yzoNKa53OKO1hYoPtmFx/F8Seva35Z1v3glJh0EgEErK3IPRAZXQijZ6pNGLg8vry0Omow08EIN2THucQlUbFimtCqtNETFEi5HXhjycYrIe0zcTp2MzfTuanr/9yZz5n3H0xivjIZ2roGwpm0XKK3RWTmyqGBlQlba0X2dQDpo1kHYYj5yvIHKAdOI4agKrWcPyhy1WkG+ZNB0JuxQLWrZwvxAEchRuJNojhHYQcQJRDNE4OxbR0VYvC3QFPngPTLyOWO28OFn9hD6AMTNeUz2sU0np0cUkIvPeDkqX6aeUKzHqmAm+vb2+lE2zqq8XUuIjs/9LRs1K0k0ZFmb5+a4h8pHaQ+Xio1kiqMVKDIE8CfTe+f9sgkS+qbtyq5Vj+MHKPdrR7vlSGn18IERq4B5XaufqBVbzCUE2AcYYXqAP7OyvUZ7Om/2wnfLzvEqndvdR53WHrmkGzzi84ijlgr/T7YT+1C1dlIu2T0ym+OPTDTt5vYvua+LSWzAioKcibFHIjVBhnDjiSo4xZwJxQps+1Lr/dNpfDFWezdkyZESSN3RoEmMdin6fpqQaHiusXK8bmD0anl+df5TN2kv3gSumRSi/d0sQ+J7F8Of9EMGjJ0m7+G1REJzgZilcCBrqx6QRKePBLXT14ez1m3cCzNiR30mVewsSqajZSp6YAq2qnabEeveWjWuYGQdKVImqRNvSJIXFvT0WGmIhrkNIZERDYFltrMNpXYiraa1920hLpTjwWLqqIi+oDvkoJFWIG/AEsrBUHnseqew5hEL8ajRpXu171O5t5lLbkcu4dlVEbFz+Ii7+vibYmLsWspPeee9kC8iPOugo7pQrw5JFymFwsGB5U3NInz5K3I0J4TRkQf99q3zfct+Wxcp+z8FDnqyGCLeich57nBKVowuxgjxw2tdp9Q21kcB8NbD+5cdZW4QRp7FfG9DZby7wedcN9GjXmiE8pR9Y+4abUHSsns+HEPDWm6ZhcX44+HuOTMBrGDIZd/zGTxAUVTa30CM/wpwN1tx31MIpj6HNUcsdtOzR36+4A7iU19pno13WRxbNsLW7Kcx84sY9oqVQj7ogIu9lnkDfAdAOxsY= +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'; + + + + + +:::info +You may use this test Bearer token we have created for development + +``` +eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ +``` + +::: + +Retrieve an organization's account details + + + + + + diff --git a/docs/api/nildb/add-a-new-query.api.mdx b/docs/api/nildb/add-query.api.mdx similarity index 52% rename from docs/api/nildb/add-a-new-query.api.mdx rename to docs/api/nildb/add-query.api.mdx index 388029e..c65d420 100644 --- a/docs/api/nildb/add-a-new-query.api.mdx +++ b/docs/api/nildb/add-query.api.mdx @@ -1,11 +1,11 @@ --- -id: add-a-new-query -title: 'Add a new query' +id: add-query +title: 'Add query' description: 'Add a new query' -sidebar_label: 'Add a new query' +sidebar_label: 'Add' hide_title: true hide_table_of_contents: true -api: eJy9Vtty4zYM/RUOX5rM+JKrt9VbdpPOpJfdtHHSB2+mA4uQzaxEakkqicejfy9AyZdY7m47s7N+sCiCAIGDA0BL6TGtnA4LmUyW8vE50POhfujJADNPa/lHhW4hacPh5wp9eGsVnV3GV+1QySS4CnsytSagCSyCssx1CkFbM3z01vCeT+dYAK/CokSZSDt9xDTI3pahifxbK9oxUCA9WpWefAKnYZqjp3WpS8y1QfaodLZEFzQJyC7r0kOhT50u+XK65UJURj+h85DnC15TDEIrclRnGp3IrBNhTlsBiwGZb53zwWkzo3eSF0BByaqKrgUdcj5wd3d9KevW1U1QrV7d24r3+zq0wWoP1KCUZj8gv3kF3ZdSEmW9V1F0oG/0d1HoSTRVwTbWG/Q+RUeLqbU5gmHDECiZ9esbuojWm1AjI+/bOKNkTYqNHjgHCzLPOP4PLJjLdfNjGHxpjW9iPDk66mYzuiJShxSEEr5KU/Q+qyi18htVBMEDXcDj7nfmVgvK2T4c7iHXKoYn6A7ylXEgowKds85/KzACW2pNdkno91FwHRPzrB90sUvmRI4JEhYIm0V44gUC0tQ6xTEEG7eNVTjgEmsd6IDwm/aBbTT6BSEAs9iz/o2SYBYfsth3d9tHF4bXsabky9620966r4Dqh3q7iq7YS7nK6XE3nN91k0KKRZsnTrD45a9xrLcd2iklQBh8Fp/jrGAvwtxSxmRpfXQewpzehlDq4dPxkI/piIxHx3yNGFQupzPzEEqfDIdG52raV1jYAS1zumlgMDxb90nydFpNrVvmTYNJnF3rsNnOaobw+xTBNZ0nLn5e0YJD6gQkLq8v+yQRVUSAs391e3I++lVAPrN077yIxQQViai60lj+aFRptQl+8NGwcgmL3IISRUW80CbNK4XJR9MXGkIirr2vSAlC5J4PUJQsw5cyEVcvpXZNOa2F4sBhaouCbkF1yEehUokYg5thiOQUClPyxlGqPFneKvwDiieqUEoT8S7XJPnBf/V8zDVX6J+b0X/1Qr7kuB648jSDH8+z0Vn//M3xm/7Z+eikPz3N0v5J+tPoNBuNIIPRaqZv1eWq4P+r/vZce9XxJ8uap4c2mY3pb+lNpLl8Ky5urlmXKNZk9mhwNjjq5Pteex3ERNnUr8lGUD8crMi4KzkUYJSYzIgI1ZQ3hu8b4fuGog17N/pfOXjILYbGoTOisA4HjHwv1k4BsTu24HULbf/MDPgShmUOOtqJdbVsa3BC3VczJMf0t6pDqqc5FypJl8speLxzeV3zdnMPfRFuEhC/D0kBQVE9ceF+Qjoi3zUNvj9uvheoYVSx6e02e25ujcYFTcsyfPHsw1YvuflwO45fDs33ZxFboHTwzEOC/hNJCxuxiP0g7i1lDmZWxZYoG5tMai7cLcB2msN2S6YeveUhwRNPjO0nNARRrw0l8LuMHfYf69fifg== +api: eJy9VttuGzcQ/RWCL7WBleSrkuybE7uAWzRxY9l9cIyCWo4k2lxyS3JtC8L+e2fI1V21E6CtH2QuOTOcy5kznHEJvnCqCsoanvMzKZlgBp7ZXzW4Kc+4h6J2Kkx5fjfjD88B/9839xkPYuxxzX+PcrjhAFV8+Gglys7ip3IgeR5cDRkvrAlgAh2JqtKqEHRl78HTvTPuiwmUglZhWgF6YocPUASerRi6438qiTtGlECeJZWMPwmnxFCDx3WlKtDKAHlUOVuBCwoP0C7p4r+NeFlt1BM4L7Se0hpjYEqio2qkwLGRdSxMcCtA2UXzrXM+OGXG+I3npcCgeF1H14IKmgRubi7PedO6ugyq1WuylXj/X4eWudqRaiGlIj+EvlpLnTXwZRQB8Fpx4lm2Fs9WEZL+Zj4yDqYuycZiA7+H4HAxtFaDMGRYBCxrs37Ddm6bZdARm7dtxBj9D/ufccqz//E4hHNi+h3Ozi94A/fx7L9IZrOVrjPyfJmzexJYNNXyshTgK+7vxhJxQZP+KEJfWeNTMEcHh9vd8BW8rV0BrHCADktK2MnBwbbgrdBKRkZh2CCYpgK8x+AZOGcdEcO/wj+BLLUmt8vhdxVj0ZCU8U5Q5SbGcj7Afo5Gf/KMBHwQZdWlWNurdrCEVj4wO0p6DHW8GEcC/Kf6CDNd7+EFBLdDXo+rsHI3h7W37upBws0Ksi7IS56qfrKr0L+pVC6MRZknKib75Y8BXXK6q9yXWEuH0GIeHJJlykJs/RLCxGKteGV9DEWECX71RKV6T4c9mmoq5ilp+piR2mmUmYRQ+bzXM0rLYUdCabu41Hhj10B4tu6R0+CbD8RrQkzKUByLiySQnfl4ou8hCJe6Ly5+ngOCAtyEwhk7vzzv4AmrYz6I6i+uj077vzKhxxbvnZRxBogaj3AoFNQWDIysrDLBd78ZUq7EVFshWVkjSpQpdC0h/2Y6TImQs0vva1QSYYk2OoOXKmcXL5VyqZEWh2zPQWHLEm8BuU+iopY5Gwg3hsAMwoNJKNAbh4XzaHllXu1hPFEFC5yzT1rhCcL8LflYS+rNr8tXxcUL+qJhMcv58Ui8Px31Tzqn7w7fdU5O+0ed4fGo6BwVH/rHo35fjER//lxY6ch5q3+v/urIXCPDu1lDDK/MyMbyt2BH0Jx/ZGdXl6SLEEuVPeiedA+26n2rvArsTtrCL8CGqb7fm4Nx82SfCSPZ3RiBUA9po/c5HX5OEE3oXeq/IbjPgmU4EpxhpXXQpcxnsXdKEXmxTR69C+cvwo2JtiDWHY/HtiMCvIRepYWK1mO3zdrOxFFZKUrUIf7MuxO7bELti6ez2VB4uHG6aWg7GcYn6LIs8UGKCiAkdhm18yOgCP+U/OoM0lhHUqkjMW6SPxFg0jgrCqjCq7L3Kwxz9eV6EGdqevCWkSa5E880NPA357iwMU+RJeLejGthxnWkTZ5sEtSpnVcoZIMyVmkbeXzFQ0xPlBjYRzCYoqwNJdB3nN7N3zjfErA= sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; diff --git a/docs/api/nildb/add-a-new-schema.api.mdx b/docs/api/nildb/add-schema.api.mdx similarity index 55% rename from docs/api/nildb/add-a-new-schema.api.mdx rename to docs/api/nildb/add-schema.api.mdx index fd0840d..7292909 100644 --- a/docs/api/nildb/add-a-new-schema.api.mdx +++ b/docs/api/nildb/add-schema.api.mdx @@ -1,11 +1,11 @@ --- -id: add-a-new-schema -title: 'Add a new schema' +id: add-schema +title: 'Add schema' description: 'Add a new schema' -sidebar_label: 'Add a new schema' +sidebar_label: 'Add' hide_title: true hide_table_of_contents: true -api: eJy9Vk1z2zYQ/SsYXGrP6MPyh9Ly5kTujNs08cRyelA0nRWxlGCTAAuAtjUa/ffugpRES5rkkqkPJgjsLnbf7nvUSnpMK6fDUiaTlXx8CfScrqcdGWDuaS1HEEDSu8N/K/ThvVVkuoqv2qGSSXAVdmRqTUAT+AjKMtcpBG1N/9Fbw3s+XWABvArLEmUi7ewR0yA7rUAT+Y9WtGOgQHo84dLTo/GkDEpnS3RBo+c4bEsPhT51uuTLKOq1qIx+Ruchz5e8ppyFVpSYzjQ6kVknwoK2AhY9Ct4k44PTZk7vdF4AFSGrKqYSdMjZ4OHhdiTXTWq7IrZ+hTYf0czDQiaDdZP6zgycgyVZ8a3+0H297nwHH1BKc3WQ37XqZ9DX8Y8R9KU1vobl/OzsEJb7GF2kDiGgEr5KU/Q+qwgk+ZNap5oxedukuPs/d6lB5fIYEF8h1yqWJ+gOypVxoKACnbPO/ywwAkdqQh5gEo6MQKsmSg+7QUcKvE1+TJDwgbBZhCdeICBNrVNcQ7Bx21iFPR7WJoEDED5qHzhG7V8QAjBHv8P5YFzBLD9nUR/2BrdzCMPbWlPK5cjAE2HqW4+RYT2N/ds09YazlJueDg7L+UvXLaRatHnmBos//h5HVu2NnVIChMEX0XSR0wgLSy2TpfUxe2AKyz6Uuv886Nd2UYXQ8cBGECqXk80ihNIn/b7RuZp1FRa2R8ucruoZDC/WPUmW0Y28RgrWoESR3dbNcTYyx+8zBIeOdurF75u54JoOKhKj21GXTkQVIeD239yfXw3/FJDPLd27KCKboKIjolca+Y9GlVab4HvfDDuXsMwtKFFUNBjapHmlMPlmukJDSMSt9xU5QYjD5wMUJZ/ha5mIm9dSu5pP20Nx4jC1RUG3oDplU6hUIsbg5hjidAqFKWXjqFeeIreYf0L1RBfqaSI+5JpOfvE/tI/NZop+2X2kbl4plxy3nwp5kcGvV9nwsnv1bvCue3k1PO/OLrK0e57+NrzIhkPIYLj5+rSIWWv5ZLMxbWk136pNZmM3m3GlGRi9F9d3t+TKE1M36qx32Ts7aN9X7XUQE2VTv50dQm56spmt/ZNTAUaJyZz6Ws14o/+pPvxUT1w9jDv/HxiesmTkNGZGFNZhj4HsRCoUENWuweIIcd4Usp3lgK+hX+agY6DIk1XDqQnJqWZMBttvetTGBROPTlerGXh8cPl6zdvURsc/SWj5DE7DjMGlHybkgKCIH0xEag1d+qFW7O6Yc2DzvIoqtq/erFa1xzV9/srwXdtpSxvuPt8z9WbNL58iapp08MKqT/8TSQsbsYj8jnsrmYOZV1HjZB2Tx4WJ2AJsj+xtjSXRbWVI8ESLsX1CQxB1mlICv8somf8Br19cnQ== +api: eJytVUtv2zgQ/isEL5sAfiWx3V3d0iYLeB9t0DjtwTUWtDiymVCklqSSGIb+e2coWXZso700h5jivOeb+bjhEnzqVBGUNTzh11IywQy8MJ+uIBe8wz2kpVNhzZPZhj++BPydV/MOD2Lp8czva0W8cfB/CT68txKVN/FTOZA8Ca6EDk+tCWACiURRaJUKCtp/9BR5w5uAeArrAjAXu3iENPDOnqMZ/09JvDEiB0qtDV04W4ALCjw5ICX8OSiNlUY9g/NC6zWdMVmmJGakMgWOZdaxsMKrAHkPnTdZ+OCUWeI3ynOB2fOyjDkEFTQpPDxMbnjV5LTLvrXLlfkHzDKseHJRdX5QppBSUa5C3+1VQ72r4h81whfW+LrIy8HFcZGfwdvSpcBSByJgy9BqOBgcK34RWskIAMO6sX0peI8JM3DOOs9/EVyBPDUuj2AK/lS/2j5jetANKiL9NvkpwhSd/uYZKfgg8qJHtTahToCvlQ/MZrUdQxsvluB3OAvnxBo/Cf7oQJj1pywO/dsMq85xyW/rSq08MQmYXRP1hKyq5hHh7VDdUpa8Rn14Cuh/VQ0X1qLMM4HJ/vo6pSCjU3BPEEuHk8U8ONyBugu8ijmFlUWseGF9LEXQpPK+KFT/+aJfw+wjD5Cljx0pnUadVQiFT/p9o7RcdCXktodHjRF7BsKLdU+ciGJLIJEo6g5FGmmbQH6220zfCxAOHN7Uhz+3A0EFHo7CNbuZ3HRRwsrYD9rg2/vL0fhvJvTSYtxVHldblCjCXU9pLRgYWVhlgu99M2RciLW2QrK8xClRJtWlhOSb6TIlQsIm3pdoJMJu2kgGr0XCbl8L5epFaoXszEFq8xyjgDwnVVHKhE2FW0JgBseDSUgxG4fAefS8R0NnWE80QYAT9kErlOCY/0w/Ykm7+XlHwrevmIuGlhH5VSZ+H2XjYXf07uJddzgaX3YXV1navUz/GF9l47HIxHjLrnsb2a46xVAmsxG7ZlIR8Zv37Ppugoo0HzUsg96wNzgC64vyKrCZtKlvJwX7ND/bTtKh5JwJI9lsiSiWC7rof6yFH+v5qkdvZ/8TxXMWLNM4VIbl1kGP2taJg5+LSGpN5fQKtu/fmxI2O1o89VY2Ax3gNfQLLVT0H5dl0yzWDMlUUasu2sZGZlzR9qF0s1kIDw9OVxVdI5aOXl48PgunxIJ6ju8vGoCQuCS0jU+AKvxDnVh3SjmQui4jrx1yN/FXbXGdplCEH+rO9wji7tM97d+ied7zyHLciRfifPyfcDzY2Ki45PFuw7UwyzKyHq990hTRNu4xwMHG77Mu0vBehtieqDG1T2CwRZ2mlEDfPJLod9iTBmQ= sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; diff --git a/docs/api/nildb/remove-all-documents-in-a-schema-collection.api.mdx b/docs/api/nildb/delete-all-data.api.mdx similarity index 63% rename from docs/api/nildb/remove-all-documents-in-a-schema-collection.api.mdx rename to docs/api/nildb/delete-all-data.api.mdx index 67b6c99..7b9a144 100644 --- a/docs/api/nildb/remove-all-documents-in-a-schema-collection.api.mdx +++ b/docs/api/nildb/delete-all-data.api.mdx @@ -1,11 +1,11 @@ --- -id: remove-all-documents-in-a-schema-collection -title: 'Remove all documents in a schema collection' +id: delete-all-data +title: 'Delete all data' description: 'Remove all documents in a schema collection' -sidebar_label: 'Flush' +sidebar_label: 'Delete all' hide_title: true hide_table_of_contents: true -api: eJy9VV1PGzsQ/SuWX26vxCYQIG33jTZcifuhViW0Dy0PE3s2MXjtvbY3EEX5753xbiAQdKsrVeUh2J4Pn5k5PruWEVUbTFrJ8uta3twl+n+9uT6QCeaR1nICCSTtA/7bYkzvvCbXtVTeJXSJl9A01ihIxrvhTfSOz6JaYA28SqsGZSn97AZVkl0eE1Bzbt3nboJvMCSDkSPy6QuRT70eb9AYVTAN30/uZ6J1ZokhgrUrXhNsYTRhNZXBICofRFrQUcJ6QFn7W2IKxs1pT/YaqC7Ztkaz3STLDldXFxO56f+4jNh4Fzsso8PDfSBTuiT5BFZor9qaAEQRsPZL5LS/rn+urWcY5Bb4yUtYP4M1OiMQ1B5KpzBG6ofAEHyIPwtv4kx9yj3YKe6E74+D4GGRTI10+EKjySB8lSebLxCglA+aa0g+HzuvcSA3DwD2mvC3iYlzdPE1dQDmGB8pAiHAirbMnBwObvWhyu/mKerNwY/IqwjLfrWErb/1Bdtmc53nt+XjOaOU25ke7Zfzj+lGSLUYt+QBiz+/TCX7P3X8lEkp6L3sMNU4AaKbqlDeWqqCvRlhWniapmx8zIVBWtBuCI0ZLo+GTL5hZdu4IFvEwC8xt6gNltwWKTWxHA6dsXpWaLp5QEtLqQcO050Pt5LFZytKlwyga1mWpoeucB6+INtpP0MIRPKDfvHHljVc8fN6z8TkYlKQRbS5QUyO88vR6fgv6sHc072LOssEtGQi3SCuoxbodOMN9WbwzXFwAyvrQYu6JdoYp2yrsfzmCmEgleIixpaCIGVqxgR1wza8b0pxft+Y0L22B6N4FVD5mpqvUf/OrtDqUkwhzDFl7gqNitAEmmSkzDuS9orqySE08VK8t4Ysv8Uf+mcq8AP+9Cjt5/eExeKujGyftjyu4M1pNT4pTl8fvS5OTsejYnZcqWKk3o6Pq/EYKhjnnMZVPs+qpypNePJOnH28oFEwH7oxHA5GgxFznolUQ5YRB3ma/4+RT6b7wJCE92nYWDCO78jsW/dk/UoSZhjLEUdzmaQzmbJEvQXTmlzW6xlEvAp2s+Fj6lDgbyQtlxAMzLgy+lJSAIIm6jHHb5Fc5PtOKospA2F322b5eC6bLBNdxJlS2KT/9L3eeXkfP1wyq2f9p7jOYiID3LHc0m8paeFzQ/LTyWdracHN2ywussvJs2KO73Tt2TvaFTdSux2E1J7sMfW36KhFB30pifcya9V3NNDexw== +api: eJzFVktvGzcQ/isEL7UBPfyS0urmWC6gFk2CWE4Pjg6j5axEm0tuSa5sQdB/7wx3ZcmSECNAgfpgkzvvmW8+eiUVhszrMmpn5UB+xcItUIAxQrmsKtDGILQVIEI2xwJE5ozBLGm3ZMCs8jou5eBhJR+fI/2drCctGWEW6CyHEEHS3eM/FYb40SlSXcnM2UiO+QhlaXQG7K/7GDiFlawj8SkuS6Sk3PSRQsraj/ao2LdqfJfeleijxsAW6esRy7da2whvq78WldUL9IHqX/KZ0hZaUa461+hF7ryIc/oUseiQ1yZKiF7bGd1JXgDVJatKK5braFjh/n40lOvmh8sIpbOhzuXi7OwwkTEFiS7C7hR8Gg27/d/7p9BgRHXjqjqLRttWxRT9TqFXx2r7BkarlLGgdpLjDEOg/gn03vnwX9UX2VPj8qDMGHbMD8dH6WE76gLp4+FgktNfgmCFEKEoO3L9GuoIpowOUbi8thNkE2CGYQsf8B6WdGVUJQdgl5/ztFNvM1y33htM5hQeVkbZNVGPyNbrSZrVBqu3nKXczO/8sKC/dD0uqkXbBQ9T/PH3mIP0jo17RLP0lpAc0NNq1V2Q65RTnDualSxdSKVAnNOtC6XuLs67DMVubqowT0zDxiE1pfKG1OYxlmHQ7Vpt1LStaDk6dDQUtGMxPjv/JJmKNhR1x6Cpm5SI6rUP7IcDJDndpwieQNxqDr9vMME17qPhWgxHwzZJRJVawtxwe3fR6/9JDDpzFHdeJNKAikTEIoRkVAKtKp2mne58t2xcwtI4UKKoCCjaZqZSOPhu20JDHIhRCBUZQdwCjmX4Ug7E7Uupfb1Lr0Jx4jFzBZGGQnXKqlCpgRiDn2EUlhAiFGaUjafZBfK8Q3AnVE8yoRkPxI3RJCGkv6efxsnr+XVL9LcvlIvBXVLZLK68zOHXXt6/avc+nH9oX/X6F+3pZZ61L7Lf+pd5vw859JNPbXOXZtWAkyY8/Ciuv4xoFIyHegxnnavO2cFwvumgo3ggAg2vyKC+TE42yNmXnAqwSjzMaGrVlD90P9XCTzWeaqht7d9RPCUGF4ZAZEXhPHa4Ta2E9QISj1lIgBsmMq2fXG7UXh07z+VPvs4NwCO+xG5pQKf4aXlWza49EL9qbuU5R62D1xtHmzPnrSSV1WoKAe+9Wa/5Mw3Y84NPxwV4DVMeDD37ZICgaHN4RZ+QVORNnXh7zImwuqkS3+1zOvNabXGdZVjGH+pOdojjy+c7Xspp839FkdhPenjmt4B+DyQdXGpk2vz0bSUN2FmV2FDWPhlqvKI7tLBHA7tsTPS8kyG1J2mM3RNaalGrKSXyXSZy/RfWIj2w sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; -Remove all documents in a schema collection - :::info You may use this test Bearer token we have created for development @@ -42,6 +40,8 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: +Remove all documents in a schema collection + diff --git a/docs/api/nildb/delete-data-records-that-match-a-given-filter.api.mdx b/docs/api/nildb/delete-data.api.mdx similarity index 58% rename from docs/api/nildb/delete-data-records-that-match-a-given-filter.api.mdx rename to docs/api/nildb/delete-data.api.mdx index 39f9031..1ba7420 100644 --- a/docs/api/nildb/delete-data-records-that-match-a-given-filter.api.mdx +++ b/docs/api/nildb/delete-data.api.mdx @@ -1,11 +1,11 @@ --- -id: delete-data-records-that-match-a-given-filter -title: 'Delete data records that match a given filter' +id: delete-data +title: 'Delete data' 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= +api: eJytVttOIzkQ/RXLLwtSLlwzs3kDwkjsambQEGYfIA+VdnVicNu9thuIovz7VNkJNAEtWu3yENxdZdflnDrupVQYCq/rqJ2VQzlCgxGFggjCY+G8CiLOIYoKYjEXIGb6Aa0otYnoZUcGLBqv40IOb5by7jHS/8lq0pERZoHWckQHSXr2+HeDIZ46Ra5LWTgb0UZeQl0bXQDH798FTmIpQzHHCngVFzVSWm56h0WkeLV3NfqoMbz2e13FiWgs5ekDGLPgNQUXWlFEXWr0onSeqqJXEasenbqOEqLXdkbPZKd66U3TaMV2HQ07XF9fjOSK7Ln8d/KrtL1spbjfkaCU5rTAtA3RN9jZyvqrszM3Ou2GuDAoKGW/eGn0JoUv+cUq/XFfQ+1syO042Nt724sx1UlejYnClalqlTHmZFLbAx3/PwECxb11jwbVDFXLe+qcQbDcuhxcnbkmR1t72Kaatso6eq+Sn2C0SnkJwo8CFxgCASbQe+f/UxVMT+055xsZ+aT1kZPtAmNobX/LF0oPu1FXKLfBZRjSob/RQJFDiFDVPe7IOtQ7JDY6JNCSh6A9AWYYXvgK3sOCHpnGuf128b1Mo/g6w1XnI+AKp/BtZZTdOuo7ttVqkrDaMPOcs5Qb/PbfFvRVZ7ioFm0fGEzxx19jDnL8HtwXhKWnsREBPc1y7oJcpZzi3BFWsnYhlQJxTk99qHX/Yb/P4tXPPEsKxbtD6krjDfnNY6zDsN+32qhpV2HlerQ0FLVnMT46fy9ZwjbSdsWsyV1KAvfcCD6HAyQ7sxzBp1nNiy8bUnCR23Q4EaOLUZcsokk94bk8vzo4HvwpwMwcxZ1XSaagIRPpFlEZlUCraqdtDL1by5trWBgHSlQNMUXbwjQKh7e2KzTEobgIoaFNpN7PjGMbPtVDcf5U6zz+L0axw5JfVRQF1S67QqOGYgx+hlFYoghpR0HZeAIv0MktSd2hetIWAnkozowmC1H9I/+EJ8/nj5cL4vyJcjHYnlh5WMLn43Jw1D3+tP+pe3Q8OOhOD8uie1D8PjgsBwMoYSBbwszHalu6BNeaoATy6FScXF6QI1MiI7HXO+rtvcHnpw46ihvlivBMDmrNZGdDnm3LrgCrxM2MgGum/KL/LRu/ZUpltr3s/8BxV0QnSDO9FZXz2LtN4sl8ryBpmYXEudZ9vV1D65b919f6muERn2K/NqBT9DQ9y/W03ZDCam7kPsfdhE8zR7Mz58Ekn+VyCgGvvVmt+HW60/gTgfaB1zBlXOiDgTYgKAaOhvQeyUWe5dy7Y86E3U2TJG9b1lna8o6TosA6/qPvpKUdl9+veCyn6y+SKgmg9PDI1wH9DiUtXJ0vSHJI75bSgJ01SRBlPpOZxkPavu5eC0FbkEmhWxlSe5LH2N2jpRZ11qVEfpZJX38BwyZTcg== sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; -Delete data records that match a given filter - :::info You may use this test Bearer token we have created for development @@ -42,6 +40,8 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: +Delete data records that match a given filter + diff --git a/docs/api/nildb/delete-a-query.api.mdx b/docs/api/nildb/delete-query.api.mdx similarity index 58% rename from docs/api/nildb/delete-a-query.api.mdx rename to docs/api/nildb/delete-query.api.mdx index 4344a27..c9c2dc0 100644 --- a/docs/api/nildb/delete-a-query.api.mdx +++ b/docs/api/nildb/delete-query.api.mdx @@ -1,11 +1,11 @@ --- -id: delete-a-query -title: 'Delete a query' +id: delete-query +title: 'Delete query' description: 'Delete a query' -sidebar_label: 'Delete a query' +sidebar_label: 'Delete' hide_title: true hide_table_of_contents: true -api: eJytVktz2zgM/iscXprM+JGn29Utrb0z3m2729bpHlwfYBGymUikykcSj8f/vQBlO3bU2V6ag0IRAPHxwwfIa+kxj06Hlcyma3n3GOj/bDPryAALT2v5KaJbSdpw+D2iD2+tIt91etUOlcyCi9iRuTUBTWAT1HWpcwjamv6dt4b3fL7ECngVVjXKTNr5HeZBdg4OmkqtOFPtbI0uaPTsT3v0VOhzp2s+k4JvRDT6AZ2HslzxmqAJrSi/LjQ6UVgnwpK2AlY9yrHN6YPTZkHvZK+AsMoY6Xiy61Cyw+3teCg36Y+B+doa36C4ODtrw0jcCIUlBlTCxzxH74tImORvIkRBgDYlafc5cm5tiWD2wK9+hvUrlFolCILIofMYK7Eh0Dnr/O8CHPik7ZEt3MEfhLeLQfCwG3SFtHkMfkK1ZIOwRaprSiAgz61TfIdg07axCntyswfQIuG99oHPaOIrYgAW6J8FAs4B1451k8LBrP4pUmsco9502jQc3zUnLO3bErZt1p/YNptZqt9OjSNGKXc1PW9f54NuSkh30eaBCyz++m8ik/tl231sfCwKnWuqsiCoFYeTwjn+e5KyfTTUVEtdS855HD1MMhfQuEq+SFhaxXVLFmYAwpLe+1Dr/sN5nx11otej425NREZXks8yhNpn/b7RpZp3FVa2R8uSUvUMhkfr7iVPod10+sLia4hNM2rPHZ/DCZKdewHBoaOdZvHnTlvMy8sb3YjheNgli4iJRpbQ6MvF9eBvAeXCUt5llUYJRDLRbKGOoD5Ho2qrTfC9b4aDa1iVFpSoIolLm7yMCrNvpis0hEyMvY8UBCEJ2AeoarbhU52J0VOtXdOTe6M4cZjbqqIsqE7ZFaLKxATcAkNSOA2cnNA4qrenkw/G3gndJ4VQYTPxruRCv/K/9E/F5jb//DziR0+EpcTdAJaXBby5LgZX3evX56+7V9eDi+78ssi7F/kfg8tiMIACBiw8bQqbyrPVMBV1+Fbc/Dsm9lkCDfNnvaveWaseX7XXQUyVzf1eDETF7GQnlpeWUwFGiemCChXnvNH/2Bg/NhJq1PUc/wvHU54jNEmdEZV12GNmSNTWhwrSCDSQNNbqhKNr7KUZ8Cn06xJ0OibJfr1tkSlNWM2MnNNj1yYk9yXlYut6PQePt67cbHi7yUMfZooAp2HO1NJnmgIQFMmd++oeyUW+a4Z4d8IY2L2MabC9HOg8wJqIG/pq1eF/fWcHzT4cvR9NRtxg2x8CVRp00sEjfwromUla2MRGati0t5YlmEVMg082p7LquLMOv2TH3Xs4eGkSH2AkgpLHxN6jIZI628sEfpdpjv4AL6oNxw== +api: eJytVUtzGjkQ/isqXdau4mUbSMLNCWwV+8juJjh7IByaUQ/I1kizksY2RfHft1szGDCuzWV9wBr1++uvW1upMGRel1E7K0dyjAYjChD/VOg3siUDZpXXcSNH8628f4r0f7FbtGSEVaCz/Cvp0YVHMgnxo1Oku02f2qOSo+grbMnM2Yg2sgjK0ugMOGL3PnDYrQzZGgvgU9yUSIm45T1mUbaOHM2lVhyp9K5EHzUG1qc7+j2t4lZUVj+iD2DMhs+UmtCK4utcoxe58yKu6Spi0aEYTcwQvbYr+iZ5AZSrrCpyT3IdDSvc3U3Hcpf+OLFQOhvqLK57/fM0vmBwlc9QqISqkmTV7/XOFb+B0SoBIigzqi/DECgVgd47H+T/BF9kT43LMxxjODI/R4LSw3bUBdLlafIzAjI5/SkIVggRirLDtTah3miP0SEKl9d2gmwCrDAcOgHeA7OPG5QcgN38kScOnma4a52XfFpX5hSeV0bZNVHfkO12i9ThfdsnnKWsu97vXZ0X9Luu20W1aPvIzRS//D3jIIO32j2lXnoLRgT0xNIaBblLOcW1Uwx3YgwXA3FN310odffxqstjqRNStW1ImFTekM46xjKMul2rjVq2FRauQ0dDMTsW45PzD5Indz/RX5kzNUZprl9gYD8cIMnpe4ng0dNNffh5Twku8TUZbsV4Om6TRFQJEZ6yydfrwfBXAWblKO66SOMHFYloHonIqARaVTptY+h8t2xcwsY4UKKoiCfaZqZSOPpu20JDHIlpCBUZQTzwjWX4XI7E5LnUvh6lF6G48Ji5oqAoqC5ZFSo1EjPwK4zCEkFoQjPKxlPrAnk+WhUXVE8yoRaPxCejSUJE/5F+6iZP55fDWpw8Uy4G90tL3uTwfpAP++3Bu6t37f5geN1e3uRZ+zr7MLzJh0PIYcgc0jZ3qT0NHamp44/i9s8poc8UqJHvdfqd3lk/vumgo5grl4UXMhAUi4s9WV5LLgVYJeYralS15Ivu51r4uaZQza6D/Q8UL0V0whBvrCicxw4jQ6R2IRaQNpeFxLHm3dm/OidFbA/b7/x9ajgb8Tl2SwM6+U/zsG1mZ04bUzNUV/Sznx+agzUlwdLtdgkB77zZ7fi6dkyvHFmA17BkzOnNIwMERXPAA/eApCI/1Wm1Z5wDq5sqLa/XC5qXVG1xm2VYxv/UXRxtgfHkt8lswpPXvKpFWmbSwxOvdvodSTq4BFSa5HS3lQbsqkrLTdZemY48ckdj/mqsj5crbdujHAmgpDFzD2gJpFZTTORvmXblvyqf194= sidebar_class_name: 'delete api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; diff --git a/docs/api/nildb/delete-schema.api.mdx b/docs/api/nildb/delete-schema.api.mdx new file mode 100644 index 0000000..e31b97d --- /dev/null +++ b/docs/api/nildb/delete-schema.api.mdx @@ -0,0 +1,120 @@ +--- +id: delete-schema +title: 'Delete schema' +description: 'Delete a schema' +sidebar_label: 'Delete' +hide_title: true +hide_table_of_contents: true +api: eJytVUtzIjkM/isuXzap4pUEmN2+ZQa2in3MbM2QmQPDQbQFOHHbvbY7CUXx31dyNwFCauayHBrbkizp0yd5KxWG3OsyamdlJkdoMKIAEfI1FiBbMmBeeR03Mptt5f1TpP/5bt6SEVaB1vJLrUgnHv+tMMT3TpHyNm21RyWz6CtsydzZiDayCMrS6BzYZ/c+sOOtbBzSKm5KpFDc4h7zKFtHF82kVuyp9K5EHzUG1qcz+p7mcSsqqx/RBzBmw2sKTWhF/vVSoxdL50Vc01HEokM+Gp8hem1XtCd5ARSrrCq6nuQ6Gla4u5uM5C79OLBQOhvqKK57/fMwPmNwlc9RqISrkmTV7/XOFb+C0SoBIigyyi/HECgUgd47H+T/BF/km5orz3CM4cj8HAkKD9tRF0iHp8FPCch06S9BsEKIUJQdzrVx9UZ5jA5RuGVtJ8gmwArDoRLgPWxoywVKF4DdfFomEp5GuGudp3yaV+4UnmdG0TVe35DtdvNU4X3ZxxylrKve712dJ/S3rstFuWj7yMUUf3ybspPBW+WeUC29BSMCemJpjYLcpZji2imGOzGGk4G4pn0XSt19vOrWhQ6pM9k2JEwqb0hnHWMZsm7XaqMWbYWF69DSkM+Oxfjk/IPk1t23dGrdGqPU2C8w8D3sIMlpv0Dw6OmkXvy+pwSn+JoMt2I0GbVJIqqECHfZ+Mv1YPinALNy5HddpPaDikTUj0RkVAKtKp22MXS+WzYuYWMcKFFUxBNtc1MpzL7bttAQMzEJoSIjiAe+sQyfy0yMn0vt61Z6EYoLj7krCvKC6pJVoVKZmIJfYRSWCEIdmlM0nkoX6OajUXFB+SQTKnEmPhhNEiL6z/RTNbk7Px/G4viZYjG4H1ryZgm/DpbDfnvw7upduz8YXrcXN8u8fZ3/NrxZDoewhCFzSNulS+Vp6EhFHb0Xt/9MCH2mQI18r9Pv9M7q8VUHHcVMuTy8kIGgmF/syfJacinAKjFbUaGqBR90P9bCjzWFanYd7H+ieCmiE4Z4Y0XhPHYYGSK1C7GANLksJI41L8/Lu3OSxfYw/t54ohrWRnyO3dKATh5SR2yb7pnRzNQM1tWe1pAG4JrCYOl2u4CAd97sdnxMBfP84NHyEbyGBaNOzx4ZICjqBG65ByQV+aGOqz3lGFjdVGl8vR7RPKZqi9s8xzL+UHd+NAdG47/G0zH3XvOuFmmcSQ9PPNzpm0lauIRU6uV0tpUG7KpK403WtzIhuemOGv1VYx+PV5q3RzESQElj6h7QEkitJpnIe5mm5X/JEtiW +sidebar_class_name: 'delete 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'; + + + + + +:::info +You may use this test Bearer token we have created for development + +``` +eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ +``` + +::: + +Delete a schema + + + + + + + + diff --git a/docs/api/nildb/delete-a-schema.api.mdx b/docs/api/nildb/execute-query.api.mdx similarity index 57% rename from docs/api/nildb/delete-a-schema.api.mdx rename to docs/api/nildb/execute-query.api.mdx index 04f9a96..df0e15d 100644 --- a/docs/api/nildb/delete-a-schema.api.mdx +++ b/docs/api/nildb/execute-query.api.mdx @@ -1,12 +1,12 @@ --- -id: delete-a-schema -title: 'Delete a schema' -description: 'Delete a schema' -sidebar_label: 'Delete a schema' +id: execute-query +title: 'Execute query' +description: 'Execute a query with variables' +sidebar_label: 'Execute' hide_title: true hide_table_of_contents: true -api: eJzFVktvGzcQ/isEL7UBPfxU0r05kQq4TZMikdODosNoOSvR3iW35KxtQdB/7wxXkiUraC4B6oNMct7ffDPSSkfMm2BpqbPJSt8/Ef+frqcdTTCPfNZDINB8D/hPg5HeecOqq3S1AY3OKDTY0bl3hI5EBHVd2hzIete/j97JW8wXWIGcaFmjzrSf3WNOurPnaKKtkUh18DUGshhFn9/402DMg63FJxvfqMbZRwwRynIpZ05NWcPxbWExqMIHRQt+Iqx6HGMTM1Kwbs53llfAueqmYfcst1SKwt3d7VCv058kFmvvYpvFxdnZcRpfUlHKYImERsUmzzHGouGk9E9CxGzQP8Qkvf4/qFx9D4ivUFqTylMcg3MVHNipwhB8iD8LDBJPG5dHmFDcMz+uidPDLtkK+fEw+TFDIgLliwRPCqAgz30wUgP59Oy8wZ5e7xI4AuGDjSQ+WvuKEYA5xhecIQQQXgj8yRzc8lORxu4w63XnGIbDWnPO5bhazm0T9Tuy9Xqa+rdt6kiy1Nuenh+X86dtW8i1WPcoDVa//z3Won+oOEz0V6A2TZQsaOGNgJ5Ekj7Qgu99qG3/8bzfago2EYMwNqHQhJJ1FkR1zPp9Z0sz6xqsfI+PJcfqOaQnHx60rKft2koz2KKSlteucPEjAZKc7zOEgIFf2sNvW2JIUa9LulHD22GXJapJGEj/R18urgd/KCjnnuMuqjRO0LCI54vpzAsAnam9dRR735wY17AsPRhVNcwM6/KyMZh9c11lgTJ1G2PDRkCJfZGgqkWGz3WmRs+1De1A7YTqJGDuq4qjoDkVVWhMpsYQ5kiJnryJcs4mcLMie94b/ROuJ5lwUzP1vrQs+SX+UD91W2b088vyHz1zLiVuV7O+LODtdTG46l6/OX/TvboeXHRnl0Xevch/HVwWgwEUMBBqWlf41J4NAbmpw3fq5q9bRl8o0CJ/1rvqnR3146uNltTE+DzuyMBQTE+2ZHktOVXgjJrMuVHNTB76H1vhx5ZCLbte7H+geCpLoGTeOFX5gD1BhkntI1WQ9peDxLHjUTioY8dNwmfq1yXY5CfxfrWZkQnvRyuQnG/JC2nZLTiYSFerGUS8C+V6Lc/cliBf3Xx8hGBhJtjyFzgbIBjmuwzWA7KKft+u4O5YchD1sklr6fU6lvXTWtzw91lN/6k73Zv24ejDaDySCdv8RqjSmtIBnmSR82em+eATGmli09tKl+DmTVpbuvUqtJPR2oPs1fjur03eo3s5MkBJY+wf0DFInU0xJHedtuC/7eAUjA== -sidebar_class_name: 'delete api-method' +api: eJytVktvGzcQ/isEL7UBPfyS0u7NiVVALZo4tZ0eHB9Gy1mJNpfcklxbgqD/3hnuypIltQaK+CCTnBnON6+Pu5QKQ+51FbWzMpOjOeZ1RAHi7xr9QrzoOBPP4DVMDAbZkYHkXseFzO6X8vEl0v+H1UNHRpgGWsuvbCbpwCPdEOJHp0h3mbbao5JZ9DV2ZO5sRBtZBFVldA6MoP8YGMZShnyGJfAqLiokYG7yiHmUna2L7qVWdLBBR14r7yr0UdOObElOv28jvBS11c/oAxiz4DXBFFoRFl1o9KJwXsQZHUUse3R96z9Er+2U9iQvgXDLuk7uo46GFe7uxldytQ3nAHhQSjMOMNdbQDkjq/TH4YXK2dCYn52c7AeQMiywKZQSoc5zDKGoKRz5g/KqIMJ+NtPpxhK8B/bIifpfwVK0F4cC/AZGqwRbUC0IA8dHyRfovfPhRwUZ+ab2yr1Y43ZE+7UneNiNukQ6fAv+llonXfpTEKwQIpRVjxujdXWgIY0OUbiisRNkE2Cahu3fMg128aVIE/gW4aqzH/LbuHKncD8yQtd6PSBbrR5SrdaNPmKUcl2/0/2A/tBNuSgWbZ+5mOK3v27ZyeBQucdUS09NIgJ6mssmC3KVMMWZo1rJyoUUCsQZ7fpQ6f7zaZ8ZisLqt6OQyIlvCCkztTekO4uxClm/b7VRk67C0vVoachzz2J8cf5JMnutWe2GO6fJVOK212TwPewgyWk/QfDo6aRZ/LpuDA50tyUuxdX4qksSUae8MLuMbs4Gw98FmKkjv7My0Q7UJCIeonamwUarKqdtDL3vlo0rWBgHSpQ1dYu2uakVZt9tV2iImRiHUJMRxE3XsQznVSZG80r7ZqBeheLIY+7KkrygOmZVqFUmbsFPMQpLbSIU5oTGUwED3bxFkUcUTzKhQmfik9EkoXZ/Tz/VlGf0z83TMJoTFoNrspbnBfw8KIYX3cGH0w/di8HwrDs5L/LuWf7L8LwYDqGAoXxLsnyrtoVL1Wp7lGp89VFcXo9ZlzqiKcRJ76J3sleebzroKO6Vy8Nrb1BmHo7WvbMrORZglbifUt3qCR/0PzfCz01HNc22sX9H8VhEJwy1kRWl89jjRHVSy5eQ6MxCarn105we5t0olhtOfP8Nb3s64jz2KwM6OUzzsmxn7J54VXPuTumnnTNmy3bSaGJmPJKkt1xOIOCdN6sVHzfg6JtgU6P0hUAGCIomhkfzCUlFfmoAd28ZDaubOpHdLqEzqTUWl/TSVfE/dR+2WOP6yw0P46T9AikT9UkPL/wQ0G8maeFSAtPEp7OlNGCndaJC2dzJDcajuUUHO+O/TcXEzVsIKT1J49Y9oaUUddpQIu9lYtZ/ABcPSn8= +sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null --- @@ -22,12 +22,12 @@ import Heading from '@theme/Heading'; @@ -40,7 +40,7 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: -Delete a schema +Execute a query with variables diff --git a/docs/api/nildb/get-health-status.api.mdx b/docs/api/nildb/get-health-status.api.mdx index 8a42e5f..5a7cce6 100644 --- a/docs/api/nildb/get-health-status.api.mdx +++ b/docs/api/nildb/get-health-status.api.mdx @@ -1,49 +1,63 @@ --- id: get-health-status -title: 'Check service health status' -description: 'Returns 200 OK if the service is healthy' -sidebar_label: 'Health' +title: "Health" +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' +api: eJyVU8Fu2zAM/RVCl7VAmwTFtoNv3dqtWYFuWLLtkObAWEzMTZY8iW4bGPn3Una6ruuh2MkyH6lHvkd1xlIqIzfCwZvCfCVpo09wMpnA50vgNUhFkCjecEnACSpCJ9XWHJnQUMRcNrVauCG56KGZoLRJccFNMsXCXAVLZnlkIqUm+EQa7Izenz9PyWfPaXa7I1OTVGHPofc2KJX+jIcUDeTuKGauzrTRKVaJNKkYjz07uzq2VIeRHp2yjDzJbYi/zG6ZC8s2smxnZUX10NfPW8kf2Ta0vycT9Lj+rwgjRY0Mhw8h1qj55tOPuQafDnMKZ9OzY0WgTew3vY7ns5M3by8B3SYob1XDOkTAViEvXKKQBfK2Cewlja59Lm5w6wJaqNskwL50raXi2h8DoxQwTanVIhQQ1gkE6yZjdNcUcH7X8GDQIwgHkcpQ18pC9jCnYmsLmGNUbcGrU2Cp1G4iOk56M9vc2popwoHO05dwSgW8d6zIq/Rifm8h+3XodWVxWUh14+wdnH6ZqmzZu0Gyyej1aPJMyO+cWGBhQ5n+uKgzLA8eXP4XOQT0FhYbVbhd5cD4agCvBu+HtXisfyHxECSAU8M91CHSKI+kWxiS1OjzUB775bh42Mcn7XemDF5UlP97XPsFFLqTceOQe85+ubv9A1iY/QPQRa60mRzpuhUm+hbdbpfDv1uKW43r8QYj4yprv1j+/aQ+ns/VoHvTeGP9 +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"; + as={"h1"} + className={"openapi__heading"} + children={"Health"} +> + + method={"get"} + path={"/health"} + context={"endpoint"} +> + + + + Returns 200 OK if the service is healthy - + + + - + + + + responses={{"200":{"description":"Service is healthy"}}} +> + + + + + \ No newline at end of file diff --git a/docs/api/nildb/get-node-details.api.mdx b/docs/api/nildb/get-node-details.api.mdx index 5304c70..ae67313 100644 --- a/docs/api/nildb/get-node-details.api.mdx +++ b/docs/api/nildb/get-node-details.api.mdx @@ -1,10 +1,11 @@ --- id: get-node-details -title: 'About' +title: 'Node Details' description: 'Returns information about the node including its DID, public key and build details' +sidebar_label: 'Node details' 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 +api: eJy1Vm1v2zYQ/iuEviwBYluS32R9S+es8DoERetuwNx8oMSTxUQiVZJq7Br+77uT7ChO2noYMCCIaR5599zd8xy98wTY1MjKSa282PsArjbKMqkybUpOu4wnunbM5cCUFoCmtKiFVGsmnWXzxfyKVXVSyJQ9wJZxJVhSy0IwAY7LwnpXnq7ANK4WAkOswd2in/mT2fG19eKVR7ve3ZVnwFZaWcDNnRf6Pn2cojzcfYEMXaVaOVCObvCqQkxN2MG9pWs7z6Y5lJxWblsBOtLJPaTOo5hfamlAEA7ruHG4vPKaRPBTSPrfZvkOtriuTUFQK0O5OdliPV7s/FtnsFB4vq0m7gjuoOdkSWhPk1riJnooK/aYg+rq/cgt6yDBBk8U5Dv0w1EvCHvBZOnP4mEU+6O+Pxv/7e2PwM/keUCR6rKUZPsKxhKUV3k1B/9bUm8aKrhjat9NIBwtw2E8nuFfA/4A6DsBT32/lY61Z1nObc60YVJg92UmwZxESv2RHwCEE0hhmE2D8TgT0yiKRlHCsyAMUyGmfohV2XdVOBue6PoLcrCS7HjneUy/j+3w9vt9S5+z7uaITTnDC/kNBFs8JcIuUGKXTGfPed6FQd+xkkXssMAKHK0LdBhArQzU3wq3WRebWbYZzYZFaCLIJkYUhtcjYYVKKeGO1mcxvu90/iM8fiiCLJhFIpvxySjLeDhNw9kwmgQJTyFKIz8RkySAYOyD70fhZJpNs9kIOMxgkg4jv8FE8voZ4WojX4H79OEPUo6BTjopVywBZoCj8E/VkztX2XgwwHqJpCeg1P1D6fpYxkdtHjxqnZOuOX5Nk6YZUPt909MSXK4P44xmA3c5fhk0Ewm/WzBECpTZrk3mXwW8o4spJue2H2lUtfK7f3wuBvJDARo7fk+Am4bu7eK3Y4l+/2v5qkTXNK57aGG1pQFOhbr5GI4n7xgv1hrj5iXDIjNeowkJiPMTyQhKVFoqZ/ufFV2u+LbQXLCytu7wHED8WfWY5C5mC2trvMRdJ3uywaaK2c2mku1T0BnZhQGSMUYBcUlHeS1ituQGS9v2UTxpw6Jn+UIbTWRrY/ZrIdGCmjx3vmktPXHtdGtbjN2Yv2HX7xfPRuFRxi8L+ae0OHVWQqf2qYuYw93FscsvLZfNw7haY4XrhDYGt63xtu19S4vu/pmDl8xpVmDDFSu1gT6lhCTU1pW8GV2KN+QgxrLupT1JYte9lv/Ps38grIONG1QFl+qZslu9rLxWL8j7HLHTxm6XcAufTLHf0/aXGgwOphUuv3IjeUKtWt2hoxy4QN6TwB5odnnXaQpV847xoqbAr34BkL6edPv2Zok0+AeZiRCM sidebar_class_name: 'get api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -21,7 +22,7 @@ import Heading from '@theme/Heading'; -List the organization's queries - :::info You may use this test Bearer token we have created for development @@ -42,6 +40,8 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: +List account queries + @@ -184,10 +184,10 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ts: { type: 'string', format: 'date-time', - description: 'The time of the error according to the node.', + description: "The error's timestamp.", }, errors: { - description: 'List of error messages', + description: 'A list of error messages', type: 'array', items: { anyOf: [ @@ -209,5 +209,6 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb }, }, '401': { description: 'Missing or invalid JWT' }, + '500': { description: 'Internal server error' }, }} > diff --git a/docs/api/nildb/list-the-organizations-schemas.api.mdx b/docs/api/nildb/get-schemas.api.mdx similarity index 67% rename from docs/api/nildb/list-the-organizations-schemas.api.mdx rename to docs/api/nildb/get-schemas.api.mdx index 5e013de..0126e37 100644 --- a/docs/api/nildb/list-the-organizations-schemas.api.mdx +++ b/docs/api/nildb/get-schemas.api.mdx @@ -1,11 +1,11 @@ --- -id: list-the-organizations-schemas -title: "List the organization's schemas" -description: "List the organization's schemas" -sidebar_label: 'List Schemas' +id: get-schemas +title: 'Get schemas' +description: "List accounts' schemas" +sidebar_label: 'Get' hide_title: true hide_table_of_contents: true -api: eJytVttuIzcM/RVBL00Ax07SdNGdt2ydFukFLbBJ+7AbBLJEe5RopFldYnuN+feSmhnfkSzQ+mV0oUge8pD0igeQyeu45MWnFX+aR/w+NA8DHsUs4JqPRRQc9x5C7WwAPFzxy/Nz+igI0us6amd5we9KYM7PhNVfBR19F1iQJVQi8AGXzkawkV6JujZaZpHRU6CnK94K0ioua0BlbvIEMnKy+yVpD4p8UZ0vtXc1+KhbZ/Lp5qXwXizxoY5Q5XthzJ/TDG9f966eR60OQV2zZPUL+IBalrT+koBphVD0VINnU+dZROBkbYgqOxMhem1nuMf7SiBsnhKqx3sdDQnc39+OeTPgj9KDiKC2ABy+RYRwFnUFeHgY86wBt4wkQhRVPcyaU63+o2YjQmStmh3lzW5aHjOyNZIt0w8bwGMnU4Vh+yACoHuvJ9qK7JGbW/D4fYYlcagjyQEBsvSxzAVKkNdgFeaufc061bsRaXpbR0mtQKLjXhgdQG0n/2R8Oz5lbpoZgApQ1U4FHOEDLDCEOSBKq8JqU0QMq4VIa4NvLiBZD+mriYuZWbyfLq7ef28u/Y8wfeeV8SJdqaCsJJdzWI563GLFAiQRNi+1LFmVMJkT6Dk817HUNnsuQnBSU8L6IElnDGaFSHUCw9mQ1V5Xwi+zvtMNrINa2wtrM9iq7EM3qfp7k4liGx17wTBnwlFZo79IVawubDw+u6MtysQ1xC1PN151lGqaZot/H1s/mvY34FfHWtjfrXEyhHWNLJMQAmUVvHf+f+tjkTR1Kg/YHI8E8psrli56QmYDTEjpvCIMXeCsU5AbROfAQRB+10gU1NG+x6oPYgbhlaQLu9xtsOuqeqvlSvTlCG0GvLN6jFLNQ85fn9cb8pL3Ob04hPOHblOIWLTN7GK//nOXuXkEd3xtiFUQS4cZ5DPIWEQscTMStR69XIw2ckhWGhk5JMkblCljrEMxGmGRq8mZgsoNu3ofYu3PnX/mRNZ+GGeytiHKI3kdBdLTd0LaT0D43CLbxc89SwjhPr5rhu3qDG+w1jIfEOrNx8sf3v3GhJk5tFtWeZ6JhFfY42RuCdg9a4dlF4afLT2uxdI4odp+oq00SUHx2Z4x7CAFuw0h4SMRNwOD7mBRF+xmUWu/N6rYiQfpKpwMCtQpiYqkCnYnPMY4c/WN9psth1Cwnww2+oj5eks+p17bqctx7WiE2Rh/YNd/3WLYKHdtyM6Hl8NL4mPtQqyE3Uybb2DLTvTXGYywiKPaCG1Jb2bHqmPSJ2wpmuxfrIdd7g8lGqfb1WqCw/Pem6ahY+zinv624fJFeC0mBAT/vOEDEIqGGdIPGzalXkqoibLI/5RreL93EfvW9P7lhthDNNhyfI9q2/WODWBLN7qZJe7cM1h0ddA5EWnPc/n+C/ljn1g= +api: eJytVl1TGzcU/SsavQRmwAZKMo3fSKEZ+pF0JpA+EIaRV9e2iFbaSFqw4/F/77na9cfabnlI/eJdSffznHu0c6kpFsFUyXgnB/IPE5NQReFrl+IrEYsJlSrKIxmpqINJMzm4m8vH54T/+8X9kUxqHPEsP+WTEiuBYuVdJCzP5dnJCf91g9xMSPgwVs58V7z0Km4EKrxL5BJbqaqypshH+o+RTeeyOchPaVYRnPnhIxVJctxvtQmkORutUs6lCr6ikEyTTF5dW6oQ1AyGJlGZ95W1H0e5wG3fXT8PRu8WdSFqZ54oRHiZ8fO3moTRKMWMDAUx8kEkFM7RenDZhogpGDfGO/ZLhbJlXcM99k2yfOD29vpSLo7kQxFIJdIbBezaokI6TqYkLO72PHvAq+ATMamy6mXPdaV/0LNVoE3jpuN80YXlIVe2qmQj9P264Etf1CXa9k5FQnr/DbRTOSP/7CgwS1cs7CKWj+2DLDIywZDTAK2xFq3PbisWyyB72aypQMZBWRNJb6J+cHl9eSj8KEMPB3DVof4eItAUvcud0EYPnLGDhH46SvxsYXNKtQtUf7dpOrbTt6Pp+duf7Fn4mUZvgrZB1ec6aldwyutp2c2ZJ2pZcs1pJy+eUEEGkUdFDAnwg7EY5pB5YxzOcCWtWeGtBSadOlqYFovFBqatOiya35E83ycLn5vgHAizAgALipEbRiH48L9pQ2JPrcsdoqT4A1OQnULMuuPVhtrDPstiC27kEwI2UY0prlu5K1Bu1hWoFTlfkqzCa9qtDNm1UffsAcCM1RLDK85SLvE73S3oT9PAhVqMy0wSv/19w0Fe74P7GlgGp6wAu6CbTReyZJSUJh5YyTHlSlSa4KWvKtN/Ou1v3klsGHND6mBxZpJSFQf9PiZFD481lb7XDk0PA/Tsw1fJtFxeZpmWTYPylbbqAftZygm/D0mFLDDNw69LPnB920y4EJj5Y+xgqrgdPC9Xn85ev/ldKDv2iDsp822gamxBKApWQAEJqjwGLPa+ODau1Mx6pUVZgyTGFbbWNPjijoVRaSCuY6xhpNKabLxH02ogrqaVCVtCLw4CFb6ErmrSh3xU1XogblRAj4UDO17QsBw5xoH4xUItE1j+0vkMpXEjn/vakghoXL4TF39do22MXdOyk95572SnkZ9NNEncaV/EFYqo4f5gifL2zqFQTou7MTpcD3mh/6HZ/NBg39Bibf/CwUNWRAvAnSihgz0uCWz0MZXKrW8V+R4dXJOyU8N8LVn//mnVci7RNPUrq0wOk/k8b7l/B7kz3LHT1R2XtWuCXHh3Ph/isrwNdrHgZXx5BP5Qw+OTCkYNufX4XIMBKc13GAbmK82YrEVBFQ8Z5rXOmrOtqzwvq4F8f8V8Z+JuDMvWcGzqEwRrwzfSzCdu/FdySPWoTSLxu8xy8w/EYakr sidebar_class_name: 'get api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; -List the organization's schemas - :::info You may use this test Bearer token we have created for development @@ -42,6 +40,8 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: +List accounts' schemas + @@ -88,7 +88,7 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb }, { type: 'object', - required: ['name', 'owner', 'keys', 'schema'], + required: ['name', 'owner', 'schema'], properties: { name: { description: 'A user friendly schema name', @@ -101,12 +101,6 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb example: 'did:nil:testnet:nillion1eunreuzltxglx9fx493l2r8ef6rdlrau4dsdnc', }, - keys: { - description: - "The schema's keys which must be unique within the associated schema collection (e.g. primary keys)", - type: 'array', - items: { type: 'string' }, - }, schema: { description: 'The json schema used to validate data before insertion into the schema collection', @@ -134,10 +128,10 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ts: { type: 'string', format: 'date-time', - description: 'The time of the error according to the node.', + description: "The error's timestamp.", }, errors: { - description: 'List of error messages', + description: 'A list of error messages', type: 'array', items: { anyOf: [ @@ -159,5 +153,6 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb }, }, '401': { description: 'Missing or invalid JWT' }, + '500': { description: 'Internal server error' }, }} > diff --git a/docs/api/nildb/list-new-data.api.mdx b/docs/api/nildb/list-new-data.api.mdx new file mode 100644 index 0000000..ed0ee3c --- /dev/null +++ b/docs/api/nildb/list-new-data.api.mdx @@ -0,0 +1,170 @@ +--- +id: list-new-data +title: 'List new data' +description: 'List recently added documents from a schema collection' +sidebar_label: 'List new data' +hide_title: true +hide_table_of_contents: true +api: eJy9VltPGzkU/iuWXxYkknBLups32rASe2lRge4DjZAz9iQGjz1re4Aoyn/f73gmZHLRVtpWywPx2Of+fefYCy5VyLwuo3aWD/kfOkTmVaZsNHMmpFSSSZdVBTYCy70rmGAhm6lCsMwZo7KkeMSDyiqv45wP7xf88SXid7wcH/EopgFrPhJRcHx79XelQnzvJEQXPHM2wjQtRVkanQmy13sMFM2C155oFeelQnxu8giXvLajvZJku5GC9dK7UvmoVdjU3kzyglVWPysfhEGSWCMkpiXi0LlWnuXOszjDVlRFF74a3yF6baf4xnkhEDOvKi3pXEdDAnd3VyO+TH8UYCidDXUkp8fHu2HcwoURqPdpH78RVWmVui59dCmQfQX/IZWTDSqbdUu7a03hvZhDkcqRzlG2T3kCetv2pp0HVOd/Lv4Rf8i8QjFlK4FdXWSoOlEXCpu7oCQL+GQkEaIoym6yXJXyOy0nuGszG8aXm7A8pMzeMmm5Hq8THjVceS+CQni7YIBCmnwLc92CJfpK7QttRb2fEvcaRbYGtMtuahZKVSpLeCHudjggzSqkpgmQ1fk+4n8RRsu6wgAbLjIVAurIlPfOhx9F7kiWGpM7HI/hO2BMRlGoTX40rvYw3tBUdXmtx6ATxFSFNbl3O8zONzusiXAfzJt5ZU6q3cwQXeN1z9lyOU5YrZC8pCj5Cr+T3YT+1DVcyEXbZwKT/fbXLTnp74P7Clh6IlNQHo1fVyFxvlBx5oAVL11IqYg4w1dPlLr3fNKjOdSLQpt0v5BuSDWpvIHULMYyDHs9q42cdKQqXBdLA59dq+KL80+Jn6uLKbG3rlG6nt7KQHbIQTrH90QJrzx26sWvK0pQittkuGCjq1EHJ6xKFaHBdXlz2h/8zoSZOvidFWmiiQpHGHEZdTFD/5ROY8x3v1pSLsXcOCFZUYEn2mamkmr41XaYFnHIrkKooCTimm90pl7LIbt8LbXfGlbsABe4KwrqUnlIoqKSQ3Yr/FRFZkEQ9DDd8B7QBVhuTd8D5JNUAPGQfTC6ngjfkk9oUnd+Xl/vl6+Ixah2v/KzXPzczwfnnf67k3ed8/7gtDM5y7POafbL4CwfDEQuBsQjbXOXIGooCWBH79nF9RUQIBrU1T/unnePdzD5ooOO7B7zLLwRAuUYH6wIs31yyISV7H4KsKoJbfQ+1ocfaxrVDFvrf0PwkG5tA+5YVjivulSdo8TwQqTpZUXiWXpqWfXC0nW7lUXrZfTf32QNwaN6jb3SCJ0CSc2zaFrtHuNVU01PKIA6jtRwaJwZ9SQkFosJbpg7b5ZL2ga+nl55WD4Lr8WEAMJbDwpKSDQOdeiTggj/UKfQuaU4SNxUadptT3SaarXGRZapMv6r7Lg1Nq4/3VBPTprHZJFmH/fihW4C/B9yLFwqaWr8tLfgRthplWYhr20Se6lDW1Nhawq0ZzGGcytClCdJ3LonZVGioyaVSN88jdZ/AEyj77k= +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'; + + + + + +:::info +You may use this test Bearer token we have created for development + +``` +eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ +``` + +::: + +List recently added documents from a schema collection + + + + + + + + diff --git a/docs/api/nildb/overview.md b/docs/api/nildb/overview.md index 8754cc9..aaa5cfd 100644 --- a/docs/api/nildb/overview.md +++ b/docs/api/nildb/overview.md @@ -15,25 +15,31 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb NILDB API has several endpoints you may interface with: -- System +- Accounts + + - [Accounts](./accounts.api.mdx) + +- Node - [Health](./get-health-status.api.mdx) - - [About](./get-node-details.api.mdx) - - [Accounts](./retrieve-an-organizations-account-details.api.mdx) + - [Node details](./get-node-details.api.mdx) + +- Schemas + + - [Get](./get-schemas.api.mdx) + - [Add](./add-schema.api.mdx) + - [Delete](./delete-schema.api.mdx) - Data - - [List Schemas](./list-the-organizations-schemas.api.mdx) - - [Add Schema](./add-a-new-schema.api.mdx) - - [Delete Schema](./delete-a-schema.api.mdx) - - [Upload/Create](./upload-data-to-the-specified-schema-collection.api.mdx) - - [Read](./retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter.api.mdx) - - [Tail](./retrieve-recently-added-documents-from-a-schema-collection.api.mdx) - - [Update](./update-documents-within-a-schema-collection-that-match-the-given-filter.api.mdx) - - [Delete](./delete-data-records-that-match-a-given-filter.api.mdx) - - [Flush](./remove-all-documents-in-a-schema-collection.api.mdx) + - [Upload](./upload-data.api.mdx) + - [Read](./read-data.api.mdx) + - [List new data](./list-new-data.api.mdx) + - [Update](./update-data.api.mdx) + - [Delete](./delete-data.api.mdx) + - [Delete all](./delete-all-data.api.mdx) - Queries - - [List](./list-the-organizations-queries.api.mdx) - - [Add](./add-a-new-query.api.mdx) - - [Delete](./delete-a-query.api.mdx) + - [Get](./get-queries.api.mdx) + - [Add](./add-query.api.mdx) + - [Delete](./delete-query.api.mdx) diff --git a/docs/api/nildb/read-data.api.mdx b/docs/api/nildb/read-data.api.mdx new file mode 100644 index 0000000..844f64d --- /dev/null +++ b/docs/api/nildb/read-data.api.mdx @@ -0,0 +1,177 @@ +--- +id: read-data +title: 'Read data' +description: 'Retrieve data from the specified schema collection that matches the provided filter' +sidebar_label: 'Read' +hide_title: true +hide_table_of_contents: true +api: eJy9VttuGzcQ/RWCL7UBXXxVWr3ZkQOoRRLDl/TBEQxqOSvR5pIsybUtCPr3znBX0uqCJEDS+kHeXc4Mz8w5M+ScSwiZVy4qa3if30D0Cl6ASREFy70tWJwCCw4ylSuQLGRTKATLrNaQkROui8gKEXEhJGPn7YuSaJsrHcHzFg+QlV7FGe8/zPnTa8T/o8WoxaOYBHzmA9yM47uHf0oI8dJKNJ3zzJoIJtKjcE6rTNCG3adAUOe8gkJPceYAwdvxE2LiVRzlQVLs2qrFazS4DQJ04KOCsBlmsxQXrDTqBXwQWs/oGbExzMtEqoRnufUpXRWh6GD8GkTAApoJ7Wc9VgW/lKWStK6iJoP7++GAL1Z49sAvlLluQDxucSGlIlhCNxeiL6G1hfqjNRM7uGyHONPAELKfrXlYQvhQfVikPypXcNaEqhwnR0e7tSCCmLRZWWD6oUH5PsI77FpMlElkMRWYsZGF0jnrI0iq1C/hVdaa2SQzfV17Cu/FDB2Jo7SOXH7Okwy3Y2/GeUTK/ndFPGYeRATZSGDXFzOEdlQF8G3q73DrFCF1JVqEKArXSZFLJ38yshYhsirMRvDFJi2PKbNVJo2tR+uEB7WSLkUAhLdLxo/rnaAthflbYGtHtia0w26rqSXBgSG+EHcTDopmCaluCszqbF8jfBFayarCSDZukUEIWEcG3lsffpW4I0WqQ+5oPIafoDEFxUJt6qPeao/itULabV75MfQJYgJhLe7dDjOzzQ6rEe6jeTOvzErYzQzR1bvuWVssRomrJZNXhJIv+TveTeijqujCXJR5ITLZn3/f0Sbn++geIpeexBTAY+NXVUiaLyBOLXLFnQ0pFRGn+NYVTnVfjrs0h7rYAzKdfuQbUk1Kr9FqGqML/W7XKC3HbQmF7eCjxj07BuKr9c9Jn8tjM6m3qlE6PFdloDi0QVrH9zEInwZ99fBhKQlKcVsMF2wwHLRxhZWpIjS4rm5Pznt/MaEnFvedFmmiiRKXcMRl1MUM+8dZhYdA56shZydm2grJihJ1okymSwn9r6bNlIh9NgyhRCc8LVZ6ozV4c3129eaU3xpW7MBDZouCulQekqkoZZ/dCT+BiAeJxGaHDNF4pC5g5Mb0PcB8kgtS3GfvtaomwvfsE5vUnTfry8fVG2LR0OxXfpqL38/z3ln7/N3xu/bZee+kPT7Ns/ZJ9kfvNO/1RC56vHGqU1hlcpvoquWJJA8u2cX1EA1JEhUTR52zztEOP19UUJE94GwLK3FgaUYHS/FsrxwyYSR7mCBx5Zg+dD9Vi58qSVVqW/t/x/CQRcs06siwwnroUKVaSe2FSJPMiKS5GxR5ui1uZ9C4v/1H18q6CyK8xa7TQiWEqcPmdT8+4AxWVOxjQleBTF2J3TWlxkWL+XyMx9C914sFfU5XJrqgopfwSoyJObyuogM6ErXYxs+AJvx9lV/7jnCQuS7TSNwe+zT6Ko+LLAMXv2k7asyW68+31Ljj+j5cpAHJvXilNPC3z/HBpnqn6ZC+zbkWZlKmgcmrmKRFauPG6NgaFc2BjRO8gRDLkyzu7DMYLFGrTiXSO0/z919CLkCA +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'; + + + + + +:::info +You may use this test Bearer token we have created for development + +``` +eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ +``` + +::: + +Retrieve data from the specified schema collection that matches the provided filter + + + + + + + + diff --git a/docs/api/nildb/retrieve-an-organizations-account-details.api.mdx b/docs/api/nildb/retrieve-an-organizations-account-details.api.mdx deleted file mode 100644 index 86f2593..0000000 --- a/docs/api/nildb/retrieve-an-organizations-account-details.api.mdx +++ /dev/null @@ -1,144 +0,0 @@ ---- -id: retrieve-an-organizations-account-details -title: "Retrieve an organization's account details" -description: "Retrieve an organization's account details" -sidebar_label: 'Accounts' -hide_title: true -hide_table_of_contents: true -api: eJzVVktvGzcQ/isEL0kAW7JVN2j25tZu4aZFgsRuD7ERUMuRRJtLMuTQkSLsf+8Md/WwJcQpkEsuWnJIzuObb2a0lAnqHA0uZPVhKW8/I31v2psDiWqaaC1P69pnh0mSLEIK3iWgg6UcHR3xR0OqowlovJOVvJyB8HGqnPmiWPQsCdUpEBpQGZvkgay9Q3DIr1UI1tTl6vA2sYqlTPUMGsUrXAQgpX58CzVKtv8pmwia/fpoNEk+liv0rSMohCLKQffLkMek/TUsaO1Uwxc75ezFpwzRQIkrRB8goukCY817A+sjSRRKTf5HZU0CLYymjZkYiOL52cXZC9LdO54wGjelPcxVEyyLtNGVM7ZCSOgAeW3JwjFkFyF/sTif2vmryfzk1U92FH+BycuobVT5RCftatmuQt6gszHicsPIKN0YR/vtPMibdgukPY8nPjYK2UG6cYiGwGq3sPzmFxvId560fRL2HazSsoP7qSCQUfiJ6K4Q2kngTKEYg/VuKtDT1qxptgFfxag48Qah2as4O3MPMSlrF7wmPmynksIjxSSi54M9KV2Hn3NhIhosCb66ujiTbbvh11dC4iuLHyWidiPpewILSXqyrxH8Q8WhC/WoHwgqsBpSIjsCYvTxu3UBZE29yp1CxvSNvD3YU+x8wDlixIqBko+ozSpDIJzXMGD29g7sgPBXn+fufUMIqCmkryRUucWbSenEjytkF4aHsdbky97K6q3uOWvbmwdZPWcv1zk93g3nb9OlkGIx7p4TLP7897KQ/eHFd0Am4J46pnt6GjSAM0/JlFMoYSmc0WaoghneHw9XPZdbN0Rmd4EnR0uXZoghVcMhNVE9PtTQ+EHfTwfUWz/7eCd5lK1G3HumVAdXGXRrRFjPajbwfgwqQiRJt/h9xRiO9nGsp4J6/iGdiFzAYWKcvx/9/PK1UHbqye6sKaWnMh1RLdbcUAU4HbyhwAbXjh8HtbBeadFkooxxtc0aqmt3KIzCSlyklOkR9QimZUKaJnwG81CJ83kwsau09aF4HqH2TUNWQL/gqyrrSlyqSCAX3j4xw4rllCrxmzV08uypmXftCg2Mm/iCa08pysbZr+L07QXBxrnrIDsajAajMix8wkaVcu8mw/9jzoNErJOJMMdhsIpmIJkoRFn2rKLZGAy7ckw/auuPzYwc4ePlcqwSXEXbtiwu/Zn/ENETFY0ac1AfeJTOQGliCFPxjmcdt0QIzF+qi1xq+3FPYyauuf7HOTOJKbHl+SPabfcBagxbusnNcuPS34EjVw96J5D3spT1f+PaZrc= -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'; - - - - - -Retrieve an organization's account details - -:::info -You may use this test Bearer token we have created for development - -``` -eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ -``` - -::: - - - - - - diff --git a/docs/api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter.api.mdx b/docs/api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter.api.mdx deleted file mode 100644 index e8a5186..0000000 --- a/docs/api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter.api.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -id: retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter -title: 'Retrieve data from the specified schema collection that matches the provided filter' -description: 'Retrieve data from the specified schema collection that matches the provided filter' -sidebar_label: 'Read' -hide_title: true -hide_table_of_contents: true -api: eJy9VktvGzcQ/ivEXpoCluRHrLS62ZEDuA/EiO32kBjGiJyVaHNJluTKFgT998xwV2+hOSStDxaXnMc3M98MOS8iyjroNCsGn+fF00ui34fFw1GRYBxpXQwhQUHfAf+pMaZLp0h0XkhnE9rES/DeaAlJO9t7is7yXpQTrIBXaeaxGBRu9IQyFY0dHVCx7VbqqCi1SRjYjQ/OY0ga47YZhVEG7dkJWbsQtdVTDBGMmfGasAmtCJAuNQZRuiDShLYSVl2y34KIKWg7Zn8uVEDgi7rWis91Mixwf389LBYrPAfg7+CwojkRAX3AyADsWDTqggTpR0OGQwgDRcVoQCnNBsDcbEX7DV+iNPiqRwaXPil498L+wM7EM846UzCUBw86xCPxMsGAIm9FIcGKESmWWZYddTnOZdwfmngX+Y9rFL2zsUF1eny8XwBmhVBO1hWFHCnXkARlVE5y2qmIU6qGahPRFTcwRpsZInQU1iURa+9dSKg4IT+ETKol6jaD8u5aE0KAGSkyMWKmPCXxY5lXu8a3DT0SUf53Hj7KgJBQbUSwr0shYifpCvcoc0euswVOPEvEBJXPlX+svfpOywZiEo2ZLeOL7bo85shWkWy4flgHPGypdAkRCd5+MQ73TAo1HoK2ZOZPUawVxbqgXXGbOSUUerRcL8K9CYdYs4REB8u+eHuoFf4Co1WTYqo2+ZAYI3clhuBC/FH0TmypNbnH8hS/o458wJOBiZodCJDSBcUxJJe3rVPNwGgB7CXhD01cIBuNPnEhUsfHNeN3+o4SYWfbbdeiPlT77VglYdmPlrC1Xg+cLXIJ1+W9YpTFsqYn++H8qZsSUizaTrnA4re/7zK1twU/IbnAKTGOB2IZXJXzFT1KngBKNMUV0hlDweQ+XM1KjIemZcGRpImjqhfexZwASBP66oHXvelJj331qJ24mSIGnj85k3UwJDVJycdBr2e1UaOOwsp1aWnIdddienHhOVN9ee/nRmgym2//VfLYDjvI5/Q9QggZXbP4sCQXJ2b/rhpeDzt0IuqcRw7z6vb0vP87XVpjR34nVR6OUNMRTUvJA0FQK3qn6ULpfrGs7GFmHChR1cQubaWpFQ6+2I7QkAbiOsaalCibq+nDZ/jqB+Lq1euwM/fEm4DSVRU3vPqZRaFWA3EHYYwpU5zGgSQ0gQoeyfLGIH9D8WQVIsZAvDe6GS7fks+M4T7/tH49Xb0SFoObnV+clfDLedl/2zl/d/Ku8/a8f9oZnZWycyp/7Z+V/T6U0C82niVsVtvS5XK1pKYiDy/Fxc01CTIlmkocd0+7p9wdTKUK8sCxkAv633B3iwgrMiV8TT1vQFvGkok6b2n9mYaiZswnrM3XNQ8+yNfDhPlPEvP5iC6G+2AWC97mtxQ/WGk5BXpgjTgB9GwlBVLkDFE30IOIHL9vZm/njnGwOD2HeB7tzmGeO43GhZTo07/KPmy06M3HW+b/qH0XV3k6FQFeOAz6Pyho4XI+cpPlvXlhwI7rPK2KxiaXlLthI2k7Hbc5LWl8biCk9GSJO/eMllJ01IaS+Lu5v74C180fgg== -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'; - - - - - -Retrieve data from the specified schema collection that matches the provided filter - -:::info -You may use this test Bearer token we have created for development - -``` -eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ -``` - -::: - - - - - - - - diff --git a/docs/api/nildb/retrieve-recently-added-documents-from-a-schema-collection.api.mdx b/docs/api/nildb/retrieve-recently-added-documents-from-a-schema-collection.api.mdx deleted file mode 100644 index 63166cf..0000000 --- a/docs/api/nildb/retrieve-recently-added-documents-from-a-schema-collection.api.mdx +++ /dev/null @@ -1,171 +0,0 @@ ---- -id: retrieve-recently-added-documents-from-a-schema-collection -title: 'Retrieve recently added documents from a schema collection' -description: 'Retrieve recently added documents from a schema collection' -sidebar_label: 'Tail' -hide_title: true -hide_table_of_contents: true -api: eJy9Vk1v4zYQ/SuELt0CsZ04sbf1LVmnQPqBDTZJe9gNAloc2UwoUiWpJIbh/943lBx/oj1k0RxiipwZzsx786RFFiivvY7zbPR1kT2+RPzeL++PsiinAetsLKPM8Ozp75pCvHAKpossdzaSjbyUVWV0LqN2tvcYnOW9kM+olLyK84qyUeYmj5THrImjPSmO3VoheuVdRT5qCtveikLudcWxEeRc1FY/kw/SmDmvkZLQCnnoQpMXhfMizrAVqezirvbuEL22UzzjvJTIOatrrfhcR8MGd3dX42yZ/jjBUDkbmkz6x8f7adziCiNDFP0BfiO6IpTL6xJ5BCGVIiWiS4k0hYjcGYPq2fvo+3ROtahs9y3trj2l93IOR25HSPiib5+LtNoNvh3oAe35n7t/lD3kntBNtVHBvi9KpE7UJWFzH5UUAY+CLUKUZdVNketKvTNywrsJsxV8uY3LQ6rsrZKNq+/XBY9bslzIQEhvHwxwSPPd0lxvwBJ9TYdSW3Hvh0S+1lGsAe2Km4aGiiqyjBfy3kwHrFmlhIPVHJwdov6f0mjVtBho446cQkAjBXnvfPhe9I4cqQ25x/IY3oEjHwhXJKKmC4TMc+cV19AOrXWKEm3aBPaa8LsGFxCj8QcXgpxSWDN+Z+7QCDvfHrs260PYb9eaI5f9apFbe+uBs2WCcA3vJWeZrTA92S/nD91AiFq0fWaAxa9/3SZqbxt+IVxBzyQ85YAYItCI3Vr8Cu9KIQ/KXklx5gBuVrmQ6pRxhqeerHTv+aTH0tWLUhscBfIsM6lhtTewmsVYhVGvZ7VRk46i0nWxNIjctRRfnH9KjF69yxLfmwamN9pbjzgOX5DO8Twh6cljp1n8suIQ179b/bkYX407OBF1ahdT5fKmPxj+JqSZOtw7K5MGyhpHEMWc515g4iqn0ZzuN8vOlZwbJ5Uoa5BI29zUikbfbEdoGUfiKoQaTjKuRYbP6LUaicvXSvsdeRMfgIUrS55r9SObylqNxK30U4qJyZh6BssD14DIG3r9AfUkF+A/Ep+MbjTkv+wTMXicv6y/CC5fkYuhzQHPTgv506AYnnUGH08+ds4Gw35nclrknX7+8/C0GA5lIYfMZG0LlyBq+Qpgxxfi/PoKCDANmu4fd/vdPpszfUqZtMTKBOK7aLmF8RtPIr3GXmWktnxl4uCiZexXyJrm1E7Ym1+4/K0E3oJ/M6Y2LBaLCaT9zpvlkrfRJs/fV1g+S6/lhOvEVxYcSCrwj4n+RDDJPjXq2bnlPNjc1ElRdpWUlaPxOM9zquK/2t5vTN/15xum9qT9jCuTvmRevrAC4/8ow8KlfqT5SXuLzEg7rZPeZE1MJgETfaNpO8O0qXcQwI0M0Z5kceueyKJFR20pkZ+bN9A/Dwym0Q== -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'; - - - - - -Retrieve recently added documents from a schema collection - -:::info -You may use this test Bearer token we have created for development - -``` -eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvbjF4dnRuM2FhajQ4dGY3bm5zZW16MGQ2OGVwbjZlcHU0ZjRhNG5mYSIsImF1ZCI6ImRpZDpuaWw6dGVzdG5ldDpuaWxsaW9uMXd3c3Jqbmd4dnU5dGMzMzVsajlrM213d3JybDV3M3EyZDB1ZXR6In0.yOKg-wyJdyn9jK-KNtkjbi9PS0pF9wmgVmd7pIeNGhoTjhgZhzB62atbgzE45OGGYx0gUsw_i2k3K2AdFf_tuQ -``` - -::: - - - - - - - - diff --git a/docs/api/nildb/sidebar.ts b/docs/api/nildb/sidebar.ts index c724689..1dc9784 100644 --- a/docs/api/nildb/sidebar.ts +++ b/docs/api/nildb/sidebar.ts @@ -12,98 +12,122 @@ const sidebar: SidebarsConfig = { items: [ { type: "doc", - id: "api/nildb/retrieve-an-organizations-account-details", - label: "Retrieve an organization's account details", + id: "api/nildb/accounts", + label: "Accounts", className: "api-method get", }, ], }, { type: "category", - label: "Schema", + label: "Data", items: [ { type: "doc", - id: "api/nildb/list-the-organizations-schemas", - label: "List the organization's schemas", - className: "api-method get", + id: "api/nildb/upload-data", + label: "Upload data", + className: "api-method post", + }, + { + type: "doc", + id: "api/nildb/read-data", + label: "Read data", + className: "api-method post", + }, + { + type: "doc", + id: "api/nildb/update-data", + label: "Update data", + className: "api-method post", + }, + { + type: "doc", + id: "api/nildb/list-new-data", + label: "List new data", + className: "api-method post", }, { type: "doc", - id: "api/nildb/upload-data-to-the-specified-schema-collection", - label: "Upload data to the specified schema collection", + id: "api/nildb/delete-data", + label: "Delete data", className: "api-method post", }, { type: "doc", - id: "api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter", - label: "Retrieve data from the specified schema collection that matches the provided filter", + id: "api/nildb/delete-all-data", + label: "Delete all data", className: "api-method post", }, ], }, { type: "category", - label: "Data", + label: "Query", items: [ { type: "doc", - id: "api/nildb/update-documents-within-a-schema-collection-that-match-the-given-filter", - label: "Update documents within a schema collection that match the given filter", - className: "api-method post", + id: "api/nildb/get-queries", + label: "Get queries", + className: "api-method get", }, { type: "doc", - id: "api/nildb/retrieve-recently-added-documents-from-a-schema-collection", - label: "Retrieve recently added documents from a schema collection", + id: "api/nildb/add-query", + label: "Add query", className: "api-method post", }, { type: "doc", - id: "api/nildb/delete-data-records-that-match-a-given-filter", - label: "Delete data records that match a given filter", - className: "api-method post", + id: "api/nildb/delete-query", + label: "Delete query", + className: "api-method delete", }, { type: "doc", - id: "api/nildb/remove-all-documents-in-a-schema-collection", - label: "Remove all documents in a schema collection", + id: "api/nildb/execute-query", + label: "Execute query", className: "api-method post", }, ], }, { type: "category", - label: "Query", + label: "Schema", items: [ { type: "doc", - id: "api/nildb/list-the-organizations-queries", - label: "List the organization's queries", + id: "api/nildb/get-schemas", + label: "Get schemas", className: "api-method get", }, { type: "doc", - id: "api/nildb/execute-the-specified-query", - label: "Execute the specified query", + id: "api/nildb/add-schema", + label: "Add schema", className: "api-method post", }, + { + type: "doc", + id: "api/nildb/delete-schema", + label: "Delete schema", + className: "api-method delete", + }, ], }, { type: "category", - label: "System", + label: "Node", items: [ { type: "doc", id: "api/nildb/get-health-status", - label: "Check service health status", + label: "Health", className: "api-method get", }, { type: "doc", id: "api/nildb/get-node-details", - label: "Retrieve node details", + label: "Node Details", className: "api-method get", }, ], diff --git a/docs/api/nildb/update-documents-within-a-schema-collection-that-match-the-given-filter.api.mdx b/docs/api/nildb/update-data.api.mdx similarity index 63% rename from docs/api/nildb/update-documents-within-a-schema-collection-that-match-the-given-filter.api.mdx rename to docs/api/nildb/update-data.api.mdx index 377d8f7..c966681 100644 --- a/docs/api/nildb/update-documents-within-a-schema-collection-that-match-the-given-filter.api.mdx +++ b/docs/api/nildb/update-data.api.mdx @@ -1,11 +1,11 @@ --- -id: update-documents-within-a-schema-collection-that-match-the-given-filter -title: 'Update documents within a schema collection that match the given filter' +id: update-data +title: 'Update data' description: 'Update documents within a schema collection that match the given filter' sidebar_label: 'Update' hide_title: true hide_table_of_contents: true -api: eJzNVktTIzcQ/isqXbKp8gMMeBPf2IWtIo9aajHJYZdDW+qxBRppImn8KJf/e7o1Y2NjKlw4hAPWjFrdX3d//WnWMqKqg0krOfq+lo+LRL8Pm4eOTDCNtJZXkEDSc8B/aozpk9dkupbKu4Qu8RKqyhoFyXjXf4ze8buoZlgCr9KqQjmSfvKIKsnGjwmo2Xdr1ZGFsQkDLepKQ0KOVwVfYUgG46E/jVEFU3E0cnspamfmGCJYu+I1gRRGEzJTGAyi8EGkGb1KWPbIf4smpmDclAP7UAJlIevaaN43ybLB/f3NldzsgL2SxwscTjQ7ImAVMDIANxXNcUGG9GMgwyGEgbJiNKC1YQdgbw+yfSOWKCwuzcTiNiYl7xccD9xKPOGqOwdLdajAhNgRixkGFPlVFAqcmNDBIttyoB7nuc37S5PvZtcJ7u//BGXzxwyKlXexATE4OTlmxZg6Tla1TeyC+99kIxh+JirBfRcG63Y6Dtma375xkmhHEfSO8/rYzdbk2ZOry8l+e17b29Xp/LXS/AXW6JypIC5SPIUxclMwBB/ie9UlsafW5VFeaZ8+x6PIiXWTKfGIU9xX3th2NQcQoJQPmnNIPr92XjesbgEcFeEPEzMzmvMlVQCmGJ/lAUKAFT2yauTjxMKvRVbIQ9SbznEZDnNVhOU4W8LWRn1lb7N5yP3bzuQ1o5Tbnp4ep/OnaVpIuRg35waL3/4eS7Y/NLxvpkB7VZfU4igWJs2MEyCargrlraUsmB1pBklkBuaaTkllndjpdIlp5qnTsvIxJw1pRk99qEx/ftrnAei3CtKhKyawROf61cGS3SylKo76fWesnnQ1lr5HS0txew7TwocnyXfQ9m66Y3RNPfMNtSsZ++EAeZ+eJwgh42sWX7aU4nIcC9TVzVWXdkSdq8dZXt8NLoa/k1JNPcWdlVmwoaYt0nPFAyfQ6cobKl7vh+PDFaysBy3KmjhlnLK1xtEP1xUG0kjcxFjTISol8zYmKCvew2U1EtfLyjRq9LwpPgRUvqTuaNQ/synUeiTGEKaYMrGFRkVoArU5kue9u+4D5ZOPEB1G4rM1tPNTfNM+84Sn+9vzDX+9JCwW9+ddnhXwy0UxPO9efDz92D2/GA66k7NCdQfq1+FZMRxCAUO5d2OyW+MKn9vVUpmafPVJXN7ekCFTounESW/QG/BMMJlKyDLjIDf0/Rh70PwdgRIuU7+yYFwWVSbnuiXzd5I/wzhP+TQr+v7nyYx5Tzbr9QQi3ge72fBrvtz5U4qWc6Abf8Jp0wcVHUDQXBeaAbr7KPTnRme7Y0bC5nTzsfa81FzWmObEpVJYpf+0fdgbzduvd8z6SfvFVmYlkgEWrNX0fyRp4XNF8mjld2tpwU3rrEyy8cmN5BnYK9uLOdtXRpLKPYRUnmwx9k/oqESdNpXEzzIL3b85p6MH +api: eJytVk1T4zgQ/SsqXRaq4oTwkdnNDQhTld2aGWqB2QPDQbbaiUCWvJJMSKXy37dbdhITp5YLHIIstdSvu18/acUl+MypMihr+Jg/lFIEYNJmVQEmeLZQYa4ME8xncygEy6zWkJE1C3MRWCFCNschsJl6BcNypQM43uMessqpsOTjxxV/XgT8/7R+6vEgZh7HfCKC4Pjt4N8KfLiyEk1XPLMmoGMairLUKhPka/DsCd6K1yhoFJYlIGCbPiMcXp+jHEg6u7Hq8S2aKsZF/kpnS3BBgX9/3vs8XLLKYDzOC62XNEaQTElEpnIFjuXWxaBVgKKP5zdofHDKzMixdZgZnKkqJWldBU0GDw/TCV9vgR2Io1DmtgVx2ONCSkWwhG4vBFdBbw/1N2tmdnKV+LDUwBCyW+4KsoHwtZ5Yb5NCqT7oogtuP0m5hjeVoq/agmG27AIzwIRZshdYJq9CY+JKoZzvscUcHLA45VkmDEtxYx5tyVGfr+s/KqYvrfE1iNOTk26B7jH5aFXpQEdQKepoGMGPnEG4n0Im2RD1PXHi7Ac7Y2+AvLaViZW1ksjTfHdObKxbh5qqSNuVOrS2Tdn5oSz9FFrJGDRDwqK/DLyn+oBz1vnPSlGgk5ojO3GFNpO6DUKBJUEV0KEXlTge+ptnZOCDKMo+paNxdaBrtfKRENGC4R4vZuB3DSqcE0v8pL6NByD5fuRRo94jXPe6Ib+PK7MSupEhusbrgbX1+inWatOKN4SSb+o37Ab0TdXlwliUeaVisj//uScnF4fKPcVaOmxi5sGheNVZ4OuIKcwt1oqX1sdQRJjj10CUavA6HBCbB40ckHTTbh+zUjmNdvMQSj8eDIzSMk0kFLaPQ41e+wbCwroXTtq+0fw7Yk2dpaj820TQOeQgruN3CsJFcaoHXzekoCC7ajOZThJcYVXMCfX8zd3pxegvlJ2ZRb/zIuqyqHAJhTqjlmFgZGkVXmX9X4Y2l2KprZCsqJApymS6kjD+ZRKmRBizqfcVbsKLbcs4WoO3csxu3kpVS8tukR05yGyBd6UEeUymopJjdi/cDAIzSBEmIUM0Dovn8eTWHXKE8cQtWOQxu9YKV5DqH9nHelJ//r27OW/eEIuGdsfys1z8fpGPzpOLL8MvyfnF6DRJz/IsOc3+GJ3lo5HIxYi3biI6VpncxnI1BMUiT67Y5e0UDYkSdSVO+uf9k059fiqvAnvEp4PfkgNT83S0Ic/+yjEqv2SPMyxcldLE4Hu9+L2mVM223f4PDI9ZsEwjjwwrrIM+ZaoX+V6IqGVGRM5tnjgk4HsxtJ4fn/gSargf4C0MSi1UxBX7atX04SNqr6IUDwlRDWz3YplTy6LNapUKDw9Or9c0Ha93elXhPuGUSKli+MbCDSAklRTbF+9gdH1dR5XcExIyxxuYxHBf8En06h2XWQZl+F/bp5aq3P64o4ZNm0dcEaWRO7GgiwJ/xxwHNmY5qkKcW3EtzKyKUsnrM4mD1L4tydiTiLZUo3a3EGJ6osW9fQGDKeo1oQT65lF5/wOWE8oM sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,9 +22,7 @@ import Heading from '@theme/Heading'; -Update documents within a schema collection that match the given filter - :::info You may use this test Bearer token we have created for development @@ -44,6 +40,8 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: +Update documents within a schema collection that match the given filter + diff --git a/docs/api/nildb/upload-data-to-the-specified-schema-collection.api.mdx b/docs/api/nildb/upload-data.api.mdx similarity index 61% rename from docs/api/nildb/upload-data-to-the-specified-schema-collection.api.mdx rename to docs/api/nildb/upload-data.api.mdx index 07a9619..32e2dad 100644 --- a/docs/api/nildb/upload-data-to-the-specified-schema-collection.api.mdx +++ b/docs/api/nildb/upload-data.api.mdx @@ -1,11 +1,11 @@ --- -id: upload-data-to-the-specified-schema-collection -title: 'Upload data to the specified schema collection' +id: upload-data +title: 'Upload data' description: 'Upload data to the specified schema collection' -sidebar_label: 'Upload / Create' +sidebar_label: 'Upload' hide_title: true hide_table_of_contents: true -api: eJytVm1PIzcQ/iuWv/QqkQQC5Np84w4q0RcdKtB+4FCZ2LOJYdd2bS8QRfnvnfHuktfr6aTjA/HLePzMzDOPdyEjqjqYNJfju4V8fEn0e7+8P5AJppHG8hwSSJoH/LfGmD44TaYLqZxNaBMPwfvSKEjG2cFjdJbXopphBTxKc49yLN3kEVWSjR8TULPv1upA6vYSH5zHkAzGTScaowrG8xXk62aGotn7IYq6NlrUEbVITjxDacgXiuzwoLs8pmDslOaFCxUQaMmn5LK9eIUSQoA52ZmEVdyHHrQ2jALKqw2omwDPrGhOiJeZiwR2Bh4F3Uygo0gEP0GYYiLQTRx98fCP0Q8CbLciHp5wHmkloOhS1l9F1AJatn+c1uidjQ2a4eHh/qy5OilX0W+RUXD0ovalAy04mlzDvsiW3VQosGKCwgMFC2U5F7FWCmMs6pIBfRciqIBUNU2rGIILcZcLncXesLiaURTBVWvgCGl7SGin6opAxlUCtyp9t1NCUVvzjCHmkGlM7BdGkxNTGAyCmJRTyOf7X2Ua7ZtUssHt7eW5XN4v3yL9BvKtZyyf5s5pQ9vNWGOxctNCW66d2bljuSLUyT4O/dX0F9OC4qf7ONfkVbTBfCc65EJ9iQkp7ga1lm9u/14yFXJydpjCGx378wUClHJBcwykH7xsnca+3CjQpp/fTUzsozlfUQZgil+mFiXCzj8VmWPbpdhNwxbrCcveEra37tlbErm4fh3hLjINupoe7Ybzh2lKSLEYmwVU/Pr3jWT7TcPbRiiyaLS5ih4V98ObailXlhQIH2CQaeaooNK7mGODNKPZALwZPB8N2NGgaVHajBi43XKa6lCS3SwlH8eDgTWlnvQ0Vq5Pw5IlymJ6ceFJ8kPVPWDXjKBJW37G3jLDfviCvE/zCZKocu80g1865nDU2zGfifPL8x7t0BOTOUJBX1wPT0e/CSinju6dVVkLoKYtEgeVBQet9s6Q4PQ/Wz7sYZ5zV9VEHWNVWWscf7Y9YSCNxWWMNR2ClOkZE1Se9/DVj8XFqzetEL9tincBScaphTXqH9kUaj0WN/lNyfwVGhWhCVRNfhnXdOsdxZOPUNXH4mNpaIde0a/ZZzpwE/+5+gy4eCUsJa63tTwu4KfTYnTSO31/9L53cjoa9ibHheoN1c+j42I0ggJG3XtPlc5CaGzhcrlaxlKRzz+Is6tLMmRKNJU47A/7Q6Y+k6mCrCYWckG/mZgbNX7jScLXNPAlGMvXZA4uWs7ekZgZhnPUgT9oXyTWpxnTm2wWiwlEvA3lcsnLlKjAn1U0fIZgYMLR3XHEMwRNDGSq0ytPV39sVLN3w0jYvKyzkmwrKCtGc+KMnjmf/tf2fq0Drz5dM7kn7ddblXVFBnhh5aX/Y0kDlzOSOyivLWQJdlpnnZGNT6YBU30tbVvttK5zJHxrCCk92eLGPaGlFB20oSSeyyxb/wFN3aTk +api: eJytVttSIzcQ/RWVXgJVvnD1Jn5jF1JFUtmlAmweWB7kUY8t0EiKpAFcLv97unvGeLCdpbZqecCaUatv5/TRLKSGVEQTsvFOjuVtsF5poVVWInuRZyBSgMKUBrRIxQwqJQpvLRR8oCcTFHU0eS7Hdwv58Jzx935535NZTROu5Tl6kvgc4d8aUv7oNZouZOFdBpdpqUKwplDkb/iQKIuFbCLRKs8DYF5+8oAhZePHRNDku7XqSd0GCdEHiNlAeuvkbY03VBTv/ZJEXRst6oTVYblPyhr0BVw/+m2DpxyNm+Jz6WOlMGlJp+SyDbzOUsWo5mhnMlRpV/ZKa0NZKHv1JtW3CZ450ZwQzzOfMNmZCiAwMiadGJOs4hTyKySDda5tqGX7Rw1LwbvUxDk6ONjdD1/nwlf4W7J/xr9uuEB5MjoDwZarR1EoJyYggsIylLVzkeqigJTK2lJCPwXiIgLiofEtxOhj2kZ5ZbGzLMIpiTL6qpMcZtoeEtoXdYVJpnUDtzDcwEbUzjxBTFwxrpHWwmj0QTMSBVKEO0jHB+9SCPdNtmRwe3t5Lgmvts4fIFW3X3yaJqItbLtfjcXaTZvZsnNmK8ZyTaeTXQz62swNkQLLx3jUafQq2mJ+EhkYpv/jQU7bRXXaTWPdz6YCas4WT9gpqgEZpKyqMJBvoNjkgDUp06ywhcAzSU3heyRSbv6lZI3cbPt2yRv89hp2wtVG3bG3XN4zVituXTDkK/wOtwv6yzRwYS3GsQiKP/65oSCnu+C+RCwjaphIEHEUmi4weSvIM49YyeATl6LyDJ+GKpjh0+GQZGXYzB5fHXQ6cVfqaNFulnNI4+HQGasnfQ2VH+DSkvY4yM8+Pkq6W1Z3zjWxpukS3zyvjSA/FID38XkCKgKNRbP4fUUKKnKTDmfi/PK8jzt4K1BPaJgvro9OR38KZace484qnnJV4xaOfcFKAk4Hb1BJBt8cHQ5qzupZ1cgU4wpbaxh/c31hVB6Ly5RqPKTymnG0By9hLC5egmkV9nVT7EVAfcbp1KD3yVTVeixu+BoQDikiNBSYTUTw6DLrKNIe1sNHEOSx+GQN7iDV37NnPGk+/17f3BcvmIuF7sTK41L9elqOTvqnHw4/9E9OR0f9yXFZ9I+K30bH5WikSjVaXdGINFITx8KVnuFqCYogn38UZ1eXaEiUaJA4GJwMDrbw+WqSyeIOxSq9kgNbc7+3Is/mzr5QTou7KQJXT+jF8HOz+bmhVMO29fl3DPfpQ8Eij5yofIQBdarHfK8Ua5lTzLnOl9RmDZ3Pnx//4GopnuElD4NVhsPz+CzacbtDiTXUycNV33vtLUmqOaPJRJvFYqIS3Ea7XNJrxDjSRxwun1Q0akLA3BFYM1Aah4em9BHQRH5qku/fUCZkbmvWvE1dJ21rTpzh1Rvyd23vO+Jx9eWa5nLSfitWrIAyqme6D/D/WOLCczN5+PndQlrlpjUromx8EoNpSjvKsKEEXUVGie5kiO1hixv/CA5b1GtLyfQsWWD/Axk84uw= sidebar_class_name: 'post api-method' info_path: api/nildb/nildb-api custom_edit_url: null @@ -22,7 +22,7 @@ import Heading from '@theme/Heading'; -Upload data to the specified schema collection - :::info You may use this test Bearer token we have created for development @@ -42,24 +40,7 @@ eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpc3MiOiJkaWQ6bmlsOnRlc3RuZXQ6bmlsbGlvb ::: -:::info -You may use the following example + with a unique uuidv4 `id` in the request body. - -``` -{ - "schema": "f47ac10b-58cc-4372-a567-0e02b2c3d479", - "data": [ - { - "_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", - "city": "New York", - "country_code": "US", - "age": 30 - } - ] -} -``` - -::: +Upload data to the specified schema collection diff --git a/docs/build/secretVault-secretDataAnalytics/create-query.md b/docs/build/secretVault-secretDataAnalytics/create-query.md index e9b1b60..38b6f70 100644 --- a/docs/build/secretVault-secretDataAnalytics/create-query.md +++ b/docs/build/secretVault-secretDataAnalytics/create-query.md @@ -36,7 +36,7 @@ import TabItem from '@theme/TabItem'; 3. 🧰 Additionally, we'll make our matching target a **variable** (variables can be of type `string`, `number`, `boolean`, `date`, and `array` of the former 4 - they are referenced in the aggregation using a `##` prefix), and gather a few more things we're going to need before being ready to register the query: - 1️⃣ Your organization's DID (Decentralized Identifier), obtained during the [Access](access.md) step - 2️⃣ A name (description) for your query - - 3️⃣ The schema we're targeting (by `schema_id`, you can get this via `GET /schemas` - check out the [List Schemas endpoint](../../api/nildb/list-the-organizations-schemas.api.mdx)) page for details + - 3️⃣ The schema we're targeting (by `schema_id`, you can get this via `GET /schemas` - check out the [List Schemas endpoint](../../api/nildb/get-schemas.api.mdx)) page for details - 4️⃣ A unique `uuid4` identifier for your query. As you're going to be registering this to multiple nodes that do not communicate or are aware of each other (for purposes of encryption via secret shares), this must be provided on creation and be the same across nodes.
@@ -44,34 +44,34 @@ import TabItem from '@theme/TabItem'; ```json { - "_id": "21b9911a-37c1-4626-8863-e465eXXXXXXX", - "owner": "did:nil:testnet:nillion1lng3uvz65frtv4jnrxyn2zn7xhyzujXXXXXXXX", - "name": "Returns usernames for a given service by order of creation", - "schema": "9b22147f-d6d5-40f1-927d-96c08XXXXXXXX", - "variables": { - "service": { - "type": "string", - "description": "The target service" + "_id": "21b9911a-37c1-4626-8863-e465eXXXXXXX", + "owner": "did:nil:testnet:nillion1lng3uvz65frtv4jnrxyn2zn7xhyzujXXXXXXXX", + "name": "Returns usernames for a given service by order of creation", + "schema": "9b22147f-d6d5-40f1-927d-96c08XXXXXXXX", + "variables": { + "service": { + "type": "string", + "description": "The target service" + } + }, + "pipeline": [ + { + "$match": { + "service": "##service" } - }, - "pipeline": [ - { - "$match": { - "service": "##service" - } - }, - { - "$sort": { - "_created": 1 - } - }, - { - "$project": { - "username": 1, - "_id": 0 - } + }, + { + "$sort": { + "_created": 1 } - ] + }, + { + "$project": { + "username": 1, + "_id": 0 + } + } + ] } ``` @@ -91,7 +91,7 @@ import TabItem from '@theme/TabItem'; https://github.com/NillionNetwork/blind-module-examples/blob/main/nildb/secretvault_python/nildb_api.py#L113-L136 ``` - + diff --git a/docs/build/secretVault-secretDataAnalytics/overview.md b/docs/build/secretVault-secretDataAnalytics/overview.md index 508cdd5..5181d9c 100644 --- a/docs/build/secretVault-secretDataAnalytics/overview.md +++ b/docs/build/secretVault-secretDataAnalytics/overview.md @@ -11,6 +11,6 @@ Securely store your data with **SecretVault** + run secure queries and computati Before diving down in the full details and guides on how to access and then build using SecretVault and SecretDataAnalytics, why not get a taste of them in action first? -- You can try out **SecretVault** in our demo node under a publicly shared organization. Upload some data [here](../../api/nildb/upload-data-to-the-specified-schema-collection) :arrow_upper_right:. +- You can try out **SecretVault** in our demo node under a publicly shared organization. Upload some data [here](../../api/nildb/upload-data) :arrow_upper_right:. -- Then use **SecretDataAnalytics** in the same fashion [here](../../api/nildb/add-a-new-query) :bar_chart: to retrieve some insights from the common SecretVault collection where you and other users have uploaded your test data. +- Then use **SecretDataAnalytics** in the same fashion [here](../../api/nildb/add-query) :bar_chart: to retrieve some insights from the common SecretVault collection where you and other users have uploaded your test data. diff --git a/docs/build/secretVault-secretDataAnalytics/query.md b/docs/build/secretVault-secretDataAnalytics/query.md index 201ca3b..bb7217e 100644 --- a/docs/build/secretVault-secretDataAnalytics/query.md +++ b/docs/build/secretVault-secretDataAnalytics/query.md @@ -3,7 +3,7 @@ import TabItem from '@theme/TabItem'; # SDA: Querying Data -1. 🔍 You can check out the available queries for your org via `GET /queries` - see the [List Queries endpoint](../../api/nildb/list-the-organizations-queries.api.mdx) page for details. +1. 🔍 You can check out the available queries for your org via `GET /queries` - see the [List Queries endpoint](../../api/nildb/get-queries.api.mdx) page for details. 2. 🧰 Then, using the query id and any variables required you are ready to setup the payload for executing the query:
@@ -20,7 +20,7 @@ import TabItem from '@theme/TabItem';
-3. 🏁 You can now use the `POST /queries` endpoint to retrieve the results - check out the [Execute Queries endpoint](../../api/nildb/add-a-new-query.api.mdx) page for details. You can find an example below: +3. 🏁 You can now use the `POST /queries` endpoint to retrieve the results - check out the [Execute Queries endpoint](../../api/nildb/add-query.api.mdx) page for details. You can find an example below: - 1️⃣ Node info acquisition details can be found on the [Access](access.md) page - 2️⃣ Token acquisition details can be found on the [Generating API Tokens](generate-tokens.md) page diff --git a/docs/build/secretVault-secretDataAnalytics/retrieve.md b/docs/build/secretVault-secretDataAnalytics/retrieve.md index 959b9f3..b91d3cb 100644 --- a/docs/build/secretVault-secretDataAnalytics/retrieve.md +++ b/docs/build/secretVault-secretDataAnalytics/retrieve.md @@ -7,11 +7,11 @@ To retrieve records from SecretVault, fetch data from your cluster's nodes, then ### 1. Check Your Collection for the Schema ID -List available Collections using the [List Schemas endpoint](../../api/nildb/list-the-organizations-schemas.api.mdx) (GET /schemas) to get the Schema ID of the collection you want to store your data in. +List available Collections using the [List Schemas endpoint](../../api/nildb/get-schemas.api.mdx) (GET /schemas) to get the Schema ID of the collection you want to store your data in. ### 2. Retrieve Records -Retrieve records from a collection by calling the [Read Data endpoint](../../api/nildb/retrieve-data-from-the-specified-schema-collection-that-matches-the-provided-filter) (POST /data/read) with the schema id and optionally a filter. If you don't pass in a filter, all records will be returned. +Retrieve records from a collection by calling the [Read Data endpoint](../../api/nildb/read-data) (POST /data/read) with the schema id and optionally a filter. If you don't pass in a filter, all records will be returned.
Example `POST /data/read` Payload diff --git a/docs/build/secretVault-secretDataAnalytics/upload.md b/docs/build/secretVault-secretDataAnalytics/upload.md index b197036..a179057 100644 --- a/docs/build/secretVault-secretDataAnalytics/upload.md +++ b/docs/build/secretVault-secretDataAnalytics/upload.md @@ -7,7 +7,7 @@ To store records in SecretVault, you'll first encrypt any sensitive fields with ### 1. Check Your Collection for the Schema ID -List available Collections using the [List Schemas endpoint](../../api/nildb/list-the-organizations-schemas.api.mdx) (GET /schemas) to get the Schema ID of the collection you want to store your data in. +List available Collections using the [List Schemas endpoint](../../api/nildb/get-schemas.api.mdx) (GET /schemas) to get the Schema ID of the collection you want to store your data in. ### 2. Store a Record @@ -41,7 +41,7 @@ You can include up to 10k records in a `POST /data/create` request, and the tota
-Upload to all nodes using each node's [Upload/Create Data endpoint](/api/nildb/upload-data-to-the-specified-schema-collection) using [valid API tokens](/build/secretVault-secretDataAnalytics/generate-tokens) to authenticate requests to each node. The response includes: +Upload to all nodes using each node's [Upload/Create Data endpoint](/api/nildb/upload-data) using [valid API tokens](/build/secretVault-secretDataAnalytics/generate-tokens) to authenticate requests to each node. The response includes: - Created records - Any validation errors, where any issues with data ingestion will be described even if the communication with the node resulted in a `200` status response. You can check out an example below that showcases both instances: @@ -148,4 +148,4 @@ https://github.com/NillionNetwork/secretvaults-py/blob/main/examples/org_config. -
\ No newline at end of file + diff --git a/docusaurus.config.js b/docusaurus.config.js index 2e8903e..c9cb5d9 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -252,7 +252,7 @@ const config = { docsPluginId: 'classic', config: { nildbapi: { - specPath: 'apispec/nildb-api.yaml', + specPath: 'apispec/nildb/nildb-combined.yaml', outputDir: 'docs/api/nildb', sidebarOptions: { groupPathsBy: 'tag' }, }, diff --git a/sidebar-api.js b/sidebar-api.js index 6d13224..5eb9f01 100644 --- a/sidebar-api.js +++ b/sidebar-api.js @@ -10,44 +10,44 @@ module.exports = [ type: 'category', label: 'nilDB API', items: [ - // 'api/nildb/overview', + 'api/nildb/overview', + 'api/nildb/accounts', { type: 'category', - label: 'System', + label: 'Node', items: [ 'api/nildb/get-health-status', // Health - 'api/nildb/get-node-details', // About - 'api/nildb/retrieve-an-organizations-account-details', // Accounts + 'api/nildb/get-node-details', // Details ], }, { type: 'category', label: 'Schemas', items: [ - 'api/nildb/list-the-organizations-schemas', // List Schemas - 'api/nildb/add-a-new-schema', // Add Schema - 'api/nildb/delete-a-schema', // Delete Schema + 'api/nildb/get-schemas', // List Schemas + 'api/nildb/add-schema', // Add Schema + 'api/nildb/delete-schema', // Delete Schema ], }, { 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/upload-data', // Upload + 'api/nildb/read-data', // Read + 'api/nildb/list-new-data', // Tail + 'api/nildb/update-data', // Update + 'api/nildb/delete-data', // Detail + 'api/nildb/delete-all-data', // Flush ], }, { type: 'category', label: 'Queries', items: [ - 'api/nildb/list-the-organizations-queries', // List Query - 'api/nildb/add-a-new-query', // Add Query - 'api/nildb/delete-a-query', // Delete Query + 'api/nildb/get-queries', // List Query + 'api/nildb/add-query', // Add Query + 'api/nildb/delete-query', // Delete Query ], }, ],