starlingx/integ
Code Issues Proposed changes

Merge "SM REST API doc"

Browse Source
This commit is contained in:
Zuul 2018-08-13 17:36:42 +00:00 committed by Gerrit Code Review
commit 390fd5c364
19 changed files with 1117 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
restapi-doc/restapi-doc/api-ref-guides/pom.xml
View File

@ -2,7 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<!--
Copyright (c) 2014 Wind River Systems, Inc.
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
@ -143,7 +143,17 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilenameBase>api-ref-nfv-vim-v1</pdfFilenameBase>
</configuration>
</execution>
<execution>
<id>os-api-ref-smapi-v1</id>
<goals>
<goal>generate-pdf</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>bk-api-ref-smapi-v1.xml</includes>
<pdfFilenameBase>api-ref-smapi-v1</pdfFilenameBase>
</configuration>
</execution>
</executions>
<configuration>
<webhelpDirname>api-ref-guides</webhelpDirname>

57
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref-smapi-v1.xml Normal file
View File

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE book[
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
<!ENTITY plusmn "&#xB1;">
<!ENTITY nbsp "&#160;">
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
]>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-sysinv-pdf">
<info>
<title>Service Management API v1</title>
<titleabbrev>API Reference</titleabbrev>
<author>
<personname>
<firstname/>
<surname/>
</personname>
<affiliation>
<orgname>Wind River</orgname>
</affiliation>
</author>
<copyright>
<year>2018</year>
<holder>Wind River</holder>
</copyright>
<productname>Titanium Cloud</productname>
<pubdate/>
<legalnotice role="apache2">
<annotation>
<remark>Copyright details are filled in by the
template.</remark>
</annotation>
</legalnotice>
</info>
<!-- <xi:include href="preface.xml"/>-->
<xi:include
href="../../api-ref/src/docbkx/ch_smapi-v1.xml"/>
</book>

3
restapi-doc/restapi-doc/api-ref-guides/src/bk-api-ref.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
@ -48,4 +48,5 @@ SPDX-License-Identifier: Apache-2.0
<xi:include href="../../api-ref/src/docbkx/ch_patching-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_nfv-vim-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_dcmanager-api-v1.xml"/>
<xi:include href="../../api-ref/src/docbkx/ch_smapi-v1.xml"/>
</book>

24
restapi-doc/restapi-doc/api-ref/pom.xml
View File

@ -2,7 +2,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
@ -65,6 +65,17 @@ SPDX-License-Identifier: Apache-2.0
<pdfFilename>bk-sysinv-api-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>sm-api-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-smapi-v1.xml</includes>
<pdfFilename>bk-sm-api-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-dcmanager-api-v1</id>
<goals>
@ -141,6 +152,17 @@ SPDX-License-Identifier: Apache-2.0
<includes>api-ref-nfv-vim-v1.xml</includes>
<pdfFilename>bk-api-ref-nfv-vim-v1</pdfFilename>
</configuration>
</execution>
<execution>
<id>os-api-ref-smapi-v1</id>
<goals>
<goal>generate-html</goal>
</goals>
<phase>generate-sources</phase>
<configuration>
<includes>api-ref-smapi-v1.xml</includes>
<pdfFilename>bk-api-ref-smapi-v1</pdfFilename>
</configuration>
</execution>
<!-- Configuration for OpenStack API References (pdf) -->
<!-- see ../api-ref-guides/pom.xml -->

30
restapi-doc/restapi-doc/api-ref/src/docbkx/api-ref-smapi-v1.xml Normal file
View File

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0"
xml:id="api.openstack.org-smapi-v1" status="CURRENT">
<info>
<title>Titanium Service Management API v1</title>
<copyright>
<year>2018</year>
<holder>Wind River</holder>
</copyright>
<legalnotice role="apache2">
<para/>
</legalnotice>
<annotation>
<xi:include href="itemizedlist-service-list.xml"/>
</annotation>
</info>
<xi:include href="ch_smapi-v1.xml"/>
</book>

