Epics endpoint and other minor fixes #169
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughIntroduces API reference documentation for Epics endpoints with overview, list, and detail retrieve operations. Adds navigation entry for Epics group. Updates multiple self-hosting documentation files with Docker-only Prime CLI warnings and minor content refinements. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![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
🧹 Nitpick comments (2)
self-hosting/govern/reverse-proxy.mdx (1)
28-31: Minor wording refinement: Reduce adverb repetition.The warning block contains repeated use of "only," which the static analysis tool flagged. Consider simplifying the text to avoid redundancy.
- **Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`. + **Prime CLI is for Docker installations only.** Commands only work on Plane instances originally installed using `prime-cli`.self-hosting/manage/upgrade-plane.mdx (1)
22-26: Consider separating or rephrasing the dual-concern Warning.The Warning block now conflates two distinct requirements: Docker Compose version and Prime CLI scope. The Prime CLI statement also has the adverb repetition issue flagged by the style checker ("only...only"). Consider either separating into two warnings or rewording:
- <Warning> - For Commercial Edition v1.13.0, ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed. - - **Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`. - </Warning> + <Warning> + For Commercial Edition v1.13.0, ensure you're using the **latest version of Docker Compose**. Check your Docker Compose version with `docker-compose --version` and update if needed. + </Warning> + + <Warning> + **Prime CLI is for Docker installations only.** Commands only work on Plane instances originally installed using `prime-cli`. + </Warning>Alternatively, simplify the second statement to reduce "only" repetition.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
api-reference/epics/get-epic-detail.mdx(1 hunks)api-reference/epics/list-epics.mdx(1 hunks)api-reference/epics/overview.mdx(1 hunks)api-reference/initiative/overview.mdx(1 hunks)mint.json(1 hunks)self-hosting/govern/database-and-storage.mdx(1 hunks)self-hosting/govern/oidc-sso.mdx(1 hunks)self-hosting/govern/reverse-proxy.mdx(1 hunks)self-hosting/govern/saml-sso.mdx(1 hunks)self-hosting/manage/backup-restore.mdx(1 hunks)self-hosting/manage/migrate-plane.mdx(1 hunks)self-hosting/manage/prime-cli.mdx(1 hunks)self-hosting/manage/upgrade-plane.mdx(1 hunks)self-hosting/manage/view-logs.mdx(1 hunks)self-hosting/troubleshoot/license-errors.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
self-hosting/manage/upgrade-plane.mdx
[style] ~25-~25: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...er installations only.** These commands only work on Plane instances originally inst...
(ADVERB_REPETITION_PREMIUM)
api-reference/epics/list-epics.mdx
[grammar] ~17-~17:
Context: ...fier for the project. ## Query parameters Number of results to return per page. Number of results to skip for pagination.
(QB_NEW_NL_OTHER_ERROR_IDS_UNNECESSARY_ORTHOGRAPHY_SPACE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cursor Bugbot
🔇 Additional comments (13)
api-reference/initiative/overview.mdx (1)
9-9: Good clarification.Renaming to "The Initiatives object" aligns with standard API documentation conventions for schema definitions.
self-hosting/manage/migrate-plane.mdx (1)
30-32: Prime CLI scope clarification is appropriate.The warning is well-positioned after introducing the
prime-cli backupcommand. Note: This warning text appears consistently across multiple self-hosting docs, which aids in messaging consistency.self-hosting/manage/prime-cli.mdx (1)
13-15: Good change to Warning for clarity.Elevating this from a Note to a Warning correctly emphasizes the Docker-only platform scope for Prime CLI. This is more prominent and helpful to users than the previous upgrade-related note.
self-hosting/govern/oidc-sso.mdx (1)
51-51: Excellent clarification for OIDC configuration.The expanded description clearly delineates field requirements (email mandatory, names optional) and provides sourcing guidance. This aligns well with the complementary SAML documentation updates.
self-hosting/manage/backup-restore.mdx (1)
10-12: Good placement of Prime CLI scope warning.The warning is positioned strategically before the backup command is introduced, ensuring users understand the platform constraint upfront. Messaging is consistent across the self-hosting documentation.
self-hosting/govern/saml-sso.mdx (1)
46-50: Helpful clarification of optional fields.The note clearly explains that
first_nameandlast_nameare optional but recommended, and describes the fallback behavior (account creation with email only). This reduces implementation friction and aligns with the OIDC documentation updates.self-hosting/manage/view-logs.mdx (1)
16-18: Good placement and clear messaging on Prime CLI scope.The warning appropriately clarifies that Prime CLI commands apply only to Docker installations, set right after the Docker-specific command example and before Community Edition guidance.
self-hosting/govern/database-and-storage.mdx (1)
9-11: Consistent Prime CLI scope warning, well-positioned.Placing the warning before the step-by-step instructions ensures users are aware of deployment constraints before following the configuration guide.
self-hosting/troubleshoot/license-errors.mdx (1)
7-11: Helpful pre-check guidance that improves troubleshooting flow.Directing users to sync their plan first before diving into specific errors is good UX and likely reduces redundant support requests.
Verify that the link
/workspaces-and-users/manage-licenses#sync-planis valid and points to the correct anchor.api-reference/epics/list-epics.mdx (1)
1-26: Comprehensive list endpoint documentation with clear parameters.The endpoint documentation is well-structured, with clear descriptions for path parameters (including a helpful workspace slug example) and pagination query parameters. Structure and formatting align with existing API reference patterns.
Note: Static analysis flagged a potential spacing issue at line 17, but the blank line before the heading is standard Markdown formatting and does not require correction.
api-reference/epics/overview.mdx (1)
1-168: Thorough and well-structured Epics object documentation.The overview provides a comprehensive attribute list with clear descriptions, logical ordering, and a realistic JSON example that demonstrates proper data types and nesting. Documentation aligns with patterns in other Plane API object references.
api-reference/epics/get-epic-detail.mdx (1)
1-20: Clear and complete detail endpoint documentation.The get-epic-detail endpoint is well-documented with all three required path parameters clearly described. Structure and formatting are consistent with other API reference docs.
mint.json (1)
361-368: Epics navigation group properly integrated.The new Epics group is correctly structured, references all new documentation files, and is appropriately placed under Time Tracking with logical page ordering (overview → list → detail).
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Note
Adds Epics API reference (overview, list, get) and updates self-hosting docs with Prime CLI warnings, SSO clarifications, and expanded license troubleshooting.
api-reference/epics/overview,api-reference/epics/list-epics(withlimit,offset), andapi-reference/epics/get-epic-detail, including schema and response example.mint.jsonunderAPI Reference > Epics.database-and-storage,reverse-proxy,backup-restore,migrate-plane,prime-cli,upgrade-plane,view-logs.User info URLrequirements (email required; first/last name optional).first_name/last_nameoptional for profiles.plane.env.Written by Cursor Bugbot for commit 216e4bc. This will update automatically on new commits. Configure here.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.