machankura/mempool
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve styling + switch section headings for tags

Browse Source
This commit is contained in:
hunicus 2021-12-16 09:28:57 -05:00
parent 010381aac4
commit f8a54784d0
No known key found for this signature in database
GPG Key ID: 24837C51B6D81FD9
2 changed files with 90 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
frontend/src/app/components/docs/api-docs.component.html
View File

@ -77,10 +77,8 @@
<div class="api-category" *ngIf="network.val !== 'bisq' && network.val !== 'liquid'"> <div class="api-category" *ngIf="network.val !== 'bisq' && network.val !== 'liquid'">
<h4 i18n="api-docs.tab.general|API Docs tab for General">General</h4>
<div class="endpoint-container" id="difficultyAdjustment"> <div class="endpoint-container" id="difficultyAdjustment">
<a class="section-header" [routerLink]="['./']" fragment="difficultyAdjustment">GET Difficulty Adjustment</a> <a class="section-header" [routerLink]="['./']" fragment="difficultyAdjustment">GET Difficulty Adjustment <span>General</span></a>
<div class="difficulty"> <div class="difficulty">
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
@ -98,10 +96,8 @@
<div class="api-category" *ngIf="network.val === 'bisq'"> <div class="api-category" *ngIf="network.val === 'bisq'">
<h4 i18n="Bisq All Markets">Markets</h4>
<div class="endpoint-container" id="bisqMarketsCurrencies"> <div class="endpoint-container" id="bisqMarketsCurrencies">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsCurrencies">GET Market Currencies</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsCurrencies">GET Market Currencies <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketsCurrencies)" target="_blank">GET {{ baseNetworkUrl }}/api/currencies</a> <a [href]="wrapUrl(network.val, code.marketsCurrencies)" target="_blank">GET {{ baseNetworkUrl }}/api/currencies</a>
@ -114,7 +110,7 @@
</div> </div>
<div class="endpoint-container" id="marketDepth"> <div class="endpoint-container" id="marketDepth">
<a class="section-header" [routerLink]="['./']" fragment="marketDepth">GET Market Depth</a> <a class="section-header" [routerLink]="['./']" fragment="marketDepth">GET Market Depth <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketDepth)" target="_blank">GET {{ baseNetworkUrl }}/api/depth?market=[:market]</a> <a [href]="wrapUrl(network.val, code.marketDepth)" target="_blank">GET {{ baseNetworkUrl }}/api/depth?market=[:market]</a>
@ -127,7 +123,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsHloc"> <div class="endpoint-container" id="bisqMarketsHloc">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsHloc">GET Market HLOC</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsHloc">GET Market HLOC <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketHloc)" target="_blank">GET {{ baseNetworkUrl }}/api/hloc?market=[:market]</a> <a [href]="wrapUrl(network.val, code.marketHloc)" target="_blank">GET {{ baseNetworkUrl }}/api/hloc?market=[:market]</a>
@ -140,7 +136,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsMarkets"> <div class="endpoint-container" id="bisqMarketsMarkets">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsMarkets">GET Markets</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsMarkets">GET Markets <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.markets)" target="_blank">GET {{ baseNetworkUrl }}/api/markets</a> <a [href]="wrapUrl(network.val, code.markets)" target="_blank">GET {{ baseNetworkUrl }}/api/markets</a>
@ -153,7 +149,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsOffers"> <div class="endpoint-container" id="bisqMarketsOffers">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsOffers">GET Market Offers</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsOffers">GET Market Offers <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketOffers)" target="_blank">GET {{ baseNetworkUrl }}/api/offers?market=[:market]</a> <a [href]="wrapUrl(network.val, code.marketOffers)" target="_blank">GET {{ baseNetworkUrl }}/api/offers?market=[:market]</a>
@ -166,7 +162,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsTicker"> <div class="endpoint-container" id="bisqMarketsTicker">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTicker">GET Market Ticker</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTicker">GET Market Ticker <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketTicker)" target="_blank">GET {{ baseNetworkUrl }}/api/ticker?market=[:market]</a> <a [href]="wrapUrl(network.val, code.marketTicker)" target="_blank">GET {{ baseNetworkUrl }}/api/ticker?market=[:market]</a>
@ -179,7 +175,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsTrades"> <div class="endpoint-container" id="bisqMarketsTrades">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTrades">GET Market Trades</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTrades">GET Market Trades <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketTrades)" target="_blank">GET {{ baseNetworkUrl }}/api/trades?market=[:market]&limit=[:limit]</a> <a [href]="wrapUrl(network.val, code.marketTrades)" target="_blank">GET {{ baseNetworkUrl }}/api/trades?market=[:market]&limit=[:limit]</a>
@ -192,7 +188,7 @@
</div> </div>
<div class="endpoint-container" id="bisqMarketsVolumes"> <div class="endpoint-container" id="bisqMarketsVolumes">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsVolumes">GET Market Volumes</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsVolumes">GET Market Volumes <span>Markets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.marketVolumes)" target="_blank">GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency]</a> <a [href]="wrapUrl(network.val, code.marketVolumes)" target="_blank">GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency]</a>
@ -208,10 +204,8 @@
<div class="api-category" *ngIf="network.val === 'bisq'"> <div class="api-category" *ngIf="network.val === 'bisq'">
<h4 i18n="api-docs.tab.bsq|API Docs tab for BSQ">General</h4>
<div class="endpoint-container" id="bisqStats"> <div class="endpoint-container" id="bisqStats">
<a class="section-header" [routerLink]="['./']" fragment="bisqStats">GET Stats</a> <a class="section-header" [routerLink]="['./']" fragment="bisqStats">GET Stats <span>General</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.stats)" target="_blank'" target="_blank">GET {{ baseNetworkUrl }}/api/stats</a> <a [href]="wrapUrl(network.val, code.stats)" target="_blank'" target="_blank">GET {{ baseNetworkUrl }}/api/stats</a>
@ -227,10 +221,8 @@
<div class="api-category"> <div class="api-category">
<h4 i18n="api-docs.tab.addresses|API Docs tab for Addresses">Addresses</h4>
<div class="endpoint-container" id="address"> <div class="endpoint-container" id="address">
<a class="section-header" [routerLink]="['./']" fragment="address">GET Address</a> <a class="section-header" [routerLink]="['./']" fragment="address">GET Address <span>Addresses</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.address)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address</a> <a [href]="wrapUrl(network.val, code.address)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address</a>
@ -243,7 +235,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactions"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactions">
<a class="section-header" [routerLink]="['./']" fragment="addressTransactions">GET Address Transactions</a> <a class="section-header" [routerLink]="['./']" fragment="addressTransactions">GET Address Transactions <span>Addresses</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.addressTransactions)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs</a> <a [href]="wrapUrl(network.val, code.addressTransactions)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs</a>
@ -256,7 +248,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactionsChain"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactionsChain">
<a class="section-header" [routerLink]="['./']" fragment="addressTransactionsChain">GET Address Transactions Chain</a> <a class="section-header" [routerLink]="['./']" fragment="addressTransactionsChain">GET Address Transactions Chain <span>Addresses</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.addressTransactionsChain)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs/chain</a> <a [href]="wrapUrl(network.val, code.addressTransactionsChain)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs/chain</a>
@ -269,7 +261,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactionsMempool"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressTransactionsMempool">
<a class="section-header" [routerLink]="['./']" fragment="addressTransactionsMempool">GET Address Transactions Mempool</a> <a class="section-header" [routerLink]="['./']" fragment="addressTransactionsMempool">GET Address Transactions Mempool <span>Addresses</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.addressTransactionsMempool)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool</a> <a [href]="wrapUrl(network.val, code.addressTransactionsMempool)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool</a>
@ -282,7 +274,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressUTXO"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="addressUTXO">
<a class="section-header" [routerLink]="['./']" fragment="addressUTXO">GET Address UTXO</a> <a class="section-header" [routerLink]="['./']" fragment="addressUTXO">GET Address UTXO <span>Addresses</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.addressUTXO)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/utxo</a> <a [href]="wrapUrl(network.val, code.addressUTXO)" target="_blank">GET {{ baseNetworkUrl }}/api/address/:address/utxo</a>
@ -298,10 +290,8 @@
<div class="api-category" *ngIf="network.val === 'liquid'"> <div class="api-category" *ngIf="network.val === 'liquid'">
<h4 i18n="api-docs.tab.assets|API Docs tab for Assets">Assets</h4>
<div class="endpoint-container" id="assets"> <div class="endpoint-container" id="assets">
<a class="section-header" [routerLink]="['./']" fragment="assets">GET Assets</a> <a class="section-header" [routerLink]="['./']" fragment="assets">GET Assets <span>Assets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.assets)" target="_blank">GET /liquid/api/asset/:asset_id</a> <a [href]="wrapUrl(network.val, code.assets)" target="_blank">GET /liquid/api/asset/:asset_id</a>
@ -314,7 +304,7 @@
</div> </div>
<div class="endpoint-container" id="assetTransactions"> <div class="endpoint-container" id="assetTransactions">
<a class="section-header" [routerLink]="['./']" fragment="assetTransactions">GET Asset Transactions</a> <a class="section-header" [routerLink]="['./']" fragment="assetTransactions">GET Asset Transactions <span>Assets</span></a>
<div class="endpoint"> <div class="endpoint">
<a [href]="wrapUrl(network.val, code.assetTransactions)" target="_blank">GET /liquid/api/asset/:asset_id/txs[/mempool|/chain]</a> <a [href]="wrapUrl(network.val, code.assetTransactions)" target="_blank">GET /liquid/api/asset/:asset_id/txs[/mempool|/chain]</a>
</div> </div>
@ -326,7 +316,7 @@
</div> </div>
<div class="endpoint-container" id="assetSupply"> <div class="endpoint-container" id="assetSupply">
<a class="section-header" [routerLink]="['./']" fragment="assetSupply">GET Asset Supply</a> <a class="section-header" [routerLink]="['./']" fragment="assetSupply">GET Asset Supply <span>Assets</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.assetSupply)" target="_blank">GET /liquid/api/asset/:asset_id/supply[/decimal]</a> <a [href]="wrapUrl(network.val, code.assetSupply)" target="_blank">GET /liquid/api/asset/:asset_id/supply[/decimal]</a>
@ -342,10 +332,8 @@
<div class="api-category"> <div class="api-category">
<h4 i18n="api-docs.tab.blocks|API Docs tab for Blocks">Blocks</h4>
<div class="endpoint-container" id="block"> <div class="endpoint-container" id="block">
<a class="section-header" [routerLink]="['./']" fragment="block">GET Block</a> <a class="section-header" [routerLink]="['./']" fragment="block">GET Block <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.block)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash</a> <a [href]="wrapUrl(network.val, code.block)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash</a>
@ -358,7 +346,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockHeader"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockHeader">
<a class="section-header" [routerLink]="['./']" fragment="blockHeader">GET Block Header</a> <a class="section-header" [routerLink]="['./']" fragment="blockHeader">GET Block Header <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockHeader)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/header</a> <a [href]="wrapUrl(network.val, code.blockHeader)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/header</a>
@ -371,7 +359,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockHeight"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockHeight">
<a class="section-header" [routerLink]="['./']" fragment="blockHeight">GET Block Height</a> <a class="section-header" [routerLink]="['./']" fragment="blockHeight">GET Block Height <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockHeader)" target="_blank">GET {{ baseNetworkUrl }}/api/block-height/:height</a> <a [href]="wrapUrl(network.val, code.blockHeader)" target="_blank">GET {{ baseNetworkUrl }}/api/block-height/:height</a>
@ -384,7 +372,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockRaw"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockRaw">
<a class="section-header" [routerLink]="['./']" fragment="blockRaw">GET Block Raw</a> <a class="section-header" [routerLink]="['./']" fragment="blockRaw">GET Block Raw <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<a [href]="wrapUrl(network.val, code.blockRaw)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/raw</a> <a [href]="wrapUrl(network.val, code.blockRaw)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/raw</a>
</div> </div>
@ -396,7 +384,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockStatus"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockStatus">
<a class="section-header" [routerLink]="['./']" fragment="blockStatus">GET Block Status</a> <a class="section-header" [routerLink]="['./']" fragment="blockStatus">GET Block Status <span>Blocks</span></a>
<div class="title">Get Block Status</div> <div class="title">Get Block Status</div>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
@ -410,7 +398,7 @@
</div> </div>
<div class="endpoint-container" id="blockTipHeight"> <div class="endpoint-container" id="blockTipHeight">
<a class="section-header" [routerLink]="['./']" fragment="blockTipHeight">GET Block Tip Height</a> <a class="section-header" [routerLink]="['./']" fragment="blockTipHeight">GET Block Tip Height <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockTipHeight)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/tip/height</a> <a [href]="wrapUrl(network.val, code.blockTipHeight)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/tip/height</a>
@ -423,7 +411,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTipHash"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTipHash">
<a class="section-header" [routerLink]="['./']" fragment="blockTipHash">GET Block Tip Hash</a> <a class="section-header" [routerLink]="['./']" fragment="blockTipHash">GET Block Tip Hash <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockTipHash)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/tip/hash</a> <a [href]="wrapUrl(network.val, code.blockTipHash)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/tip/hash</a>
@ -436,7 +424,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxId"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxId">
<a class="section-header" [routerLink]="['./']" fragment="blockTxId">GET Block Transaction ID</a> <a class="section-header" [routerLink]="['./']" fragment="blockTxId">GET Block Transaction ID <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockTxId)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index</a> <a [href]="wrapUrl(network.val, code.blockTxId)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index</a>
@ -449,7 +437,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxIds"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxIds">
<a class="section-header" [routerLink]="['./']" fragment="blockTxIds">GET Block Transaction IDs</a> <a class="section-header" [routerLink]="['./']" fragment="blockTxIds">GET Block Transaction IDs <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockTxIds)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txids</a> <a [href]="wrapUrl(network.val, code.blockTxIds)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txids</a>
@ -462,7 +450,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxs"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blockTxs">
<a class="section-header" [routerLink]="['./']" fragment="blockTxs">GET Block Transactions</a> <a class="section-header" [routerLink]="['./']" fragment="blockTxs">GET Block Transactions <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blockTxs)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index]</a> <a [href]="wrapUrl(network.val, code.blockTxs)" target="_blank">GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index]</a>
@ -475,7 +463,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blocks"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="blocks">
<a class="section-header" [routerLink]="['./']" fragment="blocks">GET Blocks</a> <a class="section-header" [routerLink]="['./']" fragment="blocks">GET Blocks <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blocks)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks[/:start_height]</a> <a [href]="wrapUrl(network.val, code.blocks)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks[/:start_height]</a>
@ -488,7 +476,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val === 'bisq'" id="blocks"> <div class="endpoint-container" *ngIf="network.val === 'bisq'" id="blocks">
<a class="section-header" [routerLink]="['./']" fragment="blocks">GET Blocks</a> <a class="section-header" [routerLink]="['./']" fragment="blocks">GET Blocks <span>Blocks</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.blocksBisq)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/:index/:length</a> <a [href]="wrapUrl(network.val, code.blocksBisq)" target="_blank">GET {{ baseNetworkUrl }}/api/blocks/:index/:length</a>
@ -504,10 +492,8 @@
<div class="api-category" *ngIf="network.val !== 'bisq'"> <div class="api-category" *ngIf="network.val !== 'bisq'">
<h4 i18n="api-docs.tab.fees|API Docs tab for Fees">Fees</h4>
<div class="endpoint-container" id="feeMempoolBlocks"> <div class="endpoint-container" id="feeMempoolBlocks">
<a class="section-header" [routerLink]="['./']" fragment="feeMempoolBlocks">GET Mempool Blocks Fees</a> <a class="section-header" [routerLink]="['./']" fragment="feeMempoolBlocks">GET Mempool Blocks Fees <span>Fees</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.feeMempoolBlocks)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks</a> <a [href]="wrapUrl(network.val, code.feeMempoolBlocks)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks</a>
@ -520,7 +506,7 @@
</div> </div>
<div class="endpoint-container" id="feeRecommended"> <div class="endpoint-container" id="feeRecommended">
<a class="section-header" [routerLink]="['./']" fragment="feeRecommended">GET Recommended Fees</a> <a class="section-header" [routerLink]="['./']" fragment="feeRecommended">GET Recommended Fees <span>Fees</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.feeRecommended)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/fees/recommended</a> <a [href]="wrapUrl(network.val, code.feeRecommended)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/fees/recommended</a>
@ -536,10 +522,8 @@
<div class="api-category" *ngIf="network.val !== 'bisq'"> <div class="api-category" *ngIf="network.val !== 'bisq'">
<h4 i18n="api-docs.tab.mempool|API Docs tab for Mempool">Mempool</h4>
<div class="endpoint-container" id="mempool"> <div class="endpoint-container" id="mempool">
<a class="section-header" [routerLink]="['./']" fragment="mempool">GET Mempool</a> <a class="section-header" [routerLink]="['./']" fragment="mempool">GET Mempool <span>Fees</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.mempool)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool</a> <a [href]="wrapUrl(network.val, code.mempool)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool</a>
@ -552,7 +536,7 @@
</div> </div>
<div class="endpoint-container" id="mempoolTxs"> <div class="endpoint-container" id="mempoolTxs">
<a class="section-header" [routerLink]="['./']" fragment="mempoolTxs">GET Mempool Transactions IDs</a> <a class="section-header" [routerLink]="['./']" fragment="mempoolTxs">GET Mempool Transactions IDs <span>Fees</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.mempoolTxs)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool/txids</a> <a [href]="wrapUrl(network.val, code.mempoolTxs)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool/txids</a>
@ -565,7 +549,7 @@
</div> </div>
<div class="endpoint-container" id="mempoolRecent"> <div class="endpoint-container" id="mempoolRecent">
<a class="section-header" [routerLink]="['./']" fragment="mempoolRecent">GET Mempool Recent</a> <a class="section-header" [routerLink]="['./']" fragment="mempoolRecent">GET Mempool Recent <span>Fees</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.mempoolRecent)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool/recent</a> <a [href]="wrapUrl(network.val, code.mempoolRecent)" target="_blank">GET {{ baseNetworkUrl }}/api/mempool/recent</a>
@ -581,10 +565,8 @@
<div class="api-category"> <div class="api-category">
<h4 i18n="api-docs.tab.transactions|API Docs tab for Transactions">Transactions</h4>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="cpfp"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="cpfp">
<a class="section-header" [routerLink]="['./']" fragment="cpfp">GET Children Pay for Parent</a> <a class="section-header" [routerLink]="['./']" fragment="cpfp">GET Children Pay for Parent <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionCpfp)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid</a> <a [href]="wrapUrl(network.val, code.transactionCpfp)" target="_blank">GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid</a>
@ -597,7 +579,7 @@
</div> </div>
<div class="endpoint-container" id="transaction"> <div class="endpoint-container" id="transaction">
<a class="section-header" [routerLink]="['./']" fragment="transaction">GET Transaction</a> <a class="section-header" [routerLink]="['./']" fragment="transaction">GET Transaction <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<a [href]="wrapUrl(network.val, code.transaction)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid</a> <a [href]="wrapUrl(network.val, code.transaction)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid</a>
</div> </div>
@ -609,7 +591,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionHex"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionHex">
<a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTrades">GET Transaction Hex</a> <a class="section-header" [routerLink]="['./']" fragment="bisqMarketsTrades">GET Transaction Hex <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionHex)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/hex</a> <a [href]="wrapUrl(network.val, code.transactionHex)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/hex</a>
@ -622,7 +604,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq' && network.val !== 'liquid'" id="transactionMerkleBlockProof"> <div class="endpoint-container" *ngIf="network.val !== 'bisq' && network.val !== 'liquid'" id="transactionMerkleBlockProof">
<a class="section-header" [routerLink]="['./']" fragment="transactionMerkleBlockProof">GET Transaction Merkleblock Proof</a> <a class="section-header" [routerLink]="['./']" fragment="transactionMerkleBlockProof">GET Transaction Merkleblock Proof <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionMerkleBlockProof)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof</a> <a [href]="wrapUrl(network.val, code.transactionMerkleBlockProof)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof</a>
@ -635,7 +617,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionMerkleProof"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionMerkleProof">
<a class="section-header" [routerLink]="['./']" fragment="transactionMerkleProof">GET Transaction Merkle Proof</a> <a class="section-header" [routerLink]="['./']" fragment="transactionMerkleProof">GET Transaction Merkle Proof <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionMerkleProof)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof</a> <a [href]="wrapUrl(network.val, code.transactionMerkleProof)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof</a>
@ -648,7 +630,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionOutspend"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionOutspend">
<a class="section-header" [routerLink]="['./']" fragment="transactionOutspend">GET Transaction Outspend</a> <a class="section-header" [routerLink]="['./']" fragment="transactionOutspend">GET Transaction Outspend <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionOutspend)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout</a> <a [href]="wrapUrl(network.val, code.transactionOutspend)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout</a>
@ -661,7 +643,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionOutspends"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionOutspends">
<a class="section-header" [routerLink]="['./']" fragment="transactionOutspends">GET Transaction Outspends</a> <a class="section-header" [routerLink]="['./']" fragment="transactionOutspends">GET Transaction Outspends <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionOutspends)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/outspends</a> <a [href]="wrapUrl(network.val, code.transactionOutspends)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/outspends</a>
@ -674,7 +656,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionRaw"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionRaw">
<a class="section-header" [routerLink]="['./']" fragment="transactionRaw">GET Transaction Raw</a> <a class="section-header" [routerLink]="['./']" fragment="transactionRaw">GET Transaction Raw <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionRaw)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/raw</a> <a [href]="wrapUrl(network.val, code.transactionRaw)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/raw</a>
@ -687,7 +669,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionStatus"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="transactionStatus">
<a class="section-header" [routerLink]="['./']" fragment="transactionStatus">GET Transaction Status</a> <a class="section-header" [routerLink]="['./']" fragment="transactionStatus">GET Transaction Status <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<a [href]="wrapUrl(network.val, code.transactionStatus)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/status</a> <a [href]="wrapUrl(network.val, code.transactionStatus)" target="_blank">GET {{ baseNetworkUrl }}/api/tx/:txid/status</a>
@ -700,7 +682,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val === 'bisq'" id="transactionsBisq"> <div class="endpoint-container" *ngIf="network.val === 'bisq'" id="transactionsBisq">
<a class="section-header" [routerLink]="['./']" fragment="transactionsBisq">GET Transactions</a> <a class="section-header" [routerLink]="['./']" fragment="transactionsBisq">GET Transactions <span>Transactions</span></a>
<div class="title">Get Mempool Txids</div> <div class="title">Get Mempool Txids</div>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
@ -714,7 +696,7 @@
</div> </div>
<div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="postTransaction"> <div class="endpoint-container" *ngIf="network.val !== 'bisq'" id="postTransaction">
<a class="section-header" [routerLink]="['./']" fragment="postTransaction">POST Transaction</a> <a class="section-header" [routerLink]="['./']" fragment="postTransaction">POST Transaction <span>Transactions</span></a>
<div class="endpoint"> <div class="endpoint">
<div class="subtitle" i18n="Api docs endpoint">Endpoint</div> <div class="subtitle" i18n="Api docs endpoint">Endpoint</div>
<div>POST /api/tx</div> <div>POST /api/tx</div>

