There is 1 update, 1 comment.
 
 
Change Request Application / cid:jira-generated-image-avatar-ef92d580-3f6b-43c3-9223-e18c4c3e8da2 CRAPP-431 Open

Provide REST endpoints for all the main Change Request features

 
View issue   ยท   Add comment
 

1 update

 
cid:jira-generated-image-avatar-bb44cb79-fcd8-4b2d-b407-538ca7c18ede Changes by Simon Urli on 12/Nov/26 15:17
 
Fix Version: 2.0
 
 

1 comment

 
cid:jira-generated-image-avatar-bb44cb79-fcd8-4b2d-b407-538ca7c18ede Simon Urli on 12/Nov/26 15:14
 

Scope of this issue

This issue will deliver a first set of REST endpoints, focused on the "propose a change" side of Change Request (e.g. the documentation-fixing agent use case): the review and merge steps still happen in the UI. The detailed design is in the linked "Change Request REST API plan".

Covered here:

  • Extraction of the change request edition logic (creation, adding a file change, metadata update, deletion) out of the UI resource handlers into a public Java API, used by both the UI and REST.
  • /rest/wikis/<wiki>/changerequests: list (filters: status, author, changed page; paginated) and create.
  • /rest/wikis/<wiki>/changerequests/<id>: get, update title/description, delete.
  • .../<id>/filechanges: list, get, add a file change (edition, creation, explicit deletion request, translations).
  • .../<id>/status: draft <-> ready for review, close, reopen.
  • Capabilities (can edit/review/merge/delete, mergeable, has conflicts) and links to the allowed next operations in every representation.
  • XML and JSON, Basic auth or session, rights enforced as in the UI.

Not covered here (follow-up issues will be created and linked):

  • Reviews and approvers (including delegate approvers).
  • Merge, rebase and split.
  • Discussions (on the change request and on diff locations).
  • Diff representation of a file change.
  • Attachments in file changes.
  • Exact total count when listing: results are filtered by view right after the query, so only "next" links are provided.
  • The ready for merging and merged statuses can't be set through the status endpoint: the first is computed from approvals, the second will only be reachable through the merge endpoint.