Bug 747489

Summary: RFE: Resolve injections when exposing a topic via HTTP
Product: [Community] PressGang CCMS Reporter: Joshua Wulf <jwulf>
Component: Web-UIAssignee: Matthew Casperson <mcaspers>
Status: CLOSED WONTFIX QA Contact:
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 1.xCC: cbredesen, lcarlon, topic-tool-list
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-10-28 03:51:38 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Joshua Wulf 2011-10-20 03:13:19 UTC 
Skynet currently exposes topics via HTTP. 

These topics are useful for testing and previewing, however when Skynet Injection links are present they may not be valid Docbook xml.

Proposed Solution:

Before passing the topic to the requester via HTTP, Skynet rewrites Inject Links.
Rather than writing them as xrefs, as is normally done, Skynet should write them as [Topic.Title], perhaps with something to indicate that it is an injected link, such as: <literal>Injected: </literal>[Topic.Title].

This will allow individual topics to be downloaded via HTTP as valid Docbook xml.

Background: Currently the sktopictest tool [1] can download, validate, and optionally preview topics from a Skynet instance. However, since Skynet injections potentially result in invalid xml, the validation and preview functionality is unreliable with topics that utilise Skynet injection.

[1] https://svn.devel.redhat.com/repos/ecs/toolkit/sktopictest
Comment 1 Matthew Casperson 2011-10-28 03:51:38 UTC 
I'll add this functionality indirectly via the REST interface. Using the REST interface it will be possible to download the XML belonging to a topic, as well as the details of the topics that it relates to. The calling application can then decide how to deal with the injection points, replacing them with whatever alternative markup they need.

Right now the REST interface doesn't quite supply enough information to do this, but it will soon.

See https://sourceforge.net/p/topicindex/blog/2011/10/this-week-in-skynet-921/ for a look at the REST interface.