Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
islamaliev committed Oct 12, 2024
1 parent f39c9c5 commit 25bb6ab
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/website/references/cli/defradb.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Start a DefraDB node, interact with a local or remote node, and much more.
* [defradb client](defradb_client.md) - Interact with a DefraDB node
* [defradb identity](defradb_identity.md) - Interact with identity features of DefraDB instance
* [defradb keyring](defradb_keyring.md) - Manage DefraDB private keys
* [defradb node](defradb_node.md) - Interact with DefraDB node
* [defradb server-dump](defradb_server-dump.md) - Dumps the state of the entire database
* [defradb start](defradb_start.md) - Start a DefraDB node
* [defradb version](defradb_version.md) - Display the version information of DefraDB and its components
Expand Down
39 changes: 39 additions & 0 deletions docs/website/references/cli/defradb_node.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## defradb node

Interact with DefraDB node

### Synopsis

Interact with DefraDB node

### Options

```
-h, --help help for node
```

### Options inherited from parent commands

```
--keyring-backend string Keyring backend to use. Options are file or system (default "file")
--keyring-namespace string Service name to use when using the system backend (default "defradb")
--keyring-path string Path to store encrypted keys when using the file backend (default "keys")
--log-format string Log format to use. Options are text or json (default "text")
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
--log-source Include source location in logs
--log-stacktrace Include stacktrace in error and fatal logs
--no-keyring Disable the keyring and generate ephemeral keys
--no-log-color Disable colored log output
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--secret-file string Path to the file containing secrets (default ".env")
--source-hub-address string The SourceHub address authorized by the client to make SourceHub transactions on behalf of the actor
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
```

### SEE ALSO

* [defradb](defradb.md) - DefraDB Edge Database
* [defradb node identity](defradb_node_identity.md) - Get information about the node's identity

49 changes: 49 additions & 0 deletions docs/website/references/cli/defradb_node_identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## defradb node identity

Get information about the node's identity

### Synopsis

Get information about the node's identity

The identity contains:
- A secp256k1 private key that is a 256-bit big-endian binary-encoded number,
padded to a length of 32 bytes in HEX format.
- A compressed 33-byte secp256k1 public key in HEX format.
- A "did:key" generated from the public key.


```
defradb node identity [flags]
```

### Options

```
-h, --help help for identity
```

### Options inherited from parent commands

```
--keyring-backend string Keyring backend to use. Options are file or system (default "file")
--keyring-namespace string Service name to use when using the system backend (default "defradb")
--keyring-path string Path to store encrypted keys when using the file backend (default "keys")
--log-format string Log format to use. Options are text or json (default "text")
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
--log-source Include source location in logs
--log-stacktrace Include stacktrace in error and fatal logs
--no-keyring Disable the keyring and generate ephemeral keys
--no-log-color Disable colored log output
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--secret-file string Path to the file containing secrets (default ".env")
--source-hub-address string The SourceHub address authorized by the client to make SourceHub transactions on behalf of the actor
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
```

### SEE ALSO

* [defradb node](defradb_node.md) - Interact with DefraDB node

42 changes: 42 additions & 0 deletions docs/website/references/http/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,20 @@
},
"type": "object"
},
"identity": {
"properties": {
"DID": {
"type": "string"
},
"PrivateKey": {
"type": "string"
},
"PublicKey": {
"type": "string"
}
},
"type": "object"
},
"index": {
"properties": {
"Fields": {
Expand Down Expand Up @@ -1677,6 +1691,34 @@
]
}
},
"/node/identity": {
"get": {
"description": "Get node's identity",
"operationId": "node_identity",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/identity"
}
}
},
"description": "Identity"
},
"400": {
"$ref": "#/components/responses/error"
},
"default": {
"description": ""
}
},
"tags": [
"node",
"identity"
]
}
},
"/p2p/collections": {
"delete": {
"description": "Remove peer collections",
Expand Down

0 comments on commit 25bb6ab

Please sign in to comment.