docs: sync API v2 reference with fields param and alias removal - #309
docs: sync API v2 reference with fields param and alias removal#309Program2113 wants to merge 1 commit into
Conversation
Update the v2 reference for current OpenAPI behavior: document ?fields= omit semantics and list deferral, replace path-alias guidance with list identity filters, expand the ?expand= allowlists (cycle/modules and more resources), and correct work-item list/detail shapes (custom_fields is detail-only; cycle_id/module_ids/project_id on reads).
|
@Program2113 is attempting to deploy a commit to the Marketing at Plane Team on Vercel. A member of the Team first needs to authorize it. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
Summary
Updates the API v2 reference on top of #303 to match the current OpenAPI document in
plane-ee(apps/api/plane/api_v2/core/schema/openapi/).What changed
?fields=sparse fieldsets (new)/api-reference/v2/fieldsalltoken, list deferral, detail-only fieldsAlias removal
PROJ-123)name:…,key:…,external:…)?name=,?external_id=) + optional?fields=id?expand=accuracystate,type,parent,assignees,labels,cycle,modulesactor), cycles (owned_by), modules (lead,members)Work item shape fixes
custom_fieldsis detail-only (absent on list rows, notnull)project_id,cycle_id,module_idsproject_idpath segments accept UUID or bare project identifierSource of truth
Verified against
apps/api/plane/api_v2/core/schema/openapi/and the fields-support design in plane-ee.Relation to #303
This PR targets the
docs/api-reference-v2branch so it can be merged into #303 (or cherry-picked). Diff is the single follow-up commit on top of #303.Test plan
/api-reference/v2/fieldsrenders with standard doc layout (not wide API layout)?fields=in v2"custom_fieldskeycycle/modulesfor work items