104
restapi-doc/restapi-doc/api-ref/src/docbkx/ch_smapi-v1.xml Normal file
View File

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:linkend="http://www.w3.org/1999/linkend"
xmlns:xref="http://www.w3.org/1999/xref"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
version="5.0-extension RackBook-2.0" xml:id="smapi-v1"
role="api-reference">
<title>SM API v1</title>
<para> Interact with Service Management </para>
<para>The typical port used for the SM REST API is 7777.
However, proper technique would be to look up the smapi service endpoint in Keystone.</para>
<!--*******************************************************-->
<!-- API VERSIONS -->
<!--*******************************************************-->
<section xml:id="versions-smapi-v1">
<title>API versions</title>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#versions">
<wadl:method href="#listVersions-smapi-v1"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#version">
<wadl:method href="#showVersionDetails-smapi-v1"/>
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICES -->
<!--*******************************************************-->
<section xml:id="smapi-services-v1">
<title>Services</title>
<para>These APIs allow the display of the services running
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#services">
<wadl:method href="#smlistServices"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#service_id">
<wadl:method href="#smgetService" />
</wadl:resource>
<!--<wadl:resource-->
<!--href="../wadls/sm-api/v1/sm-api-v1.wadl#service_name">-->
<!--<wadl:method href="#modifyService"/>-->
<!--</wadl:resource>-->
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICE NODES -->
<!--*******************************************************-->
<section xml:id="smapi-service-nodes-v1">
<title>Service Nodes</title>
<para>These APIs allow the display of the service nodes
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicenodes">
<wadl:method href="#smlistServiceNodes"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#node_id">
<wadl:method href="#smgetServiceNode" />
</wadl:resource>
</wadl:resources>
</section>
<!--*******************************************************-->
<!-- SERVICE GROUPS -->
<!--*******************************************************-->
<section xml:id="smapi-services-groups-v1">
<title>Service Groups</title>
<para>These APIs allow the display of the service groups
and their attributes</para>
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup">
<wadl:method href="#smlistServiceGroups"/>
</wadl:resource>
<wadl:resource
href="../wadls/sm-api/v1/sm-api-v1.wadl#servicegroup_id">
<wadl:method href="#smgetServiceGroup" />
</wadl:resource>
</wadl:resources>
</section>
</chapter>

6
restapi-doc/restapi-doc/api-ref/src/docbkx/itemizedlist-service-list.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2014-2017 Wind River Systems, Inc.
Copyright (c) 2014-2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
@ -42,4 +42,8 @@ SPDX-License-Identifier: Apache-2.0
<para><link xlink:href="api-ref-nfv-vim-v1.html">Titanium NFV VIM Service
API v1</link></para>
</listitem>
<listitem>
<para><link xlink:href="api-ref-smapi-v1.html">Titanium SM API Service
API v1</link></para>
</listitem>
</itemizedlist>

81
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_group_list-response.json Normal file
View File

@ -0,0 +1,81 @@
{
"sm_servicegroup":[
{
"status":"",
"name":"controller",
"service_group_name":"web-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":1,
"condition":"",
"uuid":"e3aa5e50-030b-4ab6-a339-929f0be50e5d"
},
{
"status":"",
"name":"controller",
"service_group_name":"directory-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":2,
"condition":"",
"uuid":"f7b01783-ea3d-44b8-8dd3-9a0c4a1cae9d"
},
{
"status":"",
"name":"controller",
"service_group_name":"patching-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":3,
"condition":"",
"uuid":"f64bc693-62fa-4f31-b96e-9851c42669ec"
},
{
"status":"",
"name":"controller",
"service_group_name":"vim-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":4,
"condition":"",
"uuid":"e7dab99d-7bdc-4756-b8b3-b069e7b26e0d"
},
{
"status":"",
"name":"controller",
"service_group_name":"cloud-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":5,
"condition":"",
"uuid":"149e9f4e-13ba-4d91-9e0e-09905073fda6"
},
{
"status":"",
"name":"controller",
"service_group_name":"controller-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":6,
"condition":"",
"uuid":"54d46994-9c0e-43bd-8d83-be7396f04f70"
},
{
"status":"",
"name":"controller",
"service_group_name":"oam-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":7,
"condition":"",
"uuid":"f7b532bf-0dc0-41bd-b38a-75b7747da754"
}
]
}

11
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_group_show-response.json Normal file
View File

@ -0,0 +1,11 @@
{
"status":"",
"name":"controller",
"service_group_name":"oam-services",
"node_name":"controller-1",
"state":"active",
"desired_state":"active",
"id":7,
"condition":"",
"uuid":"f7b532bf-0dc0-41bd-b38a-75b7747da754"
}

39
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_list-response.json Normal file
View File

