io.github.mainstringargs.util.doc

Class Documentation2JSONSchema

java.lang.Object

io.github.mainstringargs.util.doc.Documentation2JSONSchema

public class Documentation2JSONSchema
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Documentation2JSONSchema()

Method Summary

Modifier and Type	Method and Description
static void	printAlpacaHTMLWebDocAsJSONSchema(java.lang.String alpacaDocXML) This is a standalone helper method that converts properties HTML copied from the Alpaca docs page into a json schema property list that includes the type and the description.
static void	printPolygonHTMLWebDocAsJSONSchema(java.lang.String polygonDocXML) This is a standalone helper method that converts response schema HTML copied from the Polygon docs page into a json schema property list that includes the type and the description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Documentation2JSONSchema

public Documentation2JSONSchema()

Method Detail

printAlpacaHTMLWebDocAsJSONSchema

public static void printAlpacaHTMLWebDocAsJSONSchema(java.lang.String alpacaDocXML)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     org.xml.sax.SAXException,
                                                     java.io.IOException,
                                                     javax.xml.xpath.XPathExpressionException

This is a standalone helper method that converts properties HTML copied from the Alpaca docs page into a json schema property list that includes the type and the description. It's kinda hacky, but it helps in the generation of JSON POJOs with Javadocs. Must be in the format of a list of:

 <div class="spec-table">
     <div class="spec-row">
     <div class="spec-left"><span class="spec-name">id</span></div>
     <div class="spec-right">
         <div class="spec-type">string<uuid></div>
         <div class="spec-desc">Account ID.</div>
     </div>
     </div>
     ...
 </div>
 

Parameters:

alpacaDocXML - the alpaca doc xml

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

javax.xml.xpath.XPathExpressionException

printPolygonHTMLWebDocAsJSONSchema

public static void printPolygonHTMLWebDocAsJSONSchema(java.lang.String polygonDocXML)
                                               throws javax.xml.parsers.ParserConfigurationException,
                                                      org.xml.sax.SAXException,
                                                      java.io.IOException,
                                                      javax.xml.xpath.XPathExpressionException

This is a standalone helper method that converts response schema HTML copied from the Polygon docs page into a json schema property list that includes the type and the description. It's kinda hacky, but it helps in the generation of JSON POJOs with Javadocs. Must be in the format of a list of:

 <div class="description">
     <div>
         <span class="propLabels">
             <span class="propName propOpt">name</span>
             <span class="propType" title="string">string</span>
         </span>
         <span class="propDesc">Name of the item.</span>
     </div>
     ...
 </div>
 

Parameters:

polygonDocXML - the polygon doc xml

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

javax.xml.xpath.XPathExpressionException