From f005681f2dcabadaaaa319dddbc737e44a9b9aeb Mon Sep 17 00:00:00 2001 From: Ignacio Rivera Axmann Date: Wed, 20 Mar 2024 12:50:52 +0100 Subject: [PATCH 1/2] updated sdk docs to have warning for project id required field --- docs/SDK/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SDK/index.md b/docs/SDK/index.md index f8bb564..6a6fd2b 100644 --- a/docs/SDK/index.md +++ b/docs/SDK/index.md @@ -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: From a0a77ed0ed10948bd4479e71fb7a63272c766e45 Mon Sep 17 00:00:00 2001 From: Ignacio Rivera Axmann Date: Wed, 20 Mar 2024 12:53:08 +0100 Subject: [PATCH 2/2] added info in the IPFS and IPNS section --- docs/SDK/ipfs.md | 4 ++++ docs/SDK/ipns.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/SDK/ipfs.md b/docs/SDK/ipfs.md index be043d3..af72073 100644 --- a/docs/SDK/ipfs.md +++ b/docs/SDK/ipfs.md @@ -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: diff --git a/docs/SDK/ipns.md b/docs/SDK/ipns.md index b75f02d..5da796a 100644 --- a/docs/SDK/ipns.md +++ b/docs/SDK/ipns.md @@ -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.