[DOCSW-615] docs: refresh API reference and add new endpoints#245
Open
[DOCSW-615] docs: refresh API reference and add new endpoints#245
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedToo many files! This PR contains 216 files, which is 66 over the limit of 150. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (216)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs |
iam-vipin
changed the title
|
Linked to Plane Work Item(s) This comment was auto-generated by Plane |
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
2 participants
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.
Description
The update includes a full pass across
docs/api-reference/to normalize endpoint paths, path parameter names, request/response examples, scopes, and status codes to the latest schema-backed format already used in the docs site.Key changes included in this PR:
/work-items/,/work-item-types/, and/project-members/, and corrected path placeholder usage to match the literal routes shown in the schema and local API.docs/.vitepress/config.mtsso all newly added pages are discoverable in navigation.workspaces.members:writescope todocs/dev-tools/build-plane-app/oauth-scopes.md.Type of Change
Screenshots and Media (if applicable)
Screen.Recording.2026-03-16.at.6.14.33.PM.mov
References
schema.yml