Add Xapp Onboarder client to backend

[portal/ric-dashboard.git] / dashboard / xapp-obrd-client / README.md

diff --git a/dashboard/xapp-obrd-client/README.md b/dashboard/xapp-obrd-client/README.md
new file mode 100644 (file)
index 0000000..edc567f
--- /dev/null
+++ b/dashboard/xapp-obrd-client/README.md
@@ -0,0 +1,31 @@
+# Xapp Onboarder Client Generator
+
+This project generates a REST client library from the OpenAPI specification
+file obtained from the it/dev xapp_onboarder project, available here as a git
+submodule with a pinned version, and packages it in a jar.
+
+## Eclipse and STS Users
+
+The source folder should be generated automatically by the Swagger Codegen maven
+plugin and should also appear on the build path in Eclipse/STS, but if not,
+follow these steps:
+
+1. Generate the code using maven:
+    mvn install
+2. Add this folder to the project build path:
+    target/generated-sources/swagger/src/main/java
+
+## License
+
+Copyright (C) 2020 AT&T Intellectual Property & Nokia. All rights reserved.
+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.