@ -0,0 +1,39 @@
{
"services":[
{
"status":"",
"state":"enabled-active",
"id":5,
"desired_state":"enabled-active",
"name":"drbd-cgcs"
},
{
"status":"",
"state":"enabled-active",
"id":3,
"desired_state":"enabled-active",
"name":"drbd-pg"
},
{
"status":"",
"state":"enabled-active",
"id":4,
"desired_state":"enabled-active",
"name":"drbd-rabbit"
},
{
"status":"",
"state":"enabled-active",
"id":2,
"desired_state":"enabled-active",
"name":"management-ip"
},
{
"status":"",
"state":"enabled-active",
"id":1,
"desired_state":"enabled-active",
"name":"oam-ip"
}
]
}

20
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_node_list-response.json Normal file
View File

@ -0,0 +1,20 @@
{
"nodes":[
{
"administrative_state":"unlocked",
"ready_state":"disabled",
"name":"controller-0",
"operational_state":"disabled",
"availability_status":"unknown",
"id":2
},
{
"administrative_state":"unlocked",
"ready_state":"enabled",
"name":"controller-1",
"operational_state":"enabled",
"availability_status":"available",
"id":1
}
]
}

8
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_node_show-response.json Normal file
View File

@ -0,0 +1,8 @@
{
"administrative_state":"unlocked",
"ready_state":"enabled",
"name":"controller-1",
"operational_state":"enabled",
"availability_status":"available",
"id":1
}

73
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_parameter_list-response.json Normal file
View File

@ -0,0 +1,73 @@
{
"parameters":[
{
"uuid":"7694eca1-21e0-4998-bf2c-15f71b3bddc5",
"links":[
{
"href":"http://10.10.10.2:6385/v1/parameters/7694eca1-21e0-4998-bf2c-15f71b3bddc5",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/parameters/7694eca1-21e0-4998-bf2c-15f71b3bddc5",
"rel":"bookmark"
}
],
"section":"assignment",
"value":"keystone.assignment.backends.sql.Assignment",
"service":"identity",
"name":"driver"
},
{
"uuid":"5eeebd50-4809-4d2e-b4ce-1acd9cfeadab",
"links":[
{
"href":"http://10.10.10.2:6385/v1/parameters/5eeebd50-4809-4d2e-b4ce-1acd9cfeadab",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/parameters/5eeebd50-4809-4d2e-b4ce-1acd9cfeadab",
"rel":"bookmark"
}
],
"section":"identity",
"value":"keystone.identity.backends.sql.Identity",
"service":"identity",
"name":"driver"
},
{
"uuid":"b84378ae-6e0a-48f0-b394-f8a519fc14f4",
"links":[
{
"href":"http://10.10.10.2:6385/v1/parameters/b84378ae-6e0a-48f0-b394-f8a519fc14f4",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/parameters/b84378ae-6e0a-48f0-b394-f8a519fc14f4",
"rel":"bookmark"
}
],
"section":"resource",
"value":"keystone.resource.backends.sql.Resource",
"service":"identity",
"name":"driver"
},
{
"uuid":"6634285f-428e-4ebe-becd-cbb0ab7f30ad",
"links":[
{
"href":"http://10.10.10.2:6385/v1/parameters/6634285f-428e-4ebe-becd-cbb0ab7f30ad",
"rel":"self"
},
{
"href":"http://10.10.10.2:6385/parameters/6634285f-428e-4ebe-becd-cbb0ab7f30ad",
"rel":"bookmark"
}
],
"section":"role",
"value":"keystone.assignment.role_backends.sql.Role",
"service":"identity",
"name":"driver"
}
]
}

20
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_parameter_show-response.json Normal file
View File

@ -0,0 +1,20 @@
{
"uuid":"fd5e5e4c-2723-430a-b162-b06b49d94313",
"links":[
{
"href":"http://192.168.204.2:6385/v1/parameters/fd5e5e4c-2723-430a-b162-b06b49d94313",
"rel":"self"
},
{
"href":"http://192.168.204.2:6385/parameters/fd5e5e4c-2723-430a-b162-b06b49d94313",
"rel":"bookmark"
}
],
"section":"identity",
"updated_at":"2015-12-23T19:07:41.257052+00:00",
"value":"keystone.identity.backends.sql.Identity",
"service":"identity",
"created_at":"2015-12-23T18:54:53.676200+00:00",
"name":"driver"
}

