update api docs

lightningrodlabs · Jan 8, 2025 · 0a7d467 · 0a7d467
1 parent 757837e
commit 0a7d467
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 17 deletions.
diff --git a/cli/README.md b/cli/README.md
@@ -2,7 +2,7 @@
 
 CLI to run Moss Tools in development mode.
 
-This version is compatible with `@theweave/[email protected].0`.
+This version is compatible with `@theweave/[email protected].3`.
 
 ```
 Usage: @theweave/cli [options]

diff --git a/cli/package.json b/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@theweave/cli",
-  "version": "0.13.0-rc.0",
+  "version": "0.13.0-rc.1",
   "description": "CLI to run Tools for the Weave in development mode",
   "license": "CAL-1.0",
   "repository": {

diff --git a/docs/api-reference/api/api.applettoparentrequest.md b/docs/api-reference/api/api.applettoparentrequest.md
@@ -15,11 +15,6 @@ export type AppletToParentRequest = {
 } | {
     type: 'get-record-info';
     hrl: Hrl;
-} | {
-    type: 'link-mouseover';
-    href: string;
-} | {
-    type: 'link-mouseout';
 } | {
     type: 'sign-zome-call';
     request: CallZomeRequest;

diff --git a/docs/api-reference/api/api.assetstorecontent.md b/docs/api-reference/api/api.assetstorecontent.md
@@ -8,10 +8,10 @@
 
 ```typescript
 export type AssetStoreContent = {
-    linkedTo: WalAndTags[];
-    linkedFrom: WalAndTags[];
+    linkedTo: WalRelationAndTags[];
+    linkedFrom: WalRelationAndTags[];
     tags: string[];
 };
 ```
-**References:** [WalAndTags](./api.walandtags.md)
+**References:** [WalRelationAndTags](./api.walrelationandtags.md)
 
diff --git a/docs/api-reference/api/api.md b/docs/api-reference/api/api.md
@@ -213,7 +213,7 @@ Description
 
 </td><td>
 
-The null hash is used in case a WAL is to address a DNA only, not specific DHT content
+The null hash is used in case a WAL is to address a DNA only, not specific DHT content. It starts with the prefix of an EntryHash, followed by zeroes
 
 
 </td></tr>
@@ -591,7 +591,7 @@ Events
 </td></tr>
 <tr><td>
 
-[WalAndTags](./api.walandtags.md)
+[WalRelationAndTags](./api.walrelationandtags.md)
 
 
 </td><td>

diff --git a/docs/api-reference/api/api.null_hash.md b/docs/api-reference/api/api.null_hash.md
@@ -4,7 +4,7 @@
 
 ## NULL\_HASH variable
 
-The null hash is used in case a WAL is to address a DNA only, not specific DHT content
+The null hash is used in case a WAL is to address a DNA only, not specific DHT content. It starts with the prefix of an EntryHash, followed by zeroes
 
 **Signature:**
 

diff --git a/docs/api-reference/api/api.walandtags.md → ...i-reference/api/api.walrelationandtags.md b/docs/api-reference/api/api.walandtags.md → ...i-reference/api/api.walrelationandtags.md
@@ -1,15 +1,16 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@theweave/api](./api.md) &gt; [WalAndTags](./api.walandtags.md)
+[Home](./index.md) &gt; [@theweave/api](./api.md) &gt; [WalRelationAndTags](./api.walrelationandtags.md)
 
-## WalAndTags type
+## WalRelationAndTags type
 
 **Signature:**
 
 ```typescript
-export type WalAndTags = {
-    wal: WAL;
+export type WalRelationAndTags = {
     relationHash: EntryHash;
+    createdAt: number;
+    wal: WAL;
     tags: string[];
 };
 ```