Skip to content

Commit 660f198

Browse files
authored
Update readme (#4429)
1 parent bbdb2a0 commit 660f198

File tree

4 files changed

+18
-9
lines changed

4 files changed

+18
-9
lines changed

.changeset/tasty-chicken-switch.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
'@chainlink/nav-fund-services-adapter': patch
3+
'@chainlink/ea-scripts': patch
4+
---
5+
6+
Update readme

packages/scripts/src/generate-readme/readmeBlacklist.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
"xsushi-price",
4848
"coinbase-prime",
4949
"harris-and-trotter",
50-
"nav-consulting"
50+
"nav-consulting",
51+
"nav-fund-services"
5152
]
5253
}

packages/sources/nav-fund-services/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ This document was generated automatically. Please see [README Generator](../../s
66

77
## Environment Variables
88

9-
| Required? | Name | Description | Type | Options | Default |
10-
| :-------: | :-------------------: | :---------------------------------------------------------------------------------------: | :----: | :-----: | :-------------------------------: |
11-
| | API_ENDPOINT | An API endpoint for Data Provider | string | | `https://api.navfundservices.com` |
12-
| | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number | | `120000` |
9+
| Required? | Name | Description | Type | Options | Default |
10+
| :-------: | :-------------------------: | :---------------------------------------------------------------------------------------: | :----: | :-----: | :-------------------------------: |
11+
| | API_ENDPOINT | An API endpoint for Data Provider | string | | `https://api.navfundservices.com` |
12+
|| API_KEY\_${globalFundID} | API key for the specified global fund ID | string | | |
13+
|| SECRET_KEY\_${globalFundID} | Secret key for the specified global fund ID | string | | |
14+
| | BACKGROUND_EXECUTE_MS | The amount of time the background execute should sleep before performing the next request | number | | `120000` |
1315

1416
---
1517

@@ -31,9 +33,9 @@ There are no rate limits for this adapter.
3133

3234
### Input Params
3335

34-
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
35-
| :-------: | :----------: | :-----: | :------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
36-
|| globalFundID | | Used to match API*KEY*${fund} SECRET_KEY_${fund} env variables | number | | | | |
36+
| Required? | Name | Aliases | Description | Type | Options | Default | Depends On | Not Valid With |
37+
| :-------: | :----------: | :-----: | :--------------------------------------------------------------------------------: | :----: | :-----: | :-----: | :--------: | :------------: |
38+
|| globalFundID | | Used to match `API_KEY_${globalFundID}` `SECRET_KEY_${globalFundID}` env variables | number | | | | |
3739

3840
### Example
3941

packages/sources/nav-fund-services/src/endpoint/nav.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ export const inputParameters = new InputParameters(
1010
globalFundID: {
1111
required: true,
1212
type: 'number',
13-
description: 'Used to match API_KEY_${fund} SECRET_KEY_${fund} env variables',
13+
description: 'Used to match API_KEY_${globalFundID} SECRET_KEY_${globalFundID} env variables',
1414
},
1515
},
1616
[

0 commit comments

Comments
 (0)