diff --git a/frontend/src/app/app-routing.module.ts b/frontend/src/app/app-routing.module.ts index 0ad66ee2d..fec2866b2 100644 --- a/frontend/src/app/app-routing.module.ts +++ b/frontend/src/app/app-routing.module.ts @@ -14,7 +14,7 @@ import { AssetsComponent } from './assets/assets.component'; import { StatusViewComponent } from './components/status-view/status-view.component'; import { DashboardComponent } from './dashboard/dashboard.component'; import { LatestBlocksComponent } from './components/latest-blocks/latest-blocks.component'; -import { ApiDocsComponent } from './components/api-docs/api-docs.component'; +import { DocsComponent } from './components/docs/docs.component'; import { TermsOfServiceComponent } from './components/terms-of-service/terms-of-service.component'; import { PrivacyPolicyComponent } from './components/privacy-policy/privacy-policy.component'; import { TrademarkPolicyComponent } from './components/trademark-policy/trademark-policy.component'; @@ -66,9 +66,21 @@ let routes: Routes = [ path: 'about', component: AboutComponent, }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, { path: 'terms-of-service', @@ -146,9 +158,21 @@ let routes: Routes = [ path: 'assets', component: AssetsComponent, }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, ], }, @@ -212,9 +236,21 @@ let routes: Routes = [ children: [], component: AddressComponent }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, ], }, @@ -278,9 +314,21 @@ let routes: Routes = [ children: [], component: AddressComponent }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, ], }, @@ -380,9 +428,21 @@ if (browserWindowEnv && browserWindowEnv.BASE_MODULE === 'liquid') { path: 'assets', component: AssetsComponent, }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, { path: 'about', @@ -429,3 +489,4 @@ if (browserWindowEnv && browserWindowEnv.BASE_MODULE === 'liquid') { exports: [RouterModule] }) export class AppRoutingModule { } + diff --git a/frontend/src/app/app.module.ts b/frontend/src/app/app.module.ts index bb6383421..0b7c072f6 100644 --- a/frontend/src/app/app.module.ts +++ b/frontend/src/app/app.module.ts @@ -48,9 +48,10 @@ import { FeesBoxComponent } from './components/fees-box/fees-box.component'; import { DashboardComponent } from './dashboard/dashboard.component'; import { FontAwesomeModule, FaIconLibrary } from '@fortawesome/angular-fontawesome'; import { faFilter, faAngleDown, faAngleUp, faAngleRight, faAngleLeft, faBolt, faChartArea, faCogs, faCubes, faDatabase, faExchangeAlt, faInfoCircle, - faLink, faList, faSearch, faCaretUp, faCaretDown, faTachometerAlt, faThList, faTint, faTv, faAngleDoubleDown, faSortUp, faAngleDoubleUp, faChevronDown, faFileAlt, faRedoAlt, faArrowAltCircleRight, faExternalLinkAlt } from '@fortawesome/free-solid-svg-icons'; -import { ApiDocsComponent } from './components/api-docs/api-docs.component'; -import { CodeTemplateComponent } from './components/api-docs/code-template.component'; + faLink, faList, faSearch, faCaretUp, faCaretDown, faTachometerAlt, faThList, faTint, faTv, faAngleDoubleDown, faSortUp, faAngleDoubleUp, faChevronDown, faFileAlt, faRedoAlt, faArrowAltCircleRight, faExternalLinkAlt, faBook } from '@fortawesome/free-solid-svg-icons'; +import { ApiDocsComponent } from './components/docs/api-docs.component'; +import { DocsComponent } from './components/docs/docs.component'; +import { CodeTemplateComponent } from './components/docs/code-template.component'; import { TermsOfServiceComponent } from './components/terms-of-service/terms-of-service.component'; import { PrivacyPolicyComponent } from './components/privacy-policy/privacy-policy.component'; import { TrademarkPolicyComponent } from './components/trademark-policy/trademark-policy.component'; @@ -100,6 +101,7 @@ import { PushTransactionComponent } from './components/push-transaction/push-tra TrademarkPolicyComponent, SponsorComponent, PushTransactionComponent, + DocsComponent, ], imports: [ BrowserModule.withServerTransition({ appId: 'serverApp' }), @@ -158,5 +160,6 @@ export class AppModule { library.addIcons(faCaretDown); library.addIcons(faAngleRight); library.addIcons(faAngleLeft); + library.addIcons(faBook); } } diff --git a/frontend/src/app/bisq/bisq.routing.module.ts b/frontend/src/app/bisq/bisq.routing.module.ts index bebf99867..73dffee51 100644 --- a/frontend/src/app/bisq/bisq.routing.module.ts +++ b/frontend/src/app/bisq/bisq.routing.module.ts @@ -7,7 +7,7 @@ import { BisqBlockComponent } from './bisq-block/bisq-block.component'; import { BisqBlocksComponent } from './bisq-blocks/bisq-blocks.component'; import { BisqAddressComponent } from './bisq-address/bisq-address.component'; import { BisqStatsComponent } from './bisq-stats/bisq-stats.component'; -import { ApiDocsComponent } from '../components/api-docs/api-docs.component'; +import { DocsComponent } from '../components/docs/docs.component'; import { BisqDashboardComponent } from './bisq-dashboard/bisq-dashboard.component'; import { BisqMarketComponent } from './bisq-market/bisq-market.component'; import { BisqMainDashboardComponent } from './bisq-main-dashboard/bisq-main-dashboard.component'; @@ -60,9 +60,21 @@ const routes: Routes = [ path: 'about', component: AboutComponent, }, + { + path: 'docs/api/:type', + component: DocsComponent + }, + { + path: 'docs/api', + redirectTo: 'docs/api/rest' + }, + { + path: 'docs', + redirectTo: 'docs/api/rest' + }, { path: 'api', - component: ApiDocsComponent, + redirectTo: 'docs/api/rest' }, { path: 'terms-of-service', diff --git a/frontend/src/app/components/api-docs/api-docs.component.html b/frontend/src/app/components/api-docs/api-docs.component.html deleted file mode 100644 index 3b2a8cd37..000000000 --- a/frontend/src/app/components/api-docs/api-docs.component.html +++ /dev/null @@ -1,899 +0,0 @@ - -
-
-

