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