Clarify API docs for triage endpoint and S3 configuration#2216
Merged
jorgemanrubia merged 3 commits intobasecamp:mainfrom Mar 3, 2026
Merged
Clarify API docs for triage endpoint and S3 configuration#2216jorgemanrubia merged 3 commits intobasecamp:mainfrom
jorgemanrubia merged 3 commits intobasecamp:mainfrom
Conversation
Member
|
I think we can just remove the extra sentence — "Moves a card into a column." feels sufficient on its own. |
jorgemanrubia
approved these changes
Mar 3, 2026
Member
|
Thanks for the contribution! Good catches on both the triage endpoint description and the CSP docs. |
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR that clarifies the behavior of the card triage API endpoint and documents an additional CSP environment variable needed for S3 direct uploads in container-based deployments.
Changes:
- Update API docs to describe the triage endpoint as moving a card into a column (not only from triage).
- Add
CSP_CONNECT_SRCto the documented S3-related environment variables for Docker and Kamal deployments.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/kamal-deployment.md | Documents CSP_CONNECT_SRC alongside S3 env vars for Kamal deployments. |
| docs/docker-deployment.md | Documents CSP_CONNECT_SRC alongside S3 env vars for Docker deployments. |
| docs/API.md | Clarifies the POST .../triage endpoint description to match actual behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two small documentation clarifications:
API.md - The triage endpoint documentation says "Moves a card from triage into a column" which implies it only works for cards in triage. The implementation works for cards in any state, so updated to clarify.
docker-deployment.md / kamal-deployment.md - Added
CSP_CONNECT_SRCto the S3 configuration section. Without this, browser Content Security Policy blocks direct uploads to S3.