swagger-sdk.OpenAPI

Class Parser

lucee.Component
    extended by swagger-sdk.OpenAPI.Parser

Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Open API Parser

Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any baseDocumentPath


    • access = public
    • returntype = any
    true false
    any DocumentObject


    • access = public
    • returntype = any
    true false
    any jLoader


    • access = public
    • returntype = any
    • inject = loader@cbjavaloader
    true false
    any schemaType


    • access = public
    • returntype = any
    true false
    any Utils


    • access = public
    • returntype = any
    • inject = OpenAPIUtil@SwaggerSDK
    true false
    any Wirebox


    • access = public
    • returntype = any
    • inject = wirebox
    true false
    Constructor Summary
    init([string APIDocPath])
          Constructor.
    Method Summary
    private any fetchDocumentReference(string $ref)
         Fetches a document $ref object.
    string getBaseDocumentPath()
    string getDocumentObject()
    any getInternalXPath(string XPath)
         Retrieves the value from a nested struc when given an XPath argument.
    string getJLoader()
    any getNormalizedDocument()
         Convenience method to return the fully normalize document.
    string getSchemaType()
    string getUtils()
    string getWirebox()
    private any loadAsLinkedHashMap(string JSONData)
         Loads a linked hash map from a JSON file.
    any parse(struct APIDoc, string XPath='')
         Parses an API Document recursively.
    any parseDocumentReferences(any DocItem)
         Parses API Document $ref notations recursively.
    any setBaseDocumentPath(any baseDocumentPath)
    any setDocumentObject(any DocumentObject)
    any setJLoader(any jLoader)
    any setSchemaType(any schemaType)
    any setUtils(any Utils)
    any setWirebox(any Wirebox)
    private any throwInvalidJSONException(string InvalidContent)
         Multi-use error throw.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init([string APIDocPath])

    Constructor

    Parameters:
    APIDocPath

    Property Detail

    baseDocumentPath

    property any baseDocumentPath

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    DocumentObject

    property any DocumentObject

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    jLoader

    property any jLoader

    Attributes:
    access - public
    required - false
    returntype - any
    inject - loader@cbjavaloader
    serializable - true

    schemaType

    property any schemaType

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Utils

    property any Utils

    Attributes:
    access - public
    required - false
    returntype - any
    inject - OpenAPIUtil@SwaggerSDK
    serializable - true

    Wirebox

    property any Wirebox

    Attributes:
    access - public
    required - false
    returntype - any
    inject - wirebox
    serializable - true

    Method Detail

    fetchDocumentReference

    private any fetchDocumentReference(string $ref)

    Fetches a document $ref object

    Parameters:
    $ref

    getBaseDocumentPath

    public string getBaseDocumentPath()


    getDocumentObject

    public string getDocumentObject()


    getInternalXPath

    public any getInternalXPath(string XPath)

    Retrieves the value from a nested struc when given an XPath argument

    Parameters:
    XPath

    getJLoader

    public string getJLoader()


    getNormalizedDocument

    public any getNormalizedDocument()

    Convenience method to return the fully normalize document


    getSchemaType

    public string getSchemaType()


    getUtils

    public string getUtils()


    getWirebox

    public string getWirebox()


    loadAsLinkedHashMap

    private any loadAsLinkedHashMap(string JSONData)

    Loads a linked hash map from a JSON file

    Parameters:
    JSONData

    parse

    public any parse(struct APIDoc, string XPath='')

    Parses an API Document recursively

    Parameters:
    APIDoc
    XPath

    parseDocumentReferences

    public any parseDocumentReferences(any DocItem)

    Parses API Document $ref notations recursively

    Parameters:
    DocItem

    setBaseDocumentPath

    public any setBaseDocumentPath(any baseDocumentPath)

    Parameters:
    baseDocumentPath

    setDocumentObject

    public any setDocumentObject(any DocumentObject)

    Parameters:
    DocumentObject

    setJLoader

    public any setJLoader(any jLoader)

    Parameters:
    jLoader

    setSchemaType

    public any setSchemaType(any schemaType)

    Parameters:
    schemaType

    setUtils

    public any setUtils(any Utils)

    Parameters:
    Utils

    setWirebox

    public any setWirebox(any Wirebox)

    Parameters:
    Wirebox

    throwInvalidJSONException

    private any throwInvalidJSONException(string InvalidContent)

    Multi-use error throw

    Parameters:
    InvalidContent