lucee.Componentswagger-sdk.OpenAPI.Document
Copyright Ortus Solutions, Corp, All rights reserved www.ortussolutions.com --- Open API Document Object
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
Document
|
true
|
false
|
|
any
|
jLoader
|
true
|
false
|
|
any
|
Wirebox
|
true
|
false
|
|
any
|
XPath
|
true
|
false
|
Constructor Summary | |
---|---|
init(struct Doc, string XPath='')
Constructor. |
Method Summary | |
---|---|
any
|
asJSON()
Convenience method to return a JSON representation of the normalized document. |
any
|
asStruct()
Convenience method to return a flattened struct of the Document instance. |
any
|
asYAML()
Convenience method to return a YAML string of the normalized document. |
private string
|
convertToYAML()
Converts the entity doc to a YAML string. |
string
|
getDocument()
|
string
|
getJLoader()
|
any
|
getNormalizedDocument([any APIDoc='[runtime expression]'])
Normalizes the document recursively to provide a flattened representation. |
string
|
getWirebox()
|
string
|
getXPath()
|
any
|
locate([string key])
Helper function to locate deeply nested document items. |
any
|
setDocument(any Document)
|
any
|
setJLoader(any jLoader)
|
private void
|
setResourceIds(struct resourceDoc, [string hashPrefix=''])
Sets the resourceId extension of a document path. |
any
|
setWirebox(any Wirebox)
|
any
|
setXPath(any XPath)
|
private any
|
throwForeignObjectTypeException(any UnKnownObject)
Throws a foreign object type exception if detected when normalizing a document. |
any
|
xPath(string XPath)
Convenience methot for setting the XPath of the Document. |
any
|
zoomToXPath()
Zooms this Document instance to the XPath. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
Doc
XPath
Property Detail |
---|
access
- publicrequired
- falsereturntype
- anyserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- loader@cbjavaloaderserializable
- trueaccess
- publicrequired
- falsereturntype
- anyinject
- wireboxserializable
- trueaccess
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Convenience method to return a JSON representation of the normalized document
Convenience method to return a flattened struct of the Document instance
Convenience method to return a YAML string of the normalized document
Converts the entity doc to a YAML string
Normalizes the document recursively to provide a flattened representation
APIDoc
Helper function to locate deeply nested document items
key
Document
jLoader
Sets the resourceId extension of a document path
resourceDoc
hashPrefix
Wirebox
XPath
Throws a foreign object type exception if detected when normalizing a document
UnKnownObject
Convenience methot for setting the XPath of the Document
XPath
Zooms this Document instance to the XPath