Add ref param to vcs list contents by vermakhushboo · Pull Request #9991 · appwrite/appwrite

vermakhushboo · 2025-06-10T15:08:41Z

What does this PR do?

Add ref param to pass branch/commit/tag to list contents

Test Plan

Tested manually

Related PRs and Issues

(Related PR or issue)

Checklist

Have you read the Contributing Guidelines on issues?
If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?

Summary by CodeRabbit

New Features
- Added support for specifying a branch, tag, or commit when retrieving GitHub repository contents via the API.
Chores
- Updated the appwrite-console service to use version 6.0.41 in Docker Compose.

coderabbitai · 2025-06-10T15:10:52Z

"""

Walkthrough

A new optional parameter, providerReference, was introduced to the GitHub repository contents API endpoint, allowing clients to specify a branch, tag, or commit for content retrieval. Additionally, the Docker Compose configuration was updated to use a newer version of the appwrite-console image.

Changes

File(s)	Change Summary
app/controllers/api/vcs.php	Added optional `providerReference` parameter to GitHub contents API endpoint and updated handler.
docker-compose.yml	Updated `appwrite-console` service image tag from `6.0.32` to `6.0.41`.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Server
    participant GitHub

    Client->>API_Server: GET /v1/vcs/github/installations/:installationId/providerRepositories/:providerRepositoryId/contents?providerReference=ref
    API_Server->>GitHub: listRepositoryContents(..., providerReference)
    GitHub-->>API_Server: Repository contents at specified reference
    API_Server-->>Client: Return repository contents

Poem

In the warren of code, a new path appears,
With providerReference guiding through branches and years.
Console hops forward, version fresh and bright,
Bringing new features to every byte.
A rabbit’s delight in these changes so neat—
Code leaps ahead, never missing a beat!
🐇✨
"""

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7209024 and 481f1b4.

⛔ Files ignored due to path filters (6)

app/config/specs/open-api3-latest-client.json is excluded by !app/config/specs/**
app/config/specs/open-api3-latest-console.json is excluded by !app/config/specs/**
app/config/specs/open-api3-latest-server.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-client.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-console.json is excluded by !app/config/specs/**
app/config/specs/swagger2-latest-server.json is excluded by !app/config/specs/**

📒 Files selected for processing (1)

app/controllers/api/vcs.php (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

app/controllers/api/vcs.php

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

GitHub Check: Setup & Build Appwrite Image
GitHub Check: Setup & Build SDK
GitHub Check: scan

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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.

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.

github-actions · 2025-06-10T15:10:53Z

Security Scan Results for PR

Docker Image Scan Results

Package	Version	Vulnerability	Severity
binutils	2.42-r0	CVE-2025-0840	HIGH
libexpat	2.6.4-r0	CVE-2024-8176	HIGH
libxml2	2.12.7-r0	CVE-2024-56171	HIGH
libxml2	2.12.7-r0	CVE-2025-24928	HIGH
libxml2	2.12.7-r0	CVE-2025-27113	HIGH
libxml2	2.12.7-r0	CVE-2025-32414	HIGH
libxml2	2.12.7-r0	CVE-2025-32415	HIGH
pyc	3.12.9-r0	CVE-2024-12718	HIGH
pyc	3.12.9-r0	CVE-2025-4138	HIGH
pyc	3.12.9-r0	CVE-2025-4517	HIGH
python3	3.12.9-r0	CVE-2024-12718	HIGH
python3	3.12.9-r0	CVE-2025-4138	HIGH
python3	3.12.9-r0	CVE-2025-4517	HIGH
python3-pyc	3.12.9-r0	CVE-2024-12718	HIGH
python3-pyc	3.12.9-r0	CVE-2025-4138	HIGH
python3-pyc	3.12.9-r0	CVE-2025-4517	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2024-12718	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2025-4138	HIGH
python3-pycache-pyc0	3.12.9-r0	CVE-2025-4517	HIGH
sqlite-libs	3.45.3-r1	CVE-2025-29087	HIGH
xz	5.6.2-r0	CVE-2025-31115	HIGH
xz-libs	5.6.2-r0	CVE-2025-31115	HIGH
golang.org/x/crypto	v0.31.0	CVE-2025-22869	HIGH

Source Code Scan Results

🎉 No vulnerabilities found!

github-actions · 2025-06-10T15:21:48Z

✨ Benchmark results

Requests per second: 926
Requests with 200 status code: 166,753
P99 latency: 0.203747967

⚡ Benchmark Comparison

Metric	This PR	Latest version
RPS	926	1,082
200	166,753	194,875
P99	0.203747967	0.178599866

app/controllers/api/vcs.php

…rite/appwrite into feat-ref-param-to-vcs-list-contents

pkg-pr-new · 2025-06-13T10:28:39Z

Open in StackBlitz

npm i https://pkg.pr.new/appwrite/appwrite/@appwrite.io/console@9991

commit: 3f14c27

Add ref param to vcs list contents

7209024

vermakhushboo requested review from ItzNotABug, Meldiron and eldadfux June 10, 2025 15:08

ItzNotABug approved these changes Jun 10, 2025

View reviewed changes

vermakhushboo added 2 commits June 11, 2025 18:10

Merge branch '1.7.x' into feat-ref-param-to-vcs-list-contents

22f6404

Merge branch '1.7.x' into feat-ref-param-to-vcs-list-contents

1b6d05a

vermakhushboo commented Jun 12, 2025

View reviewed changes

app/controllers/api/vcs.php Outdated Show resolved Hide resolved

vermakhushboo added 3 commits June 13, 2025 15:51

Merge branch '1.7.x' into feat-ref-param-to-vcs-list-contents

4099f89

Update var name and generate specs

221f153

Merge branch 'feat-ref-param-to-vcs-list-contents' of github.com:appw…

481f1b4

…rite/appwrite into feat-ref-param-to-vcs-list-contents

Merge branch '1.7.x' into feat-ref-param-to-vcs-list-contents

3f14c27

Meldiron approved these changes Jun 13, 2025

View reviewed changes

Meldiron merged commit 4704f6f into 1.7.x Jun 13, 2025
40 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ref param to vcs list contents#9991

Add ref param to vcs list contents#9991
Meldiron merged 7 commits into1.7.xfrom
feat-ref-param-to-vcs-list-contents

vermakhushboo commented Jun 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 10, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

vermakhushboo commented Jun 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Test Plan

Related PRs and Issues

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Security Scan Results for PR

Docker Image Scan Results

Source Code Scan Results

Uh oh!

github-actions bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✨ Benchmark results

⚡ Benchmark Comparison

Uh oh!

Uh oh!

pkg-pr-new bot commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

vermakhushboo commented Jun 10, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 10, 2025 •

edited

Loading

github-actions bot commented Jun 10, 2025 •

edited

Loading

github-actions bot commented Jun 10, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 13, 2025 •

edited

Loading