7
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/service_show-response.json Normal file
View File

@ -0,0 +1,7 @@
{
"status":"",
"state":"enabled-active",
"id":1,
"desired_state":"enabled-active",
"name":"oam-ip"
}

24
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/smapi-versions-response.json Normal file
View File

@ -0,0 +1,24 @@
{
"default_version": {
"id": "v1",
"links": [
{
"href": "http://10.10.10.2:7777/v1/",
"rel": "self"
}
]
},
"version": [
{
"id": "v1",
"links": [
{
"href": "http://10.10.10.2:7777/v1/",
"rel": "self"
}
]
}
],
"name": "System Management API",
"description": "System Management API from Wind River"
}

59
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/api_samples/versionv1-get-response.json Normal file
View File

@ -0,0 +1,59 @@
{
"links": [
{
"href": "http://10.10.10.2:7777/v1/",
"rel": "self"
}
],
"id": "v1",
"servicenode": [
{
"href": "http://10.10.10.2:7777/v1/servicenode/",
"rel": "self"
},
{
"href": "http://10.10.10.2:7777/servicenode/",
"rel": "bookmark"
}
],
"services": [
{
"href": "http://10.10.10.2:7777/v1/services/",
"rel": "self"
},
{
"href": "http://10.10.10.2:7777/services/",
"rel": "bookmark"
}
],
"sm_sda": [
{
"href": "http://10.10.10.2:7777/v1/sm_sda/",
"rel": "self"
},
{
"href": "http://10.10.10.2:7777/sm_sda/",
"rel": "bookmark"
}
],
"nodes": [
{
"href": "http://10.10.10.2:7777/v1/nodes/",
"rel": "self"
},
{
"href": "http://10.10.10.2:7777/nodes/",
"rel": "bookmark"
}
],
"service_groups": [
{
"href": "http://10.10.10.2:7777/v1/service_groups/",
"rel": "self"
},
{
"href": "http://10.10.10.2:7777/service_groups/",
"rel": "bookmark"
}
]
}

244
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/common.ent Normal file
View File

@ -0,0 +1,244 @@
<!--
A collection of common faults, these are pretty much expected
in every request.
-->
<!ENTITY commonFaults
'
<response xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:computeFault"/>
<representation mediaType="application/json"/>
</response>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults on GET
-->
<!ENTITY getFaults
'
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults on POST/PUT
-->
<!ENTITY postPutFaults
'
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY rebootFaults
'<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Faults that can occur when we are building servers or images.
-->
<!ENTITY buildFaults
'
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
<representation mediaType="application/json"/>
</response>
'>
<!--
Holds build in progress which occurs when an operation fails
because the server is in the process of being built.
-->
<!ENTITY inProgressFault
'
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
<representation mediaType="application/json"/>
</response>
'>
<!-- COMMON List/Show Parameters -->
<!ENTITY commonListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uuid" style="plain" type="csapi:UUID" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The universally unique identifier for this object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>For convenience, resources contain links to themselves.
This allows a client to easily obtain rather than construct
resource URIs. The following types of link relations are
associated with resources: a self link containing a versioned
link to the resource, and a bookmark link containing a permanent
link to a resource that is appropriate for long term storage.</para>
</wadl:doc>
</param>
'>
<!-- Service Node List/Show Parameters -->
<!ENTITY serviceNodeListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="administrative_state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>Administrative state of the node.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ready_state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The operational state of the node.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the node.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="operational_state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The operational state of the node</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_status" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The availability status of the node.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The id of the node.</para>
</wadl:doc>
</param>
'>
<!-- Service Group List/Show Parameters -->
<!ENTITY serviceGroupListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The type of host that the service is running on.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_group_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the service group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="node_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the node that the service is running on.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The state of the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uuid" style="plain" type="csapi:UUID" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The uuid of the service group.</para>
</wadl:doc>
</param>
'>
<!-- Service List/Show Parameters -->
<!ENTITY serviceListShowParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The operational state of the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" type="xsd:integer" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The id of the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="desired_state" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The desired state of the service</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the service.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="node_name" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The name of the host which the service is running on.</para>
</wadl:doc>
</param>
'>
<!-- Useful for describing APIs -->
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>

298
restapi-doc/restapi-doc/api-ref/src/wadls/sm-api/v1/sm-api-v1.wadl Normal file
View File

