Skip to content

Commit a5fd68e

Browse files
treeoflife2treeoflife2
committed
improve wording from pro to API-plan to reduce confusion to users
1 parent 53eac97 commit a5fd68e

File tree

6 files changed

+47
-47
lines changed

6 files changed

+47
-47
lines changed

‎defillama-openapi-pro.json‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
"/api/tokenProtocols/{symbol}": {
5757
"get": {
5858
"tags": ["TVL"],
59-
"x-pro-only": true,
59+
"x-api-plan-only": true,
6060
"summary": "Lists the amount of a certain token within all protocols. Data for the Token Usage page",
6161
"parameters": [
6262
{
@@ -111,7 +111,7 @@
111111
"/api/inflows/{protocol}/{timestamp}": {
112112
"get": {
113113
"tags": ["TVL"],
114-
"x-pro-only": true,
114+
"x-api-plan-only": true,
115115
"summary": "Lists the amount of inflows and outflows for a protocol at a given date",
116116
"parameters": [
117117
{
@@ -365,7 +365,7 @@
365365
}
366366
}
367367
},
368-
"x-pro-only": true
368+
"x-api-plan-only": true
369369
}
370370
},
371371
"/stablecoins/stablecoindominance/{chain}": {
@@ -449,7 +449,7 @@
449449
}
450450
}
451451
},
452-
"x-pro-only": true
452+
"x-api-plan-only": true
453453
}
454454
},
455455
"/api/activeUsers": {
@@ -548,7 +548,7 @@
548548
}
549549
}
550550
},
551-
"x-pro-only": true
551+
"x-api-plan-only": true
552552
}
553553
},
554554
"/api/userData/{type}/{protocolId}": {
@@ -604,7 +604,7 @@
604604
}
605605
}
606606
},
607-
"x-pro-only": true
607+
"x-api-plan-only": true
608608
}
609609
},
610610
"/api/emissions": {
@@ -719,7 +719,7 @@
719719
}
720720
}
721721
},
722-
"x-pro-only": true
722+
"x-api-plan-only": true
723723
}
724724
},
725725
"/api/emission/{protocol}": {
@@ -992,7 +992,7 @@
992992
}
993993
}
994994
},
995-
"x-pro-only": true
995+
"x-api-plan-only": true
996996
}
997997
},
998998
"/api/categories": {
@@ -1128,13 +1128,13 @@
11281128
}
11291129
}
11301130
},
1131-
"x-pro-only": true
1131+
"x-api-plan-only": true
11321132
}
11331133
},
11341134
"/api/forks": {
11351135
"get": {
11361136
"tags": ["main page"],
1137-
"x-pro-only": true,
1137+
"x-api-plan-only": true,
11381138
"summary": "Overview of all categories accross all protocols",
11391139
"responses": {
11401140
"200": {
@@ -1339,7 +1339,7 @@
13391339
}
13401340
}
13411341
},
1342-
"x-pro-only": true
1342+
"x-api-plan-only": true
13431343
}
13441344
},
13451345
"/api/hacks": {
@@ -1414,7 +1414,7 @@
14141414
}
14151415
}
14161416
},
1417-
"x-pro-only": true
1417+
"x-api-plan-only": true
14181418
}
14191419
},
14201420
"/api/raises": {
@@ -1504,7 +1504,7 @@
15041504
}
15051505
}
15061506
},
1507-
"x-pro-only": true
1507+
"x-api-plan-only": true
15081508
}
15091509
},
15101510
"/api/treasuries": {
@@ -1660,7 +1660,7 @@
16601660
}
16611661
}
16621662
},
1663-
"x-pro-only": true
1663+
"x-api-plan-only": true
16641664
}
16651665
},
16661666
"/api/entities": {
@@ -1793,7 +1793,7 @@
17931793
}
17941794
}
17951795
},
1796-
"x-pro-only": true
1796+
"x-api-plan-only": true
17971797
}
17981798
},
17991799
"/api/historicalLiquidity/{token}": {
@@ -1817,7 +1817,7 @@
18171817
"description": "successful operation"
18181818
}
18191819
},
1820-
"x-pro-only": true
1820+
"x-api-plan-only": true
18211821
}
18221822
},
18231823
"/yields/pools": {
@@ -2176,7 +2176,7 @@
21762176
}
21772177
}
21782178
},
2179-
"x-pro-only": true
2179+
"x-api-plan-only": true
21802180
}
21812181
},
21822182
"/yields/chart/{pool}": {
@@ -2444,7 +2444,7 @@
24442444
}
24452445
}
24462446
},
2447-
"x-pro-only": true
2447+
"x-api-plan-only": true
24482448
}
24492449
},
24502450
"/yields/chartLendBorrow/{pool}": {
@@ -2521,7 +2521,7 @@
25212521
}
25222522
}
25232523
},
2524-
"x-pro-only": true
2524+
"x-api-plan-only": true
25252525
}
25262526
},
25272527
"/yields/perps": {
@@ -2610,7 +2610,7 @@
26102610
}
26112611
}
26122612
},
2613-
"x-pro-only": true
2613+
"x-api-plan-only": true
26142614
}
26152615
},
26162616
"/yields/lsdRates": {
@@ -2678,7 +2678,7 @@
26782678
}
26792679
}
26802680
},
2681-
"x-pro-only": true
2681+
"x-api-plan-only": true
26822682
}
26832683
},
26842684
"/etfs/snapshot": {
@@ -2761,7 +2761,7 @@
27612761
}
27622762
}
27632763
},
2764-
"x-pro-only": true
2764+
"x-api-plan-only": true
27652765
}
27662766
},
27672767
"/etfs/flows": {
@@ -2804,7 +2804,7 @@
28042804
}
28052805
}
28062806
},
2807-
"x-pro-only": true
2807+
"x-api-plan-only": true
28082808
}
28092809
},
28102810
"/fdv/performance/{period}": {
@@ -2959,7 +2959,7 @@
29592959
}
29602960
}
29612961
},
2962-
"x-pro-only": true
2962+
"x-api-plan-only": true
29632963
}
29642964
},
29652965
"/api/overview/derivatives": {
@@ -3352,7 +3352,7 @@
33523352
}
33533353
}
33543354
},
3355-
"x-pro-only": true
3355+
"x-api-plan-only": true
33563356
}
33573357
},
33583358
"/api/summary/derivatives/{protocol}": {
@@ -3675,7 +3675,7 @@
36753675
}
36763676
}
36773677
},
3678-
"x-pro-only": true
3678+
"x-api-plan-only": true
36793679
}
36803680
},
36813681
"/bridges": {
@@ -3811,7 +3811,7 @@
38113811
}
38123812
}
38133813
},
3814-
"x-pro-only": true
3814+
"x-api-plan-only": true
38153815
}
38163816
},
38173817
"/bridge/{id}": {
@@ -4081,7 +4081,7 @@
40814081
}
40824082
}
40834083
},
4084-
"x-pro-only": true
4084+
"x-api-plan-only": true
40854085
}
40864086
},
40874087
"/bridgevolume/{chain}": {
@@ -4168,7 +4168,7 @@
41684168
}
41694169
}
41704170
},
4171-
"x-pro-only": true
4171+
"x-api-plan-only": true
41724172
}
41734173
},
41744174
"/bridgedaystats/{timestamp}/{chain}": {
@@ -4365,7 +4365,7 @@
43654365
}
43664366
}
43674367
},
4368-
"x-pro-only": true
4368+
"x-api-plan-only": true
43694369
}
43704370
},
43714371
"/transactions/{id}": {
@@ -4847,7 +4847,7 @@
48474847
}
48484848
}
48494849
},
4850-
"x-pro-only": true
4850+
"x-api-plan-only": true
48514851
}
48524852
},
48534853
"/usage/APIKEY": {
@@ -4864,7 +4864,7 @@
48644864
"description": "credits left"
48654865
}
48664866
},
4867-
"x-pro-only": true
4867+
"x-api-plan-only": true
48684868
}
48694869
},
48704870
"/api/protocols": {

‎examples/web/src/components/ApiKeyInput.vue‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ const switchToFreeApi = () => {
111111
<input
112112
type="text"
113113
:value="apiKey"
114-
placeholder="Enter your DefiLlama Pro API key"
114+
placeholder="Enter your DefiLlama (API plan) API key"
115115
class="api-key-field"
116116
@input="handleKeyChange" />
117117
</div>
@@ -173,7 +173,7 @@ const switchToFreeApi = () => {
173173
line-height: 1.4 !important;
174174
}
175175
176-
.pro-badge {
176+
.api-plan-badge {
177177
display: inline-flex !important;
178178
align-items: center !important;
179179
padding: 2px 6px !important;
@@ -373,7 +373,7 @@ const switchToFreeApi = () => {
373373
box-shadow: 0 0 0 2px var(--scalar-color-accent);
374374
}
375375
376-
.pro-badge {
376+
.api-plan-badge {
377377
border: 1px solid var(--scalar-color-orange);
378378
}
379379
}

‎examples/web/src/pages/StandaloneApiReferencePage.vue‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ const getUpdatedSpec = (baseUrl: string) => {
1919
return spec
2020
}
2121
22-
// Free plan: merge free spec with x-pro-only endpoints from pro spec
22+
// Free plan: merge free spec with x-api-plan-only endpoints from pro spec
2323
const freeSpec = JSON.parse(JSON.stringify(freeSpecContent))
2424
const proSpec = JSON.parse(JSON.stringify(proSpecContent))
2525
26-
// Add pro-only endpoints to the free spec
26+
// Add API-Plan-only endpoints to the free spec
2727
for (const path in proSpec.paths) {
2828
for (const method in proSpec.paths[path]) {
29-
if (proSpec.paths[path][method]['x-pro-only']) {
29+
if (proSpec.paths[path][method]['x-api-plan-only']) {
3030
if (!freeSpec.paths[path]) {
3131
freeSpec.paths[path] = {}
3232
}

‎llms.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ DefiLlama API – Complete LLM Integration Guide
44
## Overview
55

66
This document provides comprehensive guidance for LLMs to interact with ALL DefiLlama APIs.
7-
Includes pro-only endpoints (marked with 🔒) and free endpoints, with full parameters and responses.
7+
Includes API-Plan-only endpoints (marked with 🔒) and free endpoints, with full parameters and responses.
88

99
## Base URLs
1010

‎packages/api-reference/src/components/Content/Tag/OperationsListItem.vue‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ const title = computed(
6666
}">
6767
{{ transformedOperation.path }}
6868
<span
69-
v-if="transformedOperation.information?.['x-pro-only'] === true"
69+
v-if="transformedOperation.information?.['x-api-plan-only'] === true"
7070
class="pro-indicator">
71-
PRO
71+
API Plan
7272
</span>
7373
</span>
7474
</a>

‎packages/api-reference/src/components/ProBadge/ProBadge.vue‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<template>
22
<Badge
33
v-if="showProBadge"
4-
class="text-orange pro-badge">
5-
PRO
4+
class="text-orange api-plan-badge">
5+
API Plan
66
</Badge>
77
</template>
88

@@ -13,19 +13,19 @@ import { Badge } from '@/components/Badge'
1313
1414
const { operation } = defineProps<{
1515
operation?: {
16-
'x-pro-only'?: boolean
16+
'x-api-plan-only'?: boolean
1717
[key: string]: any
1818
}
1919
}>()
2020
21-
/** Only show the PRO badge when x-pro-only is explicitly set to "pro" */
21+
/** Only show the PRO badge when x-api-plan-only is explicitly set to "pro" */
2222
const showProBadge = computed(() => {
23-
return operation?.['x-pro-only'] === true
23+
return operation?.['x-api-plan-only'] === true
2424
})
2525
</script>
2626

2727
<style scoped>
28-
.pro-badge {
28+
.api-plan-badge {
2929
font-weight: var(--scalar-bold);
3030
font-size: var(--scalar-micro);
3131
}

0 commit comments

Comments
 (0)