Sync from Azure to LF

[ric-plt/resource-status-manager.git] / Swagger / RSM_API.yaml

diff --git a/Swagger/RSM_API.yaml b/Swagger/RSM_API.yaml
new file mode 100644 (file)
index 0000000..c1a71ba
--- /dev/null
+++ b/Swagger/RSM_API.yaml
@@ -0,0 +1,51 @@
+# ========================LICENSE_START=================================
+# O-RAN-SC
+#
+# Copyright (C) 2019 AT&T Intellectual Property and Nokia
+#
+# 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.
+# ========================LICENSE_END===================================
+
+openapi: 3.0.0
+info:
+  title: RSM Service
+  description: RSM Service APIs
+  version: 2.0.5
+servers:
+  - url: 'http://{apiRoot}/v1'
+    variables:
+      apiRoot:
+        default: 'localhost:?'
+paths:
+  /health:
+    get:
+      tags:
+        - Health Check
+      summary: RSM Service Health Check
+      responses:
+        '204':
+          description: OK
+components:
+  schemas:
+    ErrorResponse:
+      type: object
+      required:
+        - errorCode
+        - errorMessage
+      properties:
+        errorCode:
+          type: string
+          description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
+        errorMessage:
+          type: string
+          description: Human readable text