Skip to content

Commit 4456872

Browse files
committed
PR(AUTO): Generate docs and mocks
1 parent b2b750f commit 4456872

13 files changed

Lines changed: 830 additions & 4 deletions

client/mocks/txn_store.go

Lines changed: 256 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/website/references/cli/defradb_client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Execute queries, add schema types, obtain node info, etc.
3838
### SEE ALSO
3939

4040
* [defradb](defradb.md) - DefraDB Edge Database
41-
* [defradb client acp](defradb_client_acp.md) - Interact with the access control system of a DefraDB node
41+
* [defradb client acp](defradb_client_acp.md) - Interact with the access control system(s) of a DefraDB node
4242
* [defradb client backup](defradb_client_backup.md) - Interact with the backup utility
4343
* [defradb client block](defradb_client_block.md) - Manage blocks of a running DefraDB instance
4444
* [defradb client collection](defradb_client_collection.md) - Interact with a collection.

docs/website/references/cli/defradb_client_acp.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## defradb client acp
22

3-
Interact with the access control system of a DefraDB node
3+
Interact with the access control system(s) of a DefraDB node
44

55
### Synopsis
66

7-
Interact with the access control system of a DefraDB node
7+
Interact with the access control system(s) of a DefraDB node
88

99
Learn more about the DefraDB [ACP System](/acp/README.md)
1010

@@ -41,5 +41,6 @@ Learn more about the DefraDB [ACP System](/acp/README.md)
4141
### SEE ALSO
4242

4343
* [defradb client](defradb_client.md) - Interact with a DefraDB node
44+
* [defradb client acp aac](defradb_client_acp_aac.md) - Interact with the admin access control system of a DefraDB node
4445
* [defradb client acp dac](defradb_client_acp_dac.md) - Interact with the document access control system of a DefraDB node
4546

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## defradb client acp aac
2+
3+
Interact with the admin access control system of a DefraDB node
4+
5+
### Synopsis
6+
7+
Interact with the admin access control system of a DefraDB node
8+
Note:
9+
- Clean state means, if the access control was never configured, or the entire state was purged.
10+
- The check the admin acp status use the 'client acp aac status' command
11+
- To start admin acp for the first time, use the start command with '--acp-enable true'.
12+
- Specifying an identity is a MUST, when starting first time (from a clean state).
13+
- To temporarily disable admin acp, use the 'client acp aac disable' command.
14+
- To re-enable admin acp when it is temporarily disabled, use the 'client acp aac re-enable' command.
15+
- To give admin access to other users use the 'client acp aac relationship add' command.
16+
- To revoke admin access from other users use the 'client acp aac relationship delete' command.
17+
- To reset/purge acp state into a clean state, use the 'client acp aac purge' command.
18+
- Purge command(s) require the user to be in dev-mode (Warning: all state will be lost).
19+
20+
For quick help: 'defradb client acp aac --help'
21+
22+
Learn more about the DefraDB [ACP System](/acp/README.md)
23+
24+
25+
26+
### Options
27+
28+
```
29+
-h, --help help for aac
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
-i, --identity string Hex formatted private key used to authenticate with ACP
36+
--keyring-backend string Keyring backend to use. Options are file or system (default "file")
37+
--keyring-namespace string Service name to use when using the system backend (default "defradb")
38+
--keyring-path string Path to store encrypted keys when using the file backend (default "keys")
39+
--log-format string Log format to use. Options are text or json (default "text")
40+
--log-level string Log level to use. Options are debug, info, error, fatal (default "info")
41+
--log-output string Log output path. Options are stderr or stdout. (default "stderr")
42+
--log-overrides string Logger config overrides. Format <name>,<key>=<val>,...;<name>,...
43+
--log-source Include source location in logs
44+
--log-stacktrace Include stacktrace in error and fatal logs
45+
--no-keyring Disable the keyring and generate ephemeral keys
46+
--no-log-color Disable colored log output
47+
--rootdir string Directory for persistent data (default: $HOME/.defradb)
48+
--secret-file string Path to the file containing secrets (default ".env")
49+
--source-hub-address string The SourceHub address authorized by the client to make SourceHub transactions on behalf of the actor
50+
--tx uint Transaction ID
51+
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
52+
```
53+
54+
### SEE ALSO
55+
56+
* [defradb client acp](defradb_client_acp.md) - Interact with the access control system(s) of a DefraDB node
57+
* [defradb client acp aac disable](defradb_client_acp_aac_disable.md) - Disable the admin access control
58+
* [defradb client acp aac re-enable](defradb_client_acp_aac_re-enable.md) - Re-enable the admin access control
59+
* [defradb client acp aac relationship](defradb_client_acp_aac_relationship.md) - Interact with the admin acp relationship features of DefraDB instance
60+
* [defradb client acp aac status](defradb_client_acp_aac_status.md) - Check the admin access control status
61+

0 commit comments

Comments
 (0)