50
frontend/src/app/components/docs/api-docs.component.scss
View File

@ -124,6 +124,37 @@ li.nav-item {
float: right; float: right;
} }
.endpoint-container .section-header {
display: block;
background-color: #2d3348;
color: #1bd8f4;
padding: 1rem 1.3rem 1rem 1.3rem;
font-weight: bold;
border-radius: 0.25rem;
margin: 40px 0 20px 0;
font-size: 24px;
position: relative;
}
.endpoint-container .section-header:first-child {
margin-top: 20px;
}
.endpoint-container .section-header:hover {
text-decoration: none;
}
.endpoint-container .section-header span {
color: #fff;
background-color: #653b9c;
font-size: 12px;
text-transform: uppercase;
font-weight: 400;
padding: 8px 10px;
letter-spacing: 1px;
border-radius: 0.25rem;
font-family: monospace;
float: right;
}
@media (max-width: 992px){ @media (max-width: 992px){
.doc-nav-desktop { .doc-nav-desktop {
display: none; display: none;
@ -133,12 +164,17 @@ li.nav-item {
.doc-content { .doc-content {
width: 100%; width: 100%;
} }
.endpoint-container .section-header {
margin: 40px 0 70px 0;
}
.endpoint-container .section-header span {
float: none;
position: absolute;
top: unset;
left: 0;
bottom: -50px;
}
} }
#restAPI .api-category {
margin: 30px 0;
}
.api-category h4 {
margin-bottom: 15px;
}