From 54e1cf85d04df0452be95c8a12dd38af7b741596 Mon Sep 17 00:00:00 2001 From: Paul-Emile Element Date: Tue, 21 Aug 2018 13:33:10 -0400 Subject: [PATCH] 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 --- restapi-doc/centos/build_srpm.data | 2 +- restapi-doc/centos/restapi-doc.spec | 2 +- restapi-doc/restapi-doc/Makefile | 2 +- restapi-doc/restapi-doc/README.mvn_cache | 5 +- .../src/wadls/sysinv-api/v1/common.ent | 49 +++++++++++++++++++ 5 files changed, 54 insertions(+), 6 deletions(-) diff --git a/restapi-doc/centos/build_srpm.data b/restapi-doc/centos/build_srpm.data index deff7763a..e74282c78 100644 --- a/restapi-doc/centos/build_srpm.data +++ b/restapi-doc/centos/build_srpm.data @@ -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 diff --git a/restapi-doc/centos/restapi-doc.spec b/restapi-doc/centos/restapi-doc.spec index 11655f56b..c4d18f8f2 100644 --- a/restapi-doc/centos/restapi-doc.spec +++ b/restapi-doc/centos/restapi-doc.spec @@ -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 diff --git a/restapi-doc/restapi-doc/Makefile b/restapi-doc/restapi-doc/Makefile index 05e9fbc6f..a8997f0af 100644 --- a/restapi-doc/restapi-doc/Makefile +++ b/restapi-doc/restapi-doc/Makefile @@ -1,5 +1,5 @@ # increment this every release -API_VERSION := "1.9.0" +API_VERSION := "1.9.1" build: @git status > /dev/null ; \ diff --git a/restapi-doc/restapi-doc/README.mvn_cache b/restapi-doc/restapi-doc/README.mvn_cache index d91e0f804..1e2e235f9 100644 --- a/restapi-doc/restapi-doc/README.mvn_cache +++ b/restapi-doc/restapi-doc/README.mvn_cache @@ -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 diff --git a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent index 9e3047f2b..805bb9a24 100644 --- a/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent +++ b/restapi-doc/restapi-doc/api-ref/src/wadls/sysinv-api/v1/common.ent @@ -168,6 +168,55 @@ The user-specified location of the cloud system. + + + System capabilities. + + + sdn_enabled : (Boolean) Software Defined Networking enabled. + + + region_config : (Boolean) region selection: + + + true : Secondary region. + + + false : Primary region. + + + + + shared_services : Services provided by Primary region. + + + bm_region : Board Management controller network selection: + + + External : OAM network. + + + Internal : Management network. + + + + + cinder_backend : backend selection for Cinder. + + + vswitch_type : vSwitch selection. + + + security_feature : Selection of Spectre and Meltdown mitigation options. + + + https_enabled : (Boolean) selection of https mode for public URLs. + + + +