@ -0,0 +1,298 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018 Wind River Systems, Inc.
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE application [<!ENTITY % common SYSTEM "common.ent">
%common;]>
<application
xmlns="http://wadl.dev.java.net/2009/02"
xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
>
<!--*******************************************************-->
<!-- RESOURCES -->
<!--*******************************************************-->
<resources base="https://windriver.com/sm-api/" xml:id="smapi-v1">
<!-- / -->
<resource id="versions" path="//">
<method href="#listVersions-smapi-v1"/>
</resource>
<!-- /v1 -->
<resource id="version" type="#VersionDetails" path="//v1">
<!-- /v1/services -->
<resource id="services" path="services">
<method href="#smlistServices"/>
<!-- /v1/services/{service_id} -->
<resource id="service_id" path="{service_id}" >
<param name="service_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing service. </para>
</wadl:doc>
</param>
<method href="#smgetService"/>
</resource>
<!-- /v1/services/{service_name} -->
<resource id="service_name" path="{service_name}" >
<param name="service_name" style="template" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The name of an existing service. </para>
</wadl:doc>
</param>
<method href="#modifyService"/>
</resource>
</resource>
<!-- /v1/nodes -->
<resource id="servicenodes" path="nodes">
<method href="#smlistServiceNodes"/>
<!-- /v1/nodes/{node_id} -->
<resource id="node_id" path="{node_id}" >
<param name="node_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing node. </para>
</wadl:doc>
</param>
<method href="#smgetServiceNode"/>
</resource>
</resource>
<!-- /v1/service_groups -->
<resource id="servicegroup" path="service_groups">
<method href="#smlistServiceGroups"/>
<!-- /v1/service_groups/{servicegroup_id} -->
<resource id="servicegroup_id" path="{servicegroup_id}" >
<param name="servicegroup_id" style="template" required="true" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>The unique identifier of an existing service group. </para>
</wadl:doc>
</param>
<method href="#smgetServiceGroup"/>
</resource>
</resource>
</resource>
</resources>
<!--*******************************************************-->
<!-- RESOURCE TYPES -->
<!--*******************************************************-->
<resource_type id="VersionDetails">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Version details">
<para>API version details.</para>
</wadl:doc>
<method href="#showVersionDetails-sm-api-v1"/>
</resource_type>
<!--*******************************************************-->
<!-- METHODS -->
<!--*******************************************************-->
<!-- ..................................................... -->
<!-- .. Versions .. -->
<!-- ..................................................... -->
<method name="GET" id="listVersions-smapi-v1">
<wadl:doc xml:lang="EN" title="List API versions" xmlns="http://docbook.org/ns/docbook">
<para role="shortdesc">Lists information about all Titanium Cloud SM API versions.</para>
</wadl:doc>
<response status="200 300">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/smapi-versions-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="showVersionDetails-smapi-v1">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show API v1 details">
<para role="shortdesc">Shows details for SM API v1.</para>
</wadl:doc>
<response status="200 203">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/versionv1-get-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Services .. -->
<!-- ..................................................... -->
<method name="GET" id="smlistServices">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List services">
<para role="shortdesc">List all services running.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="services" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of services.</para>
</wadl:doc>
</param>
&serviceListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="smgetService">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service">
<para role="shortdesc">Shows the attributes of a specific service.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Nodes .. -->
<!-- ..................................................... -->
<method name="GET" id="smlistServiceNodes">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List nodes">
<para role="shortdesc">List all controller nodes in the system.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="nodes" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of controller nodes.</para>
</wadl:doc>
</param>
&serviceNodeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_node_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="smgetServiceNode">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show node">
<para role="shortdesc">Shows the attributes of a specific node.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceNodeListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_node_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<!-- ..................................................... -->
<!-- .. Service Group .. -->
<!-- ..................................................... -->
<method name="GET" id="smlistServiceGroups">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="List service groups">
<para role="shortdesc">List all service groups in the system.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service_groups" style="plain" type="xsd:list" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>The list of service groups.</para>
</wadl:doc>
</param>
&serviceGroupListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_group_list-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
<method name="GET" id="smgetServiceGroup">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show service group">
<para role="shortdesc">Shows the attributes of a specific service group.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/xml">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
</wadl:doc>
&serviceGroupListShowParameters;
</representation>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="api_samples/service_group_show-response.json"/>
</wadl:doc>
</representation>
</response>
&commonFaults; &getFaults;
</method>
</application>