docs: add create project with template API endpoint#293
Conversation
Documents the new POST /api/v1/workspaces/{slug}/projects/templates/use/ endpoint from plane-ee#7644. Adds the page to the Projects sidebar after Create Project.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Review limit reached
More reviews will be available in 53 minutes and 11 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new API reference page is added documenting the ChangesCreate Project with Template API Reference
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/api-reference/project/create-project-with-template.md`:
- Line 21: The markdown document has incorrect heading hierarchy, jumping from
h1 directly to h3 and skipping the h2 level. Change the heading level for the
main section headings "Path Parameters", "Body Parameters", and "Scopes" from h3
(###) to h2 (##) to ensure proper hierarchical progression and comply with
markdown best practices.
- Around line 134-151: The fetch function call with the long URL exceeds the
120-character line width limit. Refactor the const response await fetch
statement by breaking it across multiple lines: place the fetch opening on the
first line, move the URL string to the next line with proper indentation, move
the options object (containing method, headers, and body properties) to the next
line, and place the closing parentheses and semicolon on the final line to
conform to the 120-character line width requirement.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 10177ddb-e2e4-4cc2-bc03-d79401074dc9
📒 Files selected for processing (2)
docs/.vitepress/config.mtsdocs/api-reference/project/create-project-with-template.md
|
|
||
| <div class="params-section"> | ||
|
|
||
| ### Path Parameters |
There was a problem hiding this comment.
Fix heading hierarchy: use h2 instead of h3 for main sections.
The document jumps from h1 (# Create project with template) directly to h3 (### Path Parameters), skipping the h2 level. Per markdown best practices and the static analysis flag (MD001), section headings should increment by one level at a time.
Change ### Path Parameters, ### Body Parameters, and ### Scopes to ## Path Parameters, ## Body Parameters, and ## Scopes.
Also applies to: 36-36, 81-81
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 21-21: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/api-reference/project/create-project-with-template.md` at line 21, The
markdown document has incorrect heading hierarchy, jumping from h1 directly to
h3 and skipping the h2 level. Change the heading level for the main section
headings "Path Parameters", "Body Parameters", and "Scopes" from h3 (###) to h2
(##) to ensure proper hierarchical progression and comply with markdown best
practices.
Source: Linters/SAST tools
| ```javascript | ||
| const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/projects/templates/use/", { | ||
| method: "POST", | ||
| headers: { | ||
| "X-API-Key": "your-api-key", | ||
| "Content-Type": "application/json", | ||
| }, | ||
| body: JSON.stringify({ | ||
| template_id: "7a2d3972-80a5-4ac5-8bb5-03026671826a", | ||
| name: "Mobile App Revamp", | ||
| identifier: "MAR", | ||
| description: "Project created from the Agile Project Setup template", | ||
| network: 2, | ||
| project_lead: "0d8d8869-3ed1-4fb4-b5c4-ff672888f5e2", | ||
| }), | ||
| }); | ||
| const data = await response.json(); | ||
| ``` |
There was a problem hiding this comment.
Wrap long JavaScript fetch URL to stay within 120-character line width.
Line 135 exceeds the 120-character limit per Prettier guidelines. The fetch URL + opening brace should be split onto multiple lines.
✨ Proposed fix for line wrapping
<template `#javascript`>
```javascript
-const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/projects/templates/use/", {
+const response = await fetch(
+ "https://api.plane.so/api/v1/workspaces/my-workspace/projects/templates/use/",
+ {
method: "POST",
headers: {
"X-API-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
template_id: "7a2d3972-80a5-4ac5-8bb5-03026671826a",
name: "Mobile App Revamp",
identifier: "MAR",
description: "Project created from the Agile Project Setup template",
network: 2,
project_lead: "0d8d8869-3ed1-4fb4-b5c4-ff672888f5e2",
}),
-});
+ },
+);
const data = await response.json();
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @docs/api-reference/project/create-project-with-template.md around lines 134
- 151, The fetch function call with the long URL exceeds the 120-character line
width limit. Refactor the const response await fetch statement by breaking it
across multiple lines: place the fetch opening on the first line, move the URL
string to the next line with proper indentation, move the options object
(containing method, headers, and body properties) to the next line, and place
the closing parentheses and semicolon on the final line to conform to the
120-character line width requirement.
</details>
<!-- fingerprinting:phantom:triton:mongoose -->
<!-- cr-comment:v1:fecfd93224ce5bd563fd781d -->
_Source: Coding guidelines_
<!-- This is an auto-generated comment by CodeRabbit -->
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2 participants
Summary
POST /api/v1/workspaces/{workspace_slug}/projects/templates/use/endpoint introduced in plane-ee#7644Test plan
/api-reference/project/create-project-with-template🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation