starlingx
/
integ
Code Issues Proposed changes

Added 'capabilities' attribute to restapi documentation 

The generated restapi documentation was missing the description of the 'capabilities'
attribute.
This change update the documentation templates to add the missing entry
Version changed from 1.9.0 to 1.9.1

Story: 2003068
Task: 23119

Change-Id: I697824ef9ebc4e25d7da935314f6b038f66a9fcb
Signed-off-by: Paul-Emile Element <Paul-Emile.Element@windriver.com>
This commit is contained in:
Paul-Emile Element 2018-08-21 13:33:10 -04:00
parent 671d523b8e
commit 54e1cf85d0
5 changed files with 54 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
restapi-doc/centos/build_srpm.data
View File

@ -3,5 +3,5 @@ COPY_LIST="$SRC_DIR/* \
$CGCS_BASE/downloads/mvn.repo.tgz \
"
TIS_PATCH_VER=26
TIS_PATCH_VER=27
BUILD_IS_SLOW=3

2
restapi-doc/centos/restapi-doc.spec
View File

@ -1,6 +1,6 @@
Summary: RestAPI-Doc
Name: restapi-doc
Version: 1.9.0
Version: 1.9.1
Release: %{tis_patch_ver}%{?_tis_dist}
License: Apache-2.0
Group: devel

2
restapi-doc/restapi-doc/Makefile
View File

@ -1,5 +1,5 @@
# increment this every release
API_VERSION := "1.9.0"
API_VERSION := "1.9.1"
build:
@git status > /dev/null ; \

5
restapi-doc/restapi-doc/README.mvn_cache
View File

@ -5,11 +5,10 @@ Steps to produce mvn.repo.tgz [Maven cache]
cd $MY_REPO/stx/stx-integ/restapi-doc/restapi-doc
cp Makefile Makefile.backup
cp Makefile.mvn_cache Makefile
build_srpms restapi-doc
build-srpms restapi-doc
mock -r $MY_BUILD_CFG_STD "FILE_NAME_TO_THE_BUILT_SRPM"
mock -r $MY_BUILD_CFG_STD --copyout /builddir/build/BUILD/restapi-doc-1.6.0/mvn.repo.tgz ~/
mock -r $MY_BUILD_CFG_STD --copyout /builddir/build/BUILD/restapi-doc-1.9.1/mvn.repo.tgz ~/
cp ~/mvn.repo.tgz $MY_REPO/stx/downloads/
cd $MY_REPO/stx/downloads/
# only the first time
# ln -s ../../../downloads/mvn.repo.tgz mvn.repo.tgz

49
restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent
View File

@ -168,6 +168,55 @@
<para>The user-specified location of the cloud system.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="capabilities" style="plain" type="xsd:dictionary" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>System capabilities.</para>
<itemizedlist>
<listitem>
<para>sdn_enabled : (Boolean) Software Defined Networking enabled.</para>
</listitem>
<listitem>
<para>region_config : (Boolean) region selection:</para>
<itemizedlist>
<listitem>
<para>true : Secondary region.</para>
</listitem>
<listitem>
<para>false : Primary region.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>shared_services : Services provided by Primary region.</para>
</listitem>
<listitem>
<para>bm_region : Board Management controller network selection:</para>
<itemizedlist>
<listitem>
<para>External : OAM network.</para>
</listitem>
<listitem>
<para>Internal : Management network.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>cinder_backend : backend selection for Cinder.</para>
</listitem>
<listitem>
<para>vswitch_type : vSwitch selection.</para>
</listitem>
<listitem>
<para>security_feature : Selection of Spectre and Meltdown mitigation options.</para>
</listitem>
<listitem>
<para>https_enabled : (Boolean) selection of https mode for public URLs.</para>
</listitem>
</itemizedlist>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="contact" style="plain" type="xsd:string" >
<wadl:doc xmlns="http://docbook.org/ns/docbook"