dashboard/xapp-obrd-client/README.md

   1 # Xapp Onboarder Client Generator
   2
   3 This project generates a REST client library from the OpenAPI specification
   4 file obtained from the it/dev xapp_onboarder project, available here as a git
   5 submodule with a pinned version, and packages it in a jar.
   6
   7 ## Eclipse and STS Users
   8
   9 The source folder should be generated automatically by the Swagger Codegen maven
  10 plugin and should also appear on the build path in Eclipse/STS, but if not,
  11 follow these steps:
  12
  13 1. Generate the code using maven:
  14     mvn install
  15 2. Add this folder to the project build path:
  16     target/generated-sources/swagger/src/main/java
  17
  18 ## License
  19
  20 Copyright (C) 2020 AT&T Intellectual Property & Nokia. All rights reserved.
  21 Licensed under the Apache License, Version 2.0 (the "License");
  22 you may not use this file except in compliance with the License.
  23 You may obtain a copy of the License at
  24
  25      http://www.apache.org/licenses/LICENSE-2.0
  26
  27 Unless required by applicable law or agreed to in writing, software
  28 distributed under the License is distributed on an "AS IS" BASIS,
  29 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  30 See the License for the specific language governing permissions and
  31 limitations under the License.