chore(api-client-framework): add crates.io description fields

[rimrakhimov]

Summary by CodeRabbit

• Documentation
  • Updated package description to improve clarity
  • Added license information (MIT)
  • Included repository and homepage links for the project

[coderabbitai]

Walkthrough

The pull request introduces metadata updates to the Cargo.toml file for the api-client-framework package. The changes primarily focus on enhancing the package's descriptive information by slightly modifying the description text and adding three new metadata fields: license, repository, and homepage. These additions provide more context about the package's origin, licensing, and project location. The modifications are purely informational and do not impact the package's functionality, dependencies, or implementation.

Poem

🐰 Hop, hop, metadata's new dance!
MIT license, a rabbit's glance
GitHub links now shine so bright
Our framework's story takes its flight
Metadata tweaks with bunny delight! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 77a18e8 and 608df2a.

📒 Files selected for processing (1)

• libs/api-client-framework/Cargo.toml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Unit, doc and integration tests

🔇 Additional comments (4)

libs/api-client-framework/Cargo.toml (4)

3-3: LGTM! Description is now more concise.

The updated description maintains clarity while being more direct and active in its phrasing.

---

3-6: Great job adding complete crates.io metadata!

All necessary fields for proper crates.io publishing are now present and well-structured. The changes align perfectly with the PR objectives.

---

5-6: Verify repository and homepage URLs are accessible.

The URLs follow the correct format, but let's verify they are accessible and correct.

✅ Verification successful

Repository and homepage URLs are valid and accessible

Both URLs return HTTP 200 status codes, confirming they are correctly configured in the Cargo.toml file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if URLs are accessible
REPO_URL="https://github.com/blockscout/blockscout-rs"
HOMEPAGE_URL="https://github.com/blockscout/blockscout-rs/tree/main/libs/api-client-framework"

echo "Checking repository URL..."
curl -s -o /dev/null -w "%{http_code}" $REPO_URL

echo -e "\nChecking homepage URL..."
curl -s -o /dev/null -w "%{http_code}" $HOMEPAGE_URL

Length of output: 490

---

4-4: Verify license consistency with repository root.

The MIT license declaration is appropriate, but let's ensure it matches the repository's root license.

✅ Verification successful

License declaration is consistent with repository ✅

The MIT license declaration in api-client-framework matches the repository's root LICENSE-MIT file and is consistent with the project's licensing strategy.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if LICENSE file exists and contains MIT license
if [ -f LICENSE ]; then
    echo "LICENSE file content:"
    cat LICENSE
else
    echo "LICENSE file not found in repository root"
fi

Length of output: 113

---

Script:

#!/bin/bash
# Search for any LICENSE files and Cargo.toml files
echo "=== Searching for LICENSE files ==="
fd -i license

echo -e "\n=== Checking license fields in Cargo.toml files ==="
fd Cargo.toml -x grep -l "license"

echo -e "\n=== Checking repository license info ==="
gh api repos/:owner/:repo --jq '.license'

Length of output: 815

---

Script:

#!/bin/bash
echo "=== LICENSE-MIT content ==="
cat LICENSE-MIT

echo -e "\n=== License declarations in Cargo.toml files ==="
fd Cargo.toml -x grep "license.*="

Length of output: 1452

---

Script:

#!/bin/bash
# Find which Cargo.toml has Apache 2.0 license
fd Cargo.toml -x sh -c 'echo "=== {} ==="; grep "license.*=" "{}"'

Length of output: 5110

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.