Placeholder.
diff --git a/frontend/src/app/components/docs/api-docs.component.scss b/frontend/src/app/components/docs/api-docs.component.scss
index 077bc3dc2..8049ef9aa 100644
--- a/frontend/src/app/components/docs/api-docs.component.scss
+++ b/frontend/src/app/components/docs/api-docs.component.scss
@@ -74,9 +74,18 @@ li.nav-item {
.doc-nav-desktop {
width: 25%;
+}
+
+.doc-nav-desktop.relative {
float: left;
}
+.doc-nav-desktop.fixed {
+ float: unset;
+ position: fixed;
+ top: 20px;
+}
+
.doc-content {
width: 75%;
float: right;
diff --git a/frontend/src/app/components/docs/api-docs.component.ts b/frontend/src/app/components/docs/api-docs.component.ts
index a38ded836..724ecdc3f 100644
--- a/frontend/src/app/components/docs/api-docs.component.ts
+++ b/frontend/src/app/components/docs/api-docs.component.ts
@@ -17,6 +17,7 @@ export class ApiDocsComponent implements OnInit {
code: any;
baseNetworkUrl = '';
@Input() restTabActivated: Boolean;
+ docsNavPosition = "relative";
constructor(
private stateService: StateService,
@@ -35,6 +36,16 @@ export class ApiDocsComponent implements OnInit {
})
);
+ //to toggle fixed menu for desktop navigation
+ let that = this;
+ window.addEventListener('scroll', function() {
+ if( window.pageYOffset > 182 ) {
+ that.docsNavPosition = "fixed";
+ } else {
+ that.docsNavPosition = "relative";
+ }
+ });
+
if (document.location.port !== '') {
this.hostname = `${this.hostname}:${document.location.port}`;
}
From 1a8fd23b05b44de8dc68c1273c5dec2c7c44b862 Mon Sep 17 00:00:00 2001
From: hunicus <93150691+hunicus@users.noreply.github.com>
Date: Wed, 15 Dec 2021 22:55:29 -0500
Subject: [PATCH 03/15] Add links and styling to fixed desktop docs nav
---
.../components/docs/api-docs.component.html | 66 ++++++++++++++++++-
.../components/docs/api-docs.component.scss | 38 ++++++++++-
2 files changed, 101 insertions(+), 3 deletions(-)
diff --git a/frontend/src/app/components/docs/api-docs.component.html b/frontend/src/app/components/docs/api-docs.component.html
index 6fe7110ae..40aed1cd9 100644
--- a/frontend/src/app/components/docs/api-docs.component.html
+++ b/frontend/src/app/components/docs/api-docs.component.html
@@ -4,7 +4,71 @@
diff --git a/frontend/src/app/components/docs/api-docs.component.scss b/frontend/src/app/components/docs/api-docs.component.scss
index 8049ef9aa..089e8d2cf 100644
--- a/frontend/src/app/components/docs/api-docs.component.scss
+++ b/frontend/src/app/components/docs/api-docs.component.scss
@@ -73,27 +73,61 @@ li.nav-item {
}
.doc-nav-desktop {
- width: 25%;
+ width: 300px;
}
.doc-nav-desktop.relative {
float: left;
+ overflow: hidden;
}
.doc-nav-desktop.fixed {
float: unset;
position: fixed;
top: 20px;
+ overflow-y: auto;
+ height: calc(100vh - 50px);
+ scrollbar-color: #2d3348 #11131f;
+ scrollbar-width: thin;
+}
+::-webkit-scrollbar {
+ width: 3px;
+}
+::-webkit-scrollbar-track {
+ background: #11131f;
+}
+::-webkit-scrollbar-thumb {
+ background-color: #2d3348;
+ border-radius: 5px;
+ border: none;
+}
+
+.doc-nav-desktop p {
+ color: #4a68b9;
+ font-weight: 700;
+ margin: 10px 0;
+ margin: 15px 0 10px 0;
+}
+.doc-nav-desktop p:first-child {
+ margin-top: 0
+}
+
+.doc-nav-desktop a {
+ color: #fff;
+ text-decoration: none;
+ display: block;
+ margin: 5px 0;
}
.doc-content {
- width: 75%;
+ width: calc(100% - 330px);
float: right;
}
@media (max-width: 992px){
.doc-nav-desktop {
display: none;
+ height: auto;
}
.doc-content {
From 010381aac460b8947cb048b163f27874c39e7733 Mon Sep 17 00:00:00 2001
From: hunicus <93150691+hunicus@users.noreply.github.com>
Date: Thu, 16 Dec 2021 08:46:51 -0500
Subject: [PATCH 04/15] Convert accordions to plain html
---
.../components/docs/api-docs.component.html | 1322 +++++++----------
1 file changed, 564 insertions(+), 758 deletions(-)
diff --git a/frontend/src/app/components/docs/api-docs.component.html b/frontend/src/app/components/docs/api-docs.component.html
index 40aed1cd9..5f7d725e8 100644
--- a/frontend/src/app/components/docs/api-docs.component.html
+++ b/frontend/src/app/components/docs/api-docs.component.html
@@ -76,849 +76,655 @@
Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API service.
-
General
-
+
+ General
-
-
- GET Difficulty Adjustment
-
-
-
-
-
-
Description
-
Returns details about difficulty adjustment.
-
-
-
+
+
+
+
+
Description
+
Returns details about difficulty adjustment.
+
+
+
+
+
Markets
-
-
-
- GET Market Currencies
-
-
-
-
-
Description
-
Provides list of available currencies for a given base currency.
-
+
+
+
+
Description
+
Provides list of available currencies for a given base currency.
+
+
+
-
Description
-
Provides list of open offer prices for a single market.
-
+
+
+
+
Description
+
Provides list of open offer prices for a single market.
+
+
+
-
Description
-
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
-
+
+
+
+
Description
+
Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
+
+
+
-
Description
-
Provides list of available markets.
-
+
+
+
+
Description
+
Provides list of available markets.
+
+
+
-
Description
-
Provides list of open offer details for a single market.
-
+
+
+
+
Description
+
Provides list of open offer details for a single market.
+
+
+
-
Description
-
Provides 24 hour price ticker for single market or all markets
-
+
+
+
+
Description
+
Provides 24 hour price ticker for single market or all markets
+
+
+
-
Description
-
Provides list of completed trades for a single market.
-
+
+
+
+
Description
+
Provides list of completed trades for a single market.
+
+
+
-
Description
-
Provides periodic volume data in terms of base currency for one or all markets.
-
+
+
+
+
Description
+
Provides periodic volume data in terms of base currency for one or all markets.
+
+
+
-
General
-
+
+ General
-
-
- GET Stats
-
-
-
-
-
Description
-
Returns statistics about all Bisq transactions.
-
+
+
+
+
Description
+
Returns statistics about all Bisq transactions.
+
+
+
+
Addresses
-
-
-
- GET Address
-
-
-
-
-
Description
-
Returns details about an address. Available fields: address, chain_stats, and mempool_stats. {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with tx_count, funded_txo_count, funded_txo_sum, spent_txo_count, and spent_txo_sum.
-
+
+
+
+
Description
+
Returns details about an address. Available fields: address, chain_stats, and mempool_stats. {{ '{' }}chain,mempool{{ '}' }}_stats each contain an object with tx_count, funded_txo_count, funded_txo_sum, spent_txo_count, and spent_txo_sum.
+
+
+
-
Description
-
Get transaction history for the specified address/scripthash, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. You can request more confirmed transactions using :last_seen_txid (see below).
-
+
+
+
+
Description
+
Get transaction history for the specified address/scripthash, sorted with newest first. Returns up to 50 mempool transactions plus the first 25 confirmed transactions. You can request more confirmed transactions using :last_seen_txid (see below).
+
+
+
-
Description
-
Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
-
+
+
+
+
Description
+
Get confirmed transaction history for the specified address/scripthash, sorted with newest first. Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
+
+
+
-
Description
-
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
-
+
+
+
+
Description
+
Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
+
+
+
-
Description
-
Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: txid, vout, value, and status (with the status of the funding tx).There is also a valuecommitment field that may appear in place of value, plus the following additional fields: asset/assetcommitment, nonce/noncecommitment, surjection_proof, and range_proof.
-
+
+
+
+
Description
+
Get the list of unspent transaction outputs associated with the address/scripthash. Available fields: txid, vout, value, and status (with the status of the funding tx).There is also a valuecommitment field that may appear in place of value, plus the following additional fields: asset/assetcommitment, nonce/noncecommitment, surjection_proof, and range_proof.
+
+
+
+
Assets
-
-
-
- GET Assets
-
-
-
-
-
Description
-
Returns information about a Liquid asset.
-
+
+
+
+
Description
+
Returns information about a Liquid asset.
+
+
+
-
Description
-
Returns transactions associated with the specified Liquid asset. For the network's native asset, returns a list of peg in, peg out, and burn transactions. For user-issued assets, returns a list of issuance, reissuance, and burn transactions. Does not include regular transactions transferring this asset.
-
+
+
+
+
Description
+
Returns transactions associated with the specified Liquid asset. For the network's native asset, returns a list of peg in, peg out, and burn transactions. For user-issued assets, returns a list of issuance, reissuance, and burn transactions. Does not include regular transactions transferring this asset.
+
+
+
-
Description
-
Get the current total supply of the specified asset. For the native asset (L-BTC), this is calculated as [chain,mempool]_stats.peg_in_amount - [chain,mempool]_stats.peg_out_amount - [chain,mempool]_stats.burned_amount. For issued assets, this is calculated as [chain,mempool]_stats.issued_amount - [chain,mempool]_stats.burned_amount. Not available for assets with blinded issuances. If /decimal is specified, returns the supply as a decimal according to the asset's divisibility. Otherwise, returned in base units.
-
+
+
+
+
Description
+
Get the current total supply of the specified asset. For the native asset (L-BTC), this is calculated as [chain,mempool]_stats.peg_in_amount - [chain,mempool]_stats.peg_out_amount - [chain,mempool]_stats.burned_amount. For issued assets, this is calculated as [chain,mempool]_stats.issued_amount - [chain,mempool]_stats.burned_amount. Not available for assets with blinded issuances. If /decimal is specified, returns the supply as a decimal according to the asset's divisibility. Otherwise, returned in base units.
+
+
+
+
Blocks
-
-
-
- GET Block
-
-
-
-
-
Description
-
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
-
+
+
+
+
Description
+
Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
+
+
+
-
Description
-
Returns the hash of the block currently at :height.
-
+
+
+
+
Description
+
Returns the hash of the block currently at :height.
+
+
+
-
Description
-
Returns the raw block representation in binary.
-
+
+
+
+
Description
+
Returns the raw block representation in binary.
+
+
+
Get Block Status
-
-
-
Description
-
Returns the confirmation status of a block. Available fields: in_best_chain (boolean, false for orphaned blocks), next_best (the hash of the next block, only available for blocks in the best chain).
-
+
+
Get Block Status
+
+
+
Description
+
Returns the confirmation status of a block. Available fields: in_best_chain (boolean, false for orphaned blocks), next_best (the hash of the next block, only available for blocks in the best chain).
+
+
+
-
Description
-
Returns the height of the last block.
-
+
+
+
+
Description
+
Returns the height of the last block.
+
+
+
-
Description
-
Returns the hash of the last block.
-
+
+
+
+
Description
+
Returns the hash of the last block.
+
+
+
-
Description
-
Returns the transaction at index :index within the specified block.
-
+
+
+
+
Description
+
Returns the transaction at index :index within the specified block.
+
+
+
-
Description
-
Returns a list of all txids in the block.
-
+
+
+
+
Description
+
Returns a list of all txids in the block.
+
+
+
-
Description
-
Returns a list of transactions in the block (up to 25 transactions beginning at start_index). Transactions returned here do not have the status field, since all the transactions share the same block and confirmation status.
-
+
+
+
+
Description
+
Returns a list of transactions in the block (up to 25 transactions beginning at start_index). Transactions returned here do not have the status field, since all the transactions share the same block and confirmation status.
+
+
+
-
Description
-
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
-
+
+
+
+
Description
+
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
+
+
+
-
Description
-
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
-
+
+
+
+
Description
+
Returns the 10 newest blocks starting at the tip or at :start_height if specified.
+
+
+
+
Fees
-
-
-
- GET Mempool Blocks Fees
-
-
-
-
-
Description
-
Returns current mempool as projected blocks.
-
+
+
+
+
Description
+
Returns current mempool as projected blocks.
+
+
+
-
Description
-
Returns our currently suggested fees for new transactions.
-
+
+
+
+
Description
+
Returns our currently suggested fees for new transactions.
+
+
+
+
Mempool
-
-
-
- GET Mempool
-
-
-
-
-
Description
-
Returns current mempool backlog statistics.
-
+
+
+
+
Description
+
Returns current mempool backlog statistics.
+
+
+
-
Description
-
Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.
-
+
+
+
+
Description
+
Get the full list of txids in the mempool as an array. The order of the txids is arbitrary and does not match bitcoind.
+
+
+
-
Description
-
Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: txid, fee, vsize, and value.
-
+
+
+
+
Description
+
Get a list of the last 10 transactions to enter the mempool. Each transaction object contains simplified overview data, with the following fields: txid, fee, vsize, and value.
+
+
+
+
Transactions
-
-
-
- GET Children Pay for Parent
-
-
-
-
-
Description
-
Returns the ancestors and the best descendant fees for a transaction.
-
+
+
+
+
Description
+
Returns the ancestors and the best descendant fees for a transaction.
+
+
+
-
Description
-
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
-
+
+
+
+
Description
+
Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
+
+
+
-
Description
-
Returns a transaction serialized as hex.
-
+
+
+
+
Description
+
Returns a transaction serialized as hex.
+
+
+
-
Description
-
Returns the spending status of a transaction output. Available fields: spent (boolean), txid (optional), vin (optional), and status (optional, the status of the spending tx).
-
+
+
+
+
Description
+
Returns the spending status of a transaction output. Available fields: spent (boolean), txid (optional), vin (optional), and status (optional, the status of the spending tx).
+
+
+
-
Description
-
Returns the spending status of all transaction outputs.
-
+
+
+
+
Description
+
Returns the spending status of all transaction outputs.
+
+
+
-
Description
-
Returns a transaction as binary data.
-
+
+
+
+
Description
+
Returns a transaction as binary data.
+
+
+
-
Description
-
Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
-
+
+
+
+
Description
+
Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
+
+
+
Get Mempool Txids
-
-
-
Description
-
Returns :length of latest Bisq transactions, starting from :index.
-
+
+
Get Mempool Txids
+
+
+
Description
+
Returns :length of latest Bisq transactions, starting from :index.
+
+
+
-
Endpoint
-
POST /api/tx
-
-
Description
-
Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid will be returned on success.
-
+
+
+
+
Endpoint
+
POST /api/tx
+
+
+
Description
+
Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid will be returned on success.
+
+
+
From f8a54784d0e278d57965b4fef769a607e5c76ba8 Mon Sep 17 00:00:00 2001
From: hunicus <93150691+hunicus@users.noreply.github.com>
Date: Thu, 16 Dec 2021 09:28:57 -0500
Subject: [PATCH 05/15] Improve styling + switch section headings for tags
---
.../components/docs/api-docs.component.html | 112 ++++++++----------
.../components/docs/api-docs.component.scss | 50 ++++++--
2 files changed, 90 insertions(+), 72 deletions(-)
diff --git a/frontend/src/app/components/docs/api-docs.component.html b/frontend/src/app/components/docs/api-docs.component.html
index 5f7d725e8..9fc8feef2 100644
--- a/frontend/src/app/components/docs/api-docs.component.html
+++ b/frontend/src/app/components/docs/api-docs.component.html
@@ -76,11 +76,9 @@
Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API service.
-
-
General
-
+
Endpoint
@@ -97,11 +95,9 @@