This issue has been created
There are 3 updates.
 
 
Release Notes Application / cid:jira-generated-image-avatar-76fec7d0-a60c-4c02-a381-f0132322509d RN-115 Open

Add REST endpoints to create and list release notes and changes

 
View issue   ·   Add comment
 

Issue created

 
cid:jira-generated-image-avatar-2959061b-02d6-4212-99e2-e7c84932963b Vincent Massol created this issue on 08/Sep/26 20:34
 
Summary: Add REST endpoints to create and list release notes and changes
Issue Type: cid:jira-generated-image-avatar-76fec7d0-a60c-4c02-a381-f0132322509d New Feature
Assignee: Unassigned
Components: Application
Created: 08/Sep/26 20:34
Priority: cid:jira-generated-image-static-major-58669dab-e511-4d03-8889-ef84c75502d3 Major
Reporter: Vincent Massol
Description:

Creating a release note or a change from outside the wiki – a script, a CI job, or an agent producing release notes automatically – currently means using the generic XWiki REST API and reproducing the application's internal rules by hand: the short version page name, the Entry### numbering, and the pair of objects every change page must carry.

Expose the Java API of the application over REST so that a correct release note or change can be created in a single call:

  • {{GET /wikis/ {wikiName}/releasenotes[?product=]}} – list the release notes.
    * {{POST /wikis/{wikiName}

    /releasenotes}} – create one; 409 with the existing page reference when it already exists.

  • {{POST /wikis/ {wikiName}/releasenotes/{product}/{version}/changes}} – add a change to it.
    * {{GET /wikis/{wikiName}

    /releasenotes/

    {product}

    /

    {version}

    /changes}} – list its changes, with the usual audience/category/importance/screenshot filters and paging, and an aggregated switch to include the milestones and release candidates the way the release note itself does.

Only creating and listing are covered. Updating a note, marking it released, and editing or deleting a change are deliberately left to the generic XWiki REST API.

The endpoints ship in a new application-releasenotes-rest module, which the application XAR depends on, so installing the Release Notes Application gives you the endpoints.

 
 

3 updates

 
cid:jira-generated-image-avatar-2959061b-02d6-4212-99e2-e7c84932963b Changes by Vincent Massol on 08/Sep/26 20:34
 
Fix Version: 2.7
Version: 2.6
Assignee: Vincent Massol