Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: SDK docs update #56

Merged
merged 2 commits into from
Mar 20, 2024
Merged

fix: SDK docs update #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f005681
updated sdk docs to have warning for project id required field
riveign Mar 20, 2024
a0a77ed
added info in the IPFS and IPNS section
riveign Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/SDK/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The personal access token (PAT) is ment to be used in Backend Node.js environmen
|*parameters*|*description*|
|:----------:|:-----------:|
|`personalAccessToken`|Private PAT, generated from the `CLI`.|
|`projectId` (Optional)|Project Id is required for specific services.|
|`projectId` (Optional)|Project Id is required for IPFS and IPNS service |

This method of authentication relies on a `personalAccessToken` which can be obtained from the Fleek CLI:

Expand Down
4 changes: 4 additions & 0 deletions docs/SDK/ipfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ tags:
- Fleek
---

:::info
In case you are using the Fleek SDK with a PAT as the authentication service you need to make sure that the projectId is set in the PersonalAccessTokenService.
:::

### How to pin a file

Here is a list of the available methods for the `IPFS` service:
Expand Down
4 changes: 4 additions & 0 deletions docs/SDK/ipns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ tags:
- Fleek
---

:::info
In case you are using the Fleek SDK with a PAT as the authentication service you need to make sure that the projectId is set in the PersonalAccessTokenService.
:::

### How to Create an IPNS Record

To create an IPNS record using the SDK, you need to be authenticated and have a project selected.
Expand Down
Loading