{{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API Service

-
- - - -
- -
- -
- Terms of Service - | - Privacy Policy -
- -
- diff --git a/frontend/src/app/components/bisq-master-page/bisq-master-page.component.html b/frontend/src/app/components/bisq-master-page/bisq-master-page.component.html index 9904b41c3..427a7d1c3 100644 --- a/frontend/src/app/components/bisq-master-page/bisq-master-page.component.html +++ b/frontend/src/app/components/bisq-master-page/bisq-master-page.component.html @@ -38,8 +38,8 @@
    • -
  • - +
  • +
  • diff --git a/frontend/src/app/components/docs/api-docs.component.html b/frontend/src/app/components/docs/api-docs.component.html new file mode 100644 index 000000000..d683676b5 --- /dev/null +++ b/frontend/src/app/components/docs/api-docs.component.html @@ -0,0 +1,880 @@ + +
    + +
    + +

    Reference for the {{ network.val === '' ? 'Bitcoin' : network.val.charAt(0).toUpperCase() + network.val.slice(1) }} API service.

    + +
    +

    General

    + + + + + GET Difficulty Adjustment + + +
    +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/v1/difficulty-adjustment +
    +
    +
    Description
    +
    Returns details about difficulty adjustment.
    +
    + +
    +     +     + +     +
    + +
    +

    Markets

    + + + + + GET Market Currencies + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/currencies +
    +
    +
    Description
    +
    Provides list of available currencies for a given base currency.
    +
    + +     +     + + + + GET Market Depth + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/depth?market=[:market] +
    +
    +
    Description
    +
    Provides list of open offer prices for a single market.
    +
    + +     +     + + + + GET Market HLOC + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/hloc?market=[:market] +
    +
    +
    Description
    +
    Provides hi/low/open/close data for a given market. This can be used to generate a candlestick chart.
    +
    + +     +     + + + + GET Markets + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/markets +
    +
    +
    Description
    +
    Provides list of available markets.
    +
    + +     +     + + + + GET Market Offers + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/offers?market=[:market] +
    +
    +
    Description
    +
    Provides list of open offer details for a single market.
    +
    + +     +     + + + + GET Market Ticker + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/ticker?market=[:market] +
    +
    +
    Description
    +
    Provides 24 hour price ticker for single market or all markets
    +
    + +     +     + + + + GET Market Trades + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/trades?market=[:market]&limit=[:limit] +
    +
    +
    Description
    +
    Provides list of completed trades for a single market.
    +
    + +     +     + + + + GET Market Volumes + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/volumes?basecurrency=[:basecurrency] +
    +
    +
    Description
    +
    Provides periodic volume data in terms of base currency for one or all markets.
    +
    + +     +     + +     +
    + +
    +

    General

    + + + + + GET Stats + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/stats +
    +
    +
    Description
    +
    Returns statistics about all Bisq transactions.
    +
    + +     +     + +     +
    + +
    +

    Addresses

    + + + + + GET Address + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/address/: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.
    +
    + +     +     + + + + GET Address Transactions + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/address/:address/txs +
    +
    +
    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).
    +
    + +     +     + + + + GET Address Transactions Chain + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/address/:address/txs/chain +
    +
    +
    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.
    +
    + +     +     + + + + GET Address Transactions Mempool + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/address/:address/txs/mempool +
    +
    +
    Description
    +
    Get unconfirmed transaction history for the specified address/scripthash. Returns up to 50 transactions (no paging).
    +
    + +     +     + + + + GET Address UTXO + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/address/:address/utxo +
    +
    +
    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 + + +
    +
    Endpoint
    + GET /liquid/api/asset/:asset_id +
    +
    +
    Description
    +
    Returns information about a Liquid asset.
    +
    + +     +     + + + + GET Asset Transactions + + +
    + GET /liquid/api/asset/:asset_id/txs[/mempool|/chain] +
    +
    +
    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.
    +
    + +     +     + + + + GET Asset Supply + + +
    +
    Endpoint
    + GET /liquid/api/asset/:asset_id/supply[/decimal] +
    +
    +
    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 + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash +
    +
    +
    Description
    +
    Returns details about a block. Available fields: id, height, version, timestamp, bits, nonce, merkle_root, tx_count, size, weight, proof, and previousblockhash.
    +
    + +     +     + + + + GET Block Header + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash/header +
    +
    +
    Description
    +
    Returns the hex-encoded block header.
    +
    + +     +     + + + + GET Block Height + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block-height/:height +
    +
    +
    Description
    +
    Returns the hash of the block currently at :height.
    +
    + +     +     + + + + GET Block Raw + + +
    + GET {{ baseNetworkUrl }}/api/block/:hash/raw +
    +
    +
    Description
    +
    Returns the raw block representation in binary.
    +
    + +     +     + + + + GET Block Status + + +
    Get Block Status
    +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash/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 Tip Height + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/blocks/tip/height +
    +
    +
    Description
    +
    Returns the height of the last block.
    +
    + +     +     + + + + GET Block Tip Hash + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/blocks/tip/hash +
    +
    +
    Description
    +
    Returns the hash of the last block.
    +
    + +     +     + + + + GET Block Transaction ID + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash/txid/:index +
    +
    +
    Description
    +
    Returns the transaction at index :index within the specified block.
    +
    + +     +     + + + + GET Block Transaction IDs + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash/txids +
    +
    +
    Description
    +
    Returns a list of all txids in the block.
    +
    + +     +     + + + + GET Block Transactions + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/block/:hash/txs[/:start_index] +
    +
    +
    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.
    +
    + +     +     + + + + GET Blocks + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/blocks[/:start_height] +
    +
    +
    Description
    +
    Returns the 10 newest blocks starting at the tip or at :start_height if specified.
    +
    + +     +     + + + + GET Blocks + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/blocks/:index/:length +
    +
    +
    Description
    +
    Returns the 10 newest blocks starting at the tip or at :start_height if specified.
    +
    + +     +     + +     +
    + +
    +

    Fees

    + + + + + GET Mempool Blocks Fees + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/v1/fees/mempool-blocks +
    +
    +
    Description
    +
    Returns current mempool as projected blocks.
    +
    + +     +     + + + + GET Recommended Fees + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/v1/fees/recommended +
    +
    +
    Description
    +
    Returns our currently suggested fees for new transactions.
    +
    + +     +     + +     +
    + +
    +

    Mempool

    + + + + + GET Mempool + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/mempool +
    +
    +
    Description
    +
    Returns current mempool backlog statistics.
    +
    + +     +     + + + + GET Mempool Transactions IDs + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/mempool/txids +
    +
    +
    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.
    +
    + +     +     + + + + GET Mempool Recent + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/mempool/recent +
    +
    +
    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 + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/v1/cpfp/:txid +
    +
    +
    Description
    +
    Returns the ancestors and the best descendant fees for a transaction.
    +
    + +     +     + + + + GET Transaction + + +
    + GET {{ baseNetworkUrl }}/api/tx/:txid +
    +
    +
    Description
    +
    Returns details about a transaction. Available fields: txid, version, locktime, size, weight, fee, vin, vout, and status.
    +
    + +     +     + + + + GET Transaction Hex + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/hex +
    +
    +
    Description
    +
    Returns a transaction serialized as hex.
    +
    + +     +     + + + + GET Transaction Merkleblock Proof + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/merkleblock-proof +
    +
    +
    Description
    +
    Returns a merkle inclusion proof for the transaction using bitcoind's merkleblock format.
    +
    + +     +     + + + + GET Transaction Merkle Proof + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/merkle-proof +
    +
    +
    Description
    +
    Returns a merkle inclusion proof for the transaction using Electrum's blockchain.transaction.get_merkle format.
    +
    + +     +     + + + + GET Transaction Outspend + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/outspend/:vout +
    +
    +
    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).
    +
    + +     +     + + + + GET Transaction Outspends + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/outspends +
    +
    +
    Description
    +
    Returns the spending status of all transaction outputs.
    +
    + +     +     + + + + GET Transaction Raw + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/raw +
    +
    +
    Description
    +
    Returns a transaction as binary data.
    +
    + +     +     + + + + GET Transaction Status + + +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/tx/:txid/status +
    +
    +
    Description
    +
    Returns the confirmation status of a transaction. Available fields: confirmed (boolean), block_height (optional), and block_hash (optional).
    +
    + +     +     + + + + GET Transactions + + +
    Get Mempool Txids
    +
    +
    Endpoint
    + GET {{ baseNetworkUrl }}/api/txs/:index/:length +
    +
    +
    Description
    +
    Returns :length of latest Bisq transactions, starting from :index.
    +
    + +     +     + + + + POST Transaction + + +
    +
    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
    + {{ wrapUrl(network.val, code.websocket, true) }} +
    +
    +
    Description
    +
    Default push: {{ '{' }} action: 'want', data: ['blocks', ...] {{ '}' }} to express what you want pushed. Available: blocks, mempool-blocks, live-2h-chart, and stats.

    Push transactions related to address: {{ '{' }} 'track-address': '3PbJ...bF9B' {{ '}' }} to receive all new transactions containing that address as input or output. Returns an array of transactions. address-transactions for new mempool transactions, and block-transactions for new block confirmed transactions.
    +
    + +
    +
    +
    + +
    + +
    + Terms of Service + | + Privacy Policy +
    + +
    +     diff --git a/frontend/src/app/components/api-docs/api-docs.component.scss b/frontend/src/app/components/docs/api-docs.component.scss similarity index 91% rename from frontend/src/app/components/api-docs/api-docs.component.scss rename to frontend/src/app/components/docs/api-docs.component.scss index 2fbadd123..c5ba9602c 100644 --- a/frontend/src/app/components/api-docs/api-docs.component.scss +++ b/frontend/src/app/components/docs/api-docs.component.scss @@ -73,4 +73,12 @@ li.nav-item { .difficulty { padding: 15px; -} \ No newline at end of file +} + +#restAPI .api-category { + margin: 30px 0; +} + +.api-category h4 { + margin-bottom: 15px; +} diff --git a/frontend/src/app/components/api-docs/api-docs.component.ts b/frontend/src/app/components/docs/api-docs.component.ts similarity index 99% rename from frontend/src/app/components/api-docs/api-docs.component.ts rename to frontend/src/app/components/docs/api-docs.component.ts index 33597852d..a38ded836 100644 --- a/frontend/src/app/components/api-docs/api-docs.component.ts +++ b/frontend/src/app/components/docs/api-docs.component.ts @@ -1,4 +1,4 @@ -import { Component, OnInit } from '@angular/core'; +import { Component, OnInit, Input } from '@angular/core'; import { Env, StateService } from 'src/app/services/state.service'; import { Observable, merge, of } from 'rxjs'; import { SeoService } from 'src/app/services/seo.service'; @@ -16,6 +16,7 @@ export class ApiDocsComponent implements OnInit { env: Env; code: any; baseNetworkUrl = ''; + @Input() restTabActivated: Boolean; constructor( private stateService: StateService, diff --git a/frontend/src/app/components/api-docs/code-template.component.html b/frontend/src/app/components/docs/code-template.component.html similarity index 100% rename from frontend/src/app/components/api-docs/code-template.component.html rename to frontend/src/app/components/docs/code-template.component.html diff --git a/frontend/src/app/components/api-docs/code-template.component.scss b/frontend/src/app/components/docs/code-template.component.scss similarity index 100% rename from frontend/src/app/components/api-docs/code-template.component.scss rename to frontend/src/app/components/docs/code-template.component.scss diff --git a/frontend/src/app/components/api-docs/code-template.component.ts b/frontend/src/app/components/docs/code-template.component.ts similarity index 100% rename from frontend/src/app/components/api-docs/code-template.component.ts rename to frontend/src/app/components/docs/code-template.component.ts diff --git a/frontend/src/app/components/docs/docs.component.html b/frontend/src/app/components/docs/docs.component.html new file mode 100644 index 000000000..0c4b70e2f --- /dev/null +++ b/frontend/src/app/components/docs/docs.component.html @@ -0,0 +1,31 @@ +
    +
    + +

    Documentation

    + + + +
    + +
    +
    diff --git a/frontend/src/app/components/docs/docs.component.scss b/frontend/src/app/components/docs/docs.component.scss new file mode 100644 index 000000000..404782585 --- /dev/null +++ b/frontend/src/app/components/docs/docs.component.scss @@ -0,0 +1,4 @@ +#main-tab-content { + text-align: left; + padding-top: 10px; +} diff --git a/frontend/src/app/components/docs/docs.component.ts b/frontend/src/app/components/docs/docs.component.ts new file mode 100644 index 000000000..4957cf67f --- /dev/null +++ b/frontend/src/app/components/docs/docs.component.ts @@ -0,0 +1,21 @@ +import { Component, OnInit } from '@angular/core'; +import { ActivatedRoute } from '@angular/router'; + +@Component({ + selector: 'app-docs', + templateUrl: './docs.component.html', + styleUrls: ['./docs.component.scss'] +}) +export class DocsComponent implements OnInit { + + activeTab = 0; + + constructor( + private route: ActivatedRoute, + ) { } + + ngOnInit(): void { + const url = this.route.snapshot.url; + this.activeTab = ( url[2].path === "rest" ) ? 0 : 1; + } +} diff --git a/frontend/src/app/components/liquid-master-page/liquid-master-page.component.html b/frontend/src/app/components/liquid-master-page/liquid-master-page.component.html index 02a7adeca..f6e02beed 100644 --- a/frontend/src/app/components/liquid-master-page/liquid-master-page.component.html +++ b/frontend/src/app/components/liquid-master-page/liquid-master-page.component.html @@ -44,7 +44,7 @@
  • - +
  • @@ -59,4 +59,4 @@ -
    \ No newline at end of file +
    diff --git a/frontend/src/app/components/master-page/master-page.component.html b/frontend/src/app/components/master-page/master-page.component.html index 6e6379f49..efe5c6933 100644 --- a/frontend/src/app/components/master-page/master-page.component.html +++ b/frontend/src/app/components/master-page/master-page.component.html @@ -57,8 +57,8 @@
    • -
  • - +
  • +