Merge pull request #3518 from TrueBlocks/fix/documentation-fixes

Fixes an issue and removes some old files
TrueBlocks · Feb 21, 2024 · 6b4945f · 6b4945f
2 parents f474bc9 + cf3fd27
commit 6b4945f
Show file tree

Hide file tree

Showing 11 changed files with 5 additions and 369 deletions.
diff --git a/docs/BRANCHING.md b/docs/BRANCHING.md
diff --git a/docs/FAQ.md b/docs/FAQ.md
diff --git a/docs/README.adoc b/docs/README.adoc
diff --git a/docs/content/api/openapi.yaml b/docs/content/api/openapi.yaml
@@ -1262,12 +1262,10 @@ paths:
               schema:
                 properties:
                   data:
-                    description: Produces <a href="/data-model/accounts/#statement">Statement</a>, and/or <a href="/data-model/chaindata/#transaction">Transaction</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-transactions">chifra transactions</a> command line.
+                    description: Transaction data as returned from the RPC (with slight enhancements). Produces <a href="/data-model/chaindata/#transaction">Transaction</a> data. Corresponds to the <a href="/chifra/chaindata/#chifra-transactions">chifra transactions</a> command line.
                     type: array
                     items:
-                      oneOf:
-                        - $ref: "#/components/schemas/statement"
-                        - $ref: "#/components/schemas/transaction"
+                      $ref: "#/components/schemas/transaction"
         "400":
           description: bad input parameter
   /receipts:

diff --git a/docs/content/chifra/chaindata.md b/docs/content/chifra/chaindata.md
@@ -147,7 +147,6 @@ Notes:
 
 Data models produced by this tool:
 
-- [statement](/data-model/accounts/#statement)
 - [transaction](/data-model/chaindata/#transaction)
 
 Links:

diff --git a/docs/content/data-model/accounts.md b/docs/content/data-model/accounts.md
@@ -192,7 +192,6 @@ is always present as the `assetAddress` in the first reconciliation of the state
 The following commands produce and manage Statements:
 
 - [chifra export](/chifra/accounts/#chifra-export)
-- [chifra transactions](/chifra/chaindata/#chifra-transactions)
 
 Statements consist of the following fields:
 
@@ -256,4 +255,3 @@ This documentation mentions the following basic data types.
 | string    | a normal character string           |                |
 | timestamp | a 64-bit unsigned integer           | Unix timestamp |
 | uint64    | a 64-bit unsigned integer           |                |
-
diff --git a/docs/future-work/thoughts.md b/docs/future-work/thoughts.md
diff --git a/docs/readmes/chaindata-transactions.md b/docs/readmes/chaindata-transactions.md
@@ -48,7 +48,6 @@ Notes:
 
 Data models produced by this tool:
 
-- [statement](/data-model/accounts/#statement)
 - [transaction](/data-model/chaindata/#transaction)
 
 Links:

diff --git a/sdk/typescript/src/paths/transactions.ts b/sdk/typescript/src/paths/transactions.ts
@@ -4,7 +4,7 @@
  * This file was generated with makeClass --sdk. Do not edit it.
  */
 import * as ApiCallers from '../lib/api_callers';
-import { address, Statement, topic, Transaction, txId } from '../types';
+import { address, topic, Transaction, txId } from '../types';
 
 export function getTransactions(
   parameters?: {
@@ -26,7 +26,7 @@ export function getTransactions(
   },
   options?: RequestInit,
 ) {
-  return ApiCallers.fetch<Statement[] | Transaction[]>(
+  return ApiCallers.fetch<Transaction[]>(
     { endpoint: '/transactions', method: 'get', parameters, options },
   );
 }

diff --git a/src/apps/chifra/internal/transactions/README.md b/src/apps/chifra/internal/transactions/README.md
@@ -48,7 +48,6 @@ Notes:
 
 Data models produced by this tool:
 
-- [statement](/data-model/accounts/#statement)
 - [transaction](/data-model/chaindata/#transaction)
 
 ### Other Options

diff --git a/src/other/data-models/classDefinitions/statement.txt b/src/other/data-models/classDefinitions/statement.txt
@@ -5,7 +5,7 @@ contained_by = Transaction
 doc_group = 01-Accounts
 doc_descr = a statement, including all inflows and outflows, for a single transfer of an asset (including ETH) to or from a given address
 doc_route = 108-statement
-doc_producer = export, transactions
+doc_producer = export
 go_output = src/apps/chifra/pkg/types
 cache_type = cacheable
 cache_by = address,tx
-Original file line number
+Diff line change
@@ Expand Up / @@ -147,7 +147,6 @@ Notes: @@
     Data models produced by this tool:
-    - [statement](/data-model/accounts/#statement)
     - [transaction](/data-model/chaindata/#transaction)
     Links:
@@ Expand Down @@