863713dbc652b7f5a2ae48d0516d76c31de928e9
[nonrtric.git] / r-app-catalogue / README.md
1 # O-RAN-SC Non-RT RIC rAPP Catalogue
2
3 The O-RAN Non-RT RIC rApp Catalogue provides an OpenApi 3.0 REST API for services to register themselves and discover
4 other services.
5
6 **NOTE!** The definition of the REST API is done in the `api/rac-api.json` file. The yaml version of the file is
7 generated during compilation.
8
9 The application is a SpringBoot application generated using the openapitools openapi-generator-maven-plugin.
10
11 To start the application run:
12 `mvn spring-boot:run`
13
14 ## License
15
16 Copyright (C) 2020 Nordix Foundation. All rights reserved.
17 Licensed under the Apache License, Version 2.0 (the "License");
18 you may not use this file except in compliance with the License.
19 You may obtain a copy of the License at
20
21      http://www.apache.org/licenses/LICENSE-2.0
22
23 Unless required by applicable law or agreed to in writing, software
24 distributed under the License is distributed on an "AS IS" BASIS,
25 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26 See the License for the specific language governing permissions and
27 limitations under the License.