projectdoc Toolbox

Imports information from a Maven artifact identified by its artifact coordinates.

Parent
Type
Extension
Since
2.0
Path
rest/projectdoc-maven/1/import/{space-key}/version/{gav}
HTTP Method
POST

The service fetches a artifact created by Maven referenced by {gav} and imports the information to a version page. This makes it easier to automate the export of artifact information to Confluence.

If the page exists, the information is overridden. Otherwise a new document tree is created with the new version document as its root.

If the artifact is a Maven plugin, the Plugin Descriptor information is imported. For this and all other artifacts the POM information the build metadata (if provided as XML) is also imported.

Parameters

The service only provides the HTTP method POST with the following parameters.

space-key

The key of the space the version document is to be written to.

gav

The artifact coordinates (GAV = groupId:artifactId:version) to fetch. The service always downloads the POM artifact any may, dependent of the artifact type, download further artifacts.

 

Only GAV is supported. Users cannot specify the classifier or artifact type.

versioned-title

The query parameter controls whether to create documents with titles that contain the version for uniqueness (true) or to render it to a version agnostic page title (false).