There are 2 updates, 1 comment.
 
 
Release Notes Application / cid:jira-generated-image-avatar-1e708a6b-da15-4fae-bac4-72d1406768df RN-115 Closed

Add REST endpoints to create and list release notes and changes

 
View issue   ·   Add comment
 

2 updates

 
cid:jira-generated-image-avatar-b6b00577-e861-4bf8-b309-96641d7fc2ff Changes by Vincent Massol on 09/Sep/26 16:53
 
Resolution: Fixed
Status: Reopened Closed
 
 

1 comment

 
cid:jira-generated-image-avatar-b6b00577-e861-4bf8-b309-96641d7fc2ff Vincent Massol on 09/Sep/26 16:50
 

Before/after on a real wiki: the wiki a Docker IT run leaves behind, restarted twice with only the application-releasenotes-rest jar swapped in place (once as master has it, once with the fix). The wiki has EvidenceProduct configured as its default product; each POST carries neither a product nor an importance.

Before

POST /rest/wikis/xwiki/releasenotes                            {"version":"2.0"}
{
    "product": null,
    "version": "2.0",
    "date": null,
    "released": false,
    "template": null,
    "reference": "ReleaseNotes.Data.EvidenceProduct.2\\.0.WebHome"
}

POST /rest/wikis/xwiki/releasenotes/EvidenceProduct/2.0/changes {"title":"A change posted without an importance"}
{
    "title": "A change posted without an importance",
    "summary": null,
    "description": null,
    "audience": null,
    "importance": null,
    "category": null,
    "screenshots": null,
    "product": "EvidenceProduct",
    "version": "2.0",
    "reference": "ReleaseNotes.Data.EvidenceProduct.2\\.0.Entry001.WebHome"
}

what those two calls actually stored:
  note   product    = EvidenceProduct     <- the answer said null
  change importance = 1                   <- the answer said null
  change audience   = user                <- the answer said null

After

POST /rest/wikis/xwiki/releasenotes                            {"version":"1.0"}
{
    "product": "EvidenceProduct",
    "version": "1.0",
    "date": null,
    "released": false,
    "template": null,
    "reference": "ReleaseNotes.Data.EvidenceProduct.1\\.0.WebHome"
}

POST /rest/wikis/xwiki/releasenotes/EvidenceProduct/1.0/changes {"title":"A change posted without an importance"}
{
    "title": "A change posted without an importance",
    "summary": "",
    "description": "",
    "audience": "user",
    "importance": "medium",
    "category": "",
    "screenshots": [],
    "product": "EvidenceProduct",
    "version": "1.0",
    "reference": "ReleaseNotes.Data.EvidenceProduct.1\\.0.Entry001.WebHome"
}

what those two calls actually stored:
  note   product    = EvidenceProduct     <- the answer agrees
  change importance = 1  (= "medium")     <- the answer agrees
  change audience   = user                <- the answer agrees

The evidence is the response bodies rather than screenshots: this endpoint has no rendered result, and the body is the change.

template stays null on purpose — it is a creation input, not a property a release note keeps, which the field's own javadoc already says.

Pull request: https://github.com/xwiki-contrib/application-releasenotes/pull/61