Commit 60e533a3 authored by Spiros Koulouzis's avatar Spiros Koulouzis

re-organize documentation

parent a89338ad
......@@ -72,7 +72,7 @@
<h1 class="page-header">Files and Libraries</h1>
<h3 id="artifact_gwt_json_overlay">GWT JSON Overlay</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p> <p>
The <a href="http://code.google.com/webtoolkit/">Google Web Toolkit</a> JSON Overlay library provides the JSON Overlays that
can be used to access the Web service API for this application.
......@@ -97,7 +97,7 @@
</tbody>
</table>
<h3 id="artifact_java_json_client_library">Java JSON Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The Java client-side library is used to provide the set of Java objects that can be serialized
to/from JSON using <a href="http://jackson.codehaus.org/">Jackson</a>. This is useful for accessing the
......@@ -127,7 +127,7 @@
</tbody>
</table>
<h3 id="artifact_java_xml_client_library">Java XML Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The Java client-side library is used to access the Web service API for this application using Java.
</p>
......@@ -155,7 +155,7 @@
</tbody>
</table>
<h3 id="artifact_js_client_library">JavaScript Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The JavaScript client-side library defines classes that can be (de)serialized to/from JSON.
This is useful for accessing the resources that are published by this application, but only
......@@ -190,7 +190,7 @@
</tbody>
</table>
<h3 id="artifact_php_json_client_library">PHP JSON Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The PHP JSON client-side library defines the PHP classes that can be (de)serialized to/from JSON.
This is useful for accessing the resources that are published by this application, but only
......@@ -219,7 +219,7 @@
</tbody>
</table>
<h3 id="artifact_php_xml_client_library">PHP XML Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The PHP client-side library defines the PHP classes that can be (de)serialized to/from XML.
This is useful for accessing the resources that are published by this application, but only
......@@ -251,7 +251,7 @@
</tbody>
</table>
<h3 id="artifact_ruby_json_client_library">Ruby JSON Client Library</h3>
<p class="lead">Created March 15, 2017</p>
<p class="lead">Created March 22, 2017</p>
<p><p>
The Ruby JSON client-side library defines the Ruby classes that can be (de)serialized to/from JSON.
This is useful for accessing the REST endpoints that are published by this application, but only
......
......@@ -656,74 +656,13 @@ module V1
module Types
# (no documentation provided)
class KeyValueHolder < Nl::Uva::Sne::Drip::Commons::V1::Types::OwnedObject
# the keyValue
attr_accessor :keyValue
# the id
attr_accessor :id
# the json hash for this KeyValueHolder
def to_jaxb_json_hash
_h = super
_h['keyValue'] = keyValue.to_jaxb_json_hash unless keyValue.nil?
_h['id'] = id.to_jaxb_json_hash unless id.nil?
return _h
end
class Type
#initializes this KeyValueHolder with a json hash
def init_jaxb_json_hash(_o)
super _o
if !_o['keyValue'].nil?
_oa = _o['keyValue']
if(_oa.is_a? Hash)
@keyValue = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@keyValue = Hash.from_json(_oa) unless _oa['@class']
elsif (_oa.is_a? Array)
#an array(of hashes hopefully) or scalar
@keyValue = Array.new
_oa.each { | _item |
if ((_item.nil? || _item['@class'].nil?)rescue true)
@keyValue.push Hash.from_json(_item)
else
@keyValue.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
end
}
else
@keyValue = _oa
end
end
if !_o['id'].nil?
_oa = _o['id']
if(_oa.is_a? Hash)
@id = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@id = String.from_json(_oa) unless _oa['@class']
elsif (_oa.is_a? Array)
#an array(of hashes hopefully) or scalar
@id = Array.new
_oa.each { | _item |
if ((_item.nil? || _item['@class'].nil?)rescue true)
@id.push String.from_json(_item)
else
@id.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
end
}
else
@id = _oa
end
end
end
#
PRIVATE = "PRIVATE"
# constructs a KeyValueHolder from a (parsed) JSON hash
def self.from_json(o)
if o.nil?
return nil
else
inst = new
inst.init_jaxb_json_hash o
return inst
end
end
#
PUBLIC = "PUBLIC"
end
end
......@@ -946,13 +885,74 @@ module V1
module Types
# (no documentation provided)
class Type
class KeyValueHolder < Nl::Uva::Sne::Drip::Commons::V1::Types::OwnedObject
#
PRIVATE = "PRIVATE"
# the keyValue
attr_accessor :keyValue
# the id
attr_accessor :id
#
PUBLIC = "PUBLIC"
# the json hash for this KeyValueHolder
def to_jaxb_json_hash
_h = super
_h['keyValue'] = keyValue.to_jaxb_json_hash unless keyValue.nil?
_h['id'] = id.to_jaxb_json_hash unless id.nil?
return _h
end
#initializes this KeyValueHolder with a json hash
def init_jaxb_json_hash(_o)
super _o
if !_o['keyValue'].nil?
_oa = _o['keyValue']
if(_oa.is_a? Hash)
@keyValue = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@keyValue = Hash.from_json(_oa) unless _oa['@class']
elsif (_oa.is_a? Array)
#an array(of hashes hopefully) or scalar
@keyValue = Array.new
_oa.each { | _item |
if ((_item.nil? || _item['@class'].nil?)rescue true)
@keyValue.push Hash.from_json(_item)
else
@keyValue.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
end
}
else
@keyValue = _oa
end
end
if !_o['id'].nil?
_oa = _o['id']
if(_oa.is_a? Hash)
@id = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@id = String.from_json(_oa) unless _oa['@class']
elsif (_oa.is_a? Array)
#an array(of hashes hopefully) or scalar
@id = Array.new
_oa.each { | _item |
if ((_item.nil? || _item['@class'].nil?)rescue true)
@id.push String.from_json(_item)
else
@id.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
end
}
else
@id = _oa
end
end
end
# constructs a KeyValueHolder from a (parsed) JSON hash
def self.from_json(o)
if o.nil?
return nil
else
inst = new
inst.init_jaxb_json_hash o
return inst
end
end
end
end
......@@ -1350,7 +1350,7 @@ module Types
class ProvisionInfo < Nl::Uva::Sne::Drip::Commons::V1::Types::KeyValueHolder
# the cloudCredentialsID
attr_accessor :cloudcloudCredentialsID
attr_accessor :cloudCredentialsID
# the planID
attr_accessor :planID
# the scriptID
......@@ -1363,7 +1363,7 @@ module Types
# the json hash for this ProvisionInfo
def to_jaxb_json_hash
_h = super
_h['cloudcloudCredentialsID'] = cloudcloudCredentialsID.to_jaxb_json_hash unless cloudcloudCredentialsID.nil?
_h['cloudCredentialsID'] = cloudCredentialsID.to_jaxb_json_hash unless cloudCredentialsID.nil?
_h['planID'] = planID.to_jaxb_json_hash unless planID.nil?
_h['scriptID'] = scriptID.to_jaxb_json_hash unless scriptID.nil?
_h['userKeyID'] = userKeyID.to_jaxb_json_hash unless userKeyID.nil?
......@@ -1378,23 +1378,23 @@ module Types
#initializes this ProvisionInfo with a json hash
def init_jaxb_json_hash(_o)
super _o
if !_o['cloudcloudCredentialsID'].nil?
_oa = _o['cloudcloudCredentialsID']
if !_o['cloudCredentialsID'].nil?
_oa = _o['cloudCredentialsID']
if(_oa.is_a? Hash)
@cloudcloudCredentialsID = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@cloudcloudCredentialsID = String.from_json(_oa) unless _oa['@class']
@cloudCredentialsID = EnunciateHelpers::LAMB_CLASS_AWARE.call(_oa) if _oa['@class']
@cloudCredentialsID = String.from_json(_oa) unless _oa['@class']
elsif (_oa.is_a? Array)
#an array(of hashes hopefully) or scalar
@cloudcloudCredentialsID = Array.new
@cloudCredentialsID = Array.new
_oa.each { | _item |
if ((_item.nil? || _item['@class'].nil?)rescue true)
@cloudcloudCredentialsID.push String.from_json(_item)
@cloudCredentialsID.push String.from_json(_item)
else
@cloudcloudCredentialsID.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
@cloudCredentialsID.push EnunciateHelpers::LAMB_CLASS_AWARE.call(_item)
end
}
else
@cloudcloudCredentialsID = _oa
@cloudCredentialsID = _oa
end
end
if !_o['planID'].nil?
......
......@@ -167,7 +167,7 @@ provisoner to request for resources.</p>
}, {
&quot;name&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PUBLIC&quot;,
&quot;type&quot; : &quot;PRIVATE&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
......
......@@ -175,7 +175,7 @@ Accept: application/json
}, {
&quot;name&quot; : &quot;...&quot;,
&quot;id&quot; : &quot;...&quot;,
&quot;type&quot; : &quot;PRIVATE&quot;,
&quot;type&quot; : &quot;PUBLIC&quot;,
&quot;attributes&quot; : {
&quot;property1&quot; : &quot;...&quot;,
&quot;property2&quot; : &quot;...&quot;
......
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -201,7 +201,7 @@
<goal>docs</goal>
</goals>
<configuration>
<docsDir>${project.basedir}/doc</docsDir>
<docsDir>${project.basedir}/../doc</docsDir>
<configFile>enunciate.xml</configFile>
</configuration>
</execution>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment