feat: aat token documentation, update pat token docs #85
Conversation
Reviewer's Guide by SourceryThis pull request introduces documentation for Application Access Tokens (AAT) and updates the existing documentation for Personal Access Tokens (PAT). The changes focus on providing detailed information about creating, updating, using, and managing these tokens for secure access to SettleMint services. User journey diagram for managing application access tokensjourney
title Managing Application Access Tokens
section Create Token
User: Go to application dashboard -> 1
User: Click on "App access tokens" -> 2
User: Click "Add an application access token" -> 3
User: Fill in token details -> 4
User: Click "Confirm" -> 5
section Update Token
User: Navigate to application -> 1
User: Click "App Access Tokens" -> 2
User: Click "View scopes" -> 3
User: Click "Update" -> 4
User: Choose new scopes -> 5
User: Click "Confirm" -> 6
section Delete Token
User: Navigate to application dashboard -> 1
User: Click "App Access Tokens" -> 2
User: Click "Delete" -> 3
User: Type "DELETE" to confirm -> 4
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughThe pull request involves significant changes to the documentation related to API keys and access tokens within the SettleMint platform. The file Changes
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @snigdha920 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 1 issue found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
docs/using-platform/20_personal-access-tokens.md (3)
1-20: LGTM with a minor suggestionThe introduction and creation process for personal access tokens are well-explained and easy to follow. The security warning is appropriately emphasized.
Consider adding a hyphen in "upper-right" for consistency:
-In the upper right corner of any page, click your **profile picture or avatar**, and then click **Personal access tokens**. +In the upper-right corner of any page, click your **profile picture or avatar**, and then click **Personal access tokens**.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Consider adding a hyphen.
Context: ... Create a personal access token In the upper right corner of any page, click your **profil...(TOP_LEFT_CORNER)
[duplication] ~15-~15: Possible typo: you repeated a word
Context: ... create your personal access token. :::warning Warning Copy and save your token securely - yo...(ENGLISH_WORD_REPEAT_RULE)
29-37: Consider consolidating token usage informationThe usage instructions for personal access tokens are clear and provide good examples. However, as noted in a previous review, this section is very similar to the corresponding section in the application access tokens file.
To improve maintainability and reduce duplication, consider one of these options:
- Cross-reference the "Use an application access token" section in the Application Access Tokens documentation.
- Create a shared document for token usage that both personal and application access token documents can reference.
Example of option 1:
## Use a personal access token Personal access tokens can be used in the same ways as application access tokens. For detailed information on how to use these tokens, please refer to the "Use an application access token" section in the [Application Access Tokens](19_application-access-tokens.md#use-an-application-access-token) documentation. Note: The usage methods are identical for both personal and application access tokens.🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...e these personal access tokens in three ways depending on what works for your use ca...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om/?token=TOKENappended to any URL. - As the last part of the URLhttps://myser...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
1-43: Excellent documentation with minor suggestions for improvementOverall, this document provides comprehensive and well-structured information about personal access tokens. It covers creation, deletion, usage, and comparison with application access tokens effectively.
Consider a final proofreading to address minor language issues:
- Check for consistent hyphenation (e.g., "upper-right" in line 7).
- Review the use of colons and semicolons for consistency.
- Ensure proper capitalization throughout the document.
These minor improvements will further enhance the already high-quality documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Consider adding a hyphen.
Context: ... Create a personal access token In the upper right corner of any page, click your **profil...(TOP_LEFT_CORNER)
[duplication] ~15-~15: Possible typo: you repeated a word
Context: ... create your personal access token. :::warning Warning Copy and save your token securely - yo...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...e these personal access tokens in three ways depending on what works for your use ca...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om/?token=TOKENappended to any URL. - As the last part of the URLhttps://myser...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/using-platform/19_application-access-tokens.md (2)
5-23: LGTM: Comprehensive instructions for token creationThe step-by-step guide for creating an application access token is clear and informative. The inclusion of important details about scope types and the warning about token security are particularly valuable.
Consider rewording the sentences starting with "If you selected" on lines 14-15 to avoid repetition:
- 1. If you selected **All**, you grant access to all services of the application. If you add more services to the application later, this access token will grant access to these new services as well. - 2. If you selected **Specific**, you can choose which specific services this access token will grant access to. + 1. Selecting **All** grants access to all services of the application, including any new services added later. + 2. Choosing **Specific** allows you to select which particular services this access token will grant access to.🧰 Tools
🪛 LanguageTool
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ss to these new services as well. 2. If you selected Specific, you can choo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~19-~19: Possible typo: you repeated a word
Context: ...eate your application access token. :::warning Warning Copy and save your token securely - yo...(ENGLISH_WORD_REPEAT_RULE)
44-52: LGTM with suggestions: Clear token usage instructionsThe section effectively explains the three ways to use an application access token and provides helpful examples for different services.
Consider the following formatting improvements for better readability:
- Use consistent formatting for code examples (preferably inline code blocks).
- Separate the service-specific examples into a sub-list for clarity.
Here's a suggested revision:
You can use these application access tokens in three ways depending on what works for your use case: - As a header: Use the header `x-auth-token: TOKEN`. - As a query parameter: Append `?token=TOKEN` to any URL, e.g., `https://myservice.settlemint.com/?token=TOKEN`. - As the last part of the URL: `https://myservice.settlemint.com/TOKEN`. For specific services: - IPFS nodes: Build your URI as `https://myservice.settlemint.com/TOKEN/api/v0/...` - Avalanche and Fuji: Build your URI as `https://myservice.settlemint.com/ext/bc/C/rpc/TOKEN`🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om/?token=TOKENappended to any URL. - As the last part of the URLhttps://myser...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- docs/using-platform/19_api-keys.md (0 hunks)
- docs/using-platform/19_application-access-tokens.md (1 hunks)
- docs/using-platform/20_personal-access-tokens.md (1 hunks)
- docs/using-platform/21_JWT.md (0 hunks)
💤 Files with no reviewable changes (2)
- docs/using-platform/19_api-keys.md
- docs/using-platform/21_JWT.md
🧰 Additional context used
🪛 LanguageTool
docs/using-platform/19_application-access-tokens.md
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ss to these new services as well. 2. If you selected Specific, you can choo...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[duplication] ~19-~19: Possible typo: you repeated a word
Context: ...eate your application access token. :::warning Warning Copy and save your token securely - yo...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~31-~31: Consider adding a hyphen.
Context: ...he token. 3. Click on Update in the bottom right corner to open a form where you can upd...(TOP_LEFT_CORNER)
[style] ~50-~50: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om/?token=TOKENappended to any URL. - As the last part of the URLhttps://myser...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/using-platform/20_personal-access-tokens.md
[uncategorized] ~7-~7: Consider adding a hyphen.
Context: ... Create a personal access token In the upper right corner of any page, click your **profil...(TOP_LEFT_CORNER)
[duplication] ~15-~15: Possible typo: you repeated a word
Context: ... create your personal access token. :::warning Warning Copy and save your token securely - yo...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~31-~31: Possible missing comma found.
Context: ...e these personal access tokens in three ways depending on what works for your use ca...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~35-~35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...om/?token=TOKENappended to any URL. - As the last part of the URLhttps://myser...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (5)
docs/using-platform/20_personal-access-tokens.md (2)
21-28: LGTM: Clear instructions for token deletionThe section on deleting personal access tokens is well-written and provides clear, step-by-step instructions. It also explains the scenarios when a user might want to delete a token, which is helpful context.
39-43: LGTM: Clear comparison of token typesThis section effectively compares personal and application access tokens, providing clear guidance on when to use each type. The explanation of the advantages and potential issues with each token type is concise and informative.
docs/using-platform/19_application-access-tokens.md (3)
1-3: LGTM: Clear and concise introductionThe introduction effectively explains the purpose and scope of Application Access Tokens. It provides users with a good understanding of what these tokens are and how they can be used.
25-33: LGTM: Clear instructions for updating tokensThe process for updating an application access token is well-explained and easy to follow. The step-by-step instructions provide a clear guide for users to modify token scopes.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: Consider adding a hyphen.
Context: ...he token. 3. Click on Update in the bottom right corner to open a form where you can upd...(TOP_LEFT_CORNER)
35-42: LGTM: Well-explained token deletion processThe instructions for deleting an application access token are clear and include an important safety measure (typing "DELETE" to confirm). This helps prevent accidental deletions and ensures users understand the permanence of their action.
Summary by Sourcery
Introduce comprehensive documentation for Application Access Tokens and Personal Access Tokens, replacing the outdated API keys documentation.
Documentation:
Summary by CodeRabbit