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

Add note for special availability

Browse Source 
Indicating that api endpoint is only available for
enterprise sponsors.
This commit is contained in:
hunicus 2023-02-25 02:26:06 -05:00
parent 73b90fcd25
commit f057b07021
No known key found for this signature in database
GPG Key ID: 24837C51B6D81FD9
4 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
frontend/src/app/docs/api-docs/api-docs-data.ts
View File

@ -2927,6 +2927,7 @@ export const restApiDocsData = [
urlString: "/v1/blocks-bulk/:minHeight[/:maxHeight]", urlString: "/v1/blocks-bulk/:minHeight[/:maxHeight]",
showConditions: bitcoinNetworks, showConditions: bitcoinNetworks,
showJsExamples: showJsExamplesDefaultFalse, showJsExamples: showJsExamplesDefaultFalse,
specialAvailability: { enterprise: true },
codeExample: { codeExample: {
default: { default: {
codeTemplate: { codeTemplate: {

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

@ -46,6 +46,8 @@
<div *ngIf="( item.type !== 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )" class="endpoint-container" id="{{ item.fragment }}"> <div *ngIf="( item.type !== 'category' ) && ( item.showConditions.indexOf(network.val) > -1 )" class="endpoint-container" id="{{ item.fragment }}">
<a id="{{ item.fragment + '-tab-header' }}" class="section-header" (click)="anchorLinkClick( $event )" [routerLink]="['./']" fragment="{{ item.fragment }}">{{ item.title }} <span>{{ item.category }}</span></a> <a id="{{ item.fragment + '-tab-header' }}" class="section-header" (click)="anchorLinkClick( $event )" [routerLink]="['./']" fragment="{{ item.fragment }}">{{ item.title }} <span>{{ item.category }}</span></a>
<div class="endpoint-content"> <div class="endpoint-content">
<div *ngIf="item.hasOwnProperty('specialAvailability') && item.specialAvailability.hasOwnProperty('enterprise') && item.specialAvailability.enterprise" class="special-availability enterprise"><table><tr><td><fa-icon [icon]="['fas', 'star']" [fixedWidth]="true"></fa-icon></td><td><p>This endpoint is available to <a [routerLink]="['/enterprise']">enterprise sponsors</a>.</p></td></tr></table></div>
<div *ngIf="item.hasOwnProperty('specialAvailability') && item.specialAvailability.hasOwnProperty('mempoolspace') && item.specialAvailability.mempoolspace" class="special-availability mempoolspace"><table><tr><td><fa-icon [icon]="['fas', 'star']" [fixedWidth]="true"></fa-icon></td><td><p>This endpoint is only supported on official mempool.space instances.</p></td></tr></table></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>
<ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_link_example" #bisq_link_example> <ng-container *ngIf="item.httpRequestMethod === 'GET' && network.val === 'bisq' && item.codeExample.hasOwnProperty('bisq');else liquid_link_example" #bisq_link_example>

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

@ -284,6 +284,28 @@ h3 {
margin-bottom: 0; margin-bottom: 0;
} }
.special-availability {
padding: 16px;
margin-bottom: 15px;
background-color: #1d1f31;
}
.special-availability table tr td:first-child {
padding-right: 10px;
}
.special-availability.enterprise fa-icon {
color: #ffc107;
}
.special-availability.mempoolspace fa-icon {
color: #1bd8f4;
}
.special-availability p {
margin: 0;
}
@media (max-width: 992px) { @media (max-width: 992px) {
h3 { h3 {

3
frontend/src/app/shared/shared.module.ts
View File

@ -4,7 +4,7 @@ import { NgbCollapseModule, NgbTypeaheadModule } from '@ng-bootstrap/ng-bootstra
import { FontAwesomeModule, FaIconLibrary } from '@fortawesome/angular-fontawesome'; import { FontAwesomeModule, FaIconLibrary } from '@fortawesome/angular-fontawesome';
import { faFilter, faAngleDown, faAngleUp, faAngleRight, faAngleLeft, faBolt, faChartArea, faCogs, faCubes, faHammer, faDatabase, faExchangeAlt, faInfoCircle, import { faFilter, faAngleDown, faAngleUp, faAngleRight, faAngleLeft, faBolt, faChartArea, faCogs, faCubes, faHammer, faDatabase, faExchangeAlt, faInfoCircle,
faLink, faList, faSearch, faCaretUp, faCaretDown, faTachometerAlt, faThList, faTint, faTv, faAngleDoubleDown, faSortUp, faAngleDoubleUp, faChevronDown, faLink, faList, faSearch, faCaretUp, faCaretDown, faTachometerAlt, faThList, faTint, faTv, faAngleDoubleDown, faSortUp, faAngleDoubleUp, faChevronDown,
faFileAlt, faRedoAlt, faArrowAltCircleRight, faExternalLinkAlt, faBook, faListUl, faDownload, faQrcode, faArrowRightArrowLeft, faArrowsRotate, faCircleLeft } from '@fortawesome/free-solid-svg-icons'; faFileAlt, faRedoAlt, faArrowAltCircleRight, faExternalLinkAlt, faBook, faListUl, faDownload, faQrcode, faArrowRightArrowLeft, faArrowsRotate, faCircleLeft, faStar } from '@fortawesome/free-solid-svg-icons';
import { InfiniteScrollModule } from 'ngx-infinite-scroll'; import { InfiniteScrollModule } from 'ngx-infinite-scroll';
import { MasterPageComponent } from '../components/master-page/master-page.component'; import { MasterPageComponent } from '../components/master-page/master-page.component';
import { PreviewTitleComponent } from '../components/master-page-preview/preview-title.component'; import { PreviewTitleComponent } from '../components/master-page-preview/preview-title.component';
@ -309,5 +309,6 @@ export class SharedModule {
library.addIcons(faQrcode); library.addIcons(faQrcode);
library.addIcons(faArrowRightArrowLeft); library.addIcons(faArrowRightArrowLeft);
library.addIcons(faExchangeAlt); library.addIcons(faExchangeAlt);
library.addIcons(faStar);
} }
} }