summaryrefslogtreecommitdiffstats
path: root/src/main/resources/swagger.properties.sample
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/resources/swagger.properties.sample')
-rw-r--r--src/main/resources/swagger.properties.sample51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/main/resources/swagger.properties.sample b/src/main/resources/swagger.properties.sample
new file mode 100644
index 0000000..77128e2
--- /dev/null
+++ b/src/main/resources/swagger.properties.sample
@@ -0,0 +1,51 @@
+# Copyright 2017 Huawei Technologies Co., Ltd.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Used to do wwagger configuration.
+# ONAP Service REST API version
+api-version=v1
+
+# ONAP Service REST API swagger document title
+api-title=Swagger REST API
+
+# ONAP Service REST API swagger document description
+api-description=Swagger REST API
+
+# ONAP Service REST API supported protocols
+api-schemas=http,https
+
+# ONAP Service REST API ROOT URI
+api-base-path=/onapapi/
+
+# swagger.json URI on top of api-base-path. so final URI would as follows
+#<api-base-path>/<api-swagger-uri>/swagger.json
+api-swagger-uri=/v1
+
+# Set the root level java package path, where REST API implemented.
+api-rest-package=
+
+# Enables swagger to scan the ROA defining the REST API
+api-rest-package-scan=true
+
+# License details emebeded in generated swagger.json
+api-license=https://wiki.onap.org/display/DW/Apache+2.0+License
+
+# if service-config-file-path does not have api-host-ip and api-host-port,
+# then ip and port defined here will be used as default
+api-host-ip=127.0.0.1
+api-host-port=8480
+
+# Set the below file path to service specific configuration file path
+service-config-file-path=etc/adapterInfo/service.json
+