X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=api%2Fxapp_rest_api.yaml;h=38a34f960a3e89638ca60f887d310444551c6477;hb=refs%2Fchanges%2F57%2F6157%2F1;hp=f5a6f57c5d75cb8d08191d03943081cc605e9cdf;hpb=9568a2d73b96516b27f54650e309f0d157fb97d9;p=ric-plt%2Fxapp-frame.git

diff --git a/api/xapp_rest_api.yaml b/api/xapp_rest_api.yaml
old mode 100755
new mode 100644
index f5a6f57..38a34f9
--- a/api/xapp_rest_api.yaml
+++ b/api/xapp_rest_api.yaml
@@ -1,7 +1,7 @@
 swagger: '2.0'
 info:
   description: This is the initial REST API for RIC subscription
-  version: 0.0.1
+  version: 0.0.2
   title: RIC subscription
   license:
     name: Apache 2.0
@@ -11,172 +11,271 @@ basePath: /ric/v1
 schemes:
   - http
 paths:
-  /subscriptions:
+  /config:
     get:
-      summary: Returns list of subscriptions
+      summary: Returns the configuration of all xapps
       tags:
-        - "query"
-      operationId: getAllSubscriptions
+        - xapp
+      operationId: getXappConfigList
       produces:
         - application/json
+        - application/xml
       responses:
         '200':
-          description: successful query of subscriptions
+          description: successful query of xApp config
           schema:
-            $ref: '#/definitions/SubscriptionList'
+            $ref: '#/definitions/XappConfigList'
         '500':
           description: Internal error
-  /subscriptions/report:
-    post:
+  /subscriptions:
+    get:
+      summary: Returns list of subscriptions
       tags:
-      - "report"
-      summary: Subscribe a list of X2AP event triggers to receive "REPORT" messages sent by RAN
-      operationId: subscribeReport
-      consumes:
-        - application/json
+        - common
+      operationId: getAllSubscriptions
       produces:
         - application/json
-      parameters:
-        - name: ReportParams
-          in: body
-          description: Subscription report parameters
-          schema:
-            $ref: '#/definitions/ReportParams'
       responses:
-        '201':
-          description: Subscription successfully created
+        '200':
+          description: successful query of subscriptions
           schema:
-            $ref: '#/definitions/SubscriptionResult'
-        '400':
-          description: Invalid input
+            $ref: '#/definitions/SubscriptionList'
         '500':
           description: Internal error
-  /subscriptions/control:
     post:
       tags:
-      - "control"
-      summary: Subscribe and send "CONTROL" message to RAN to initiate or resume call processing in RAN
-      operationId: subscribeControl
+        - common
+      operationId: Subscribe
+      summary: Subscribe a list of X2AP event triggers to receive messages sent by RAN
       consumes:
         - application/json
       produces:
         - application/json
       parameters:
-        - name: ControlParams
+        - name: SubscriptionParams
           in: body
-          description: Subscription control parameters
+          description: Subscription parameters
           schema:
-            $ref: '#/definitions/ControlParams'
+            $ref: '#/definitions/SubscriptionParams'
       responses:
         '201':
           description: Subscription successfully created
           schema:
-            $ref: '#/definitions/SubscriptionResult'
+            $ref: '#/definitions/SubscriptionResponse'
         '400':
           description: Invalid input
         '500':
           description: Internal error
-  /subscriptions/policy:
-    post:
+  '/subscriptions/{subscriptionId}':
+    delete:
       tags:
-      - "policy"
-      summary: Subscribe and send "POLICY" message to RAN to execute a specific POLICY during call processing in RAN after each occurrence of a defined SUBSCRIPTION
-      operationId: subscribePolicy
+        - common
+      summary: Unsubscribe X2AP events from Subscription Manager
+      operationId: Unsubscribe
       consumes:
         - application/json
       produces:
         - application/json
-      parameters:
-        - name: PolicyParams
-          in: body
-          description: Subscription policy parameters
-          schema:
-            $ref: '#/definitions/PolicyParams'
-      responses:
-        '201':
-          description: Subscription successfully created
-          schema:
-            $ref: '#/definitions/SubscriptionResult'
-        '400':
-          description: Invalid input
-        '500':
-          description: Internal error
-  /subscriptions/{subscriptionId}:
-    delete:
-      tags:
-      - "common"
-      summary: Unsubscribe X2AP events from Subscription Manager
-      operationId: Unsubscribe
       parameters:
         - name: subscriptionId
           in: path
-          description: The subscriptionId to be unsubscribed
+          description: The subscriptionId received in the Subscription Response
           required: true
-          type: integer
+          type: string
       responses:
         '204':
           description: Operation done successfully
         '400':
-          description: Invalid requestorId supplied
+          description: Invalid subscriptionId supplied
         '500':
           description: Internal error
 definitions:
-  SubscriptionType:
-    type: string
-    enum:
-      - control
-      - insert
-      - policy
-      - report
-  ReportParams:
+  ConfigMetadata:
     type: object
     required:
-      - RequestorId
-      - EventTriggers
+      - xappName
+      - configType
     properties:
-      RequestorId:
-        type: integer
-      EventTriggers:
-        $ref: '#/definitions/EventTriggerList'
-  EventTrigger:
+      xappName:
+        type: string
+        description: Name of the xApp
+      configType:
+        type: string
+        description: The type of the content
+        enum:
+          - json
+          - xml
+          - other
+  XAppConfig:
     type: object
     required:
-      - InterfaceDirection
-      - ProcedureCode
-      - TypeOfMessage
+      - metadata
+      - config
     properties:
-      InterfaceDirection:
-        type: integer
-      ProcedureCode:
-        type: integer
-      TypeOfMessage:
-        type: integer
-      PlmnId:
+      metadata:
+        $ref: '#/definitions/ConfigMetadata'
+      config:
+        type: object
+        description: Configuration in JSON format
+  XappConfigList:
+    type: array
+    items:
+      $ref: '#/definitions/XAppConfig'
+  ActionDefinition:
+    type: object
+    description: E2SM Octet string. ActionDefinition is an OPTIONAL IE
+    properties:
+      OctetString:
         type: string
-      ENBId:
+  SubsequentAction:
+    description: SubsequentAction is an OPTIONAL IE
+    type: object
+    required:
+      - SubsequentActionType
+      - TimeToWait
+    properties:
+      SubsequentActionType:
+        type: string
+        enum:
+          - continue
+          - wait
+      TimeToWait:
+        type: string
+        enum:
+          - zero
+          - w1ms
+          - w2ms
+          - w5ms
+          - w10ms
+          - w20ms
+          - w30ms
+          - w40ms
+          - w50ms
+          - w100ms
+          - w200ms
+          - w500ms
+          - w1s
+          - w2s
+          - w5s
+          - w10s
+          - w20s
+          - w60s
+  ActionToBeSetup:
+    type: object
+    required:
+      - ActionID
+      - ActionType
+    properties:
+      ActionID:
         type: integer
-  EventTriggerList:
+        minimum: 0
+        maximum: 255
+      ActionType:
+        type: string
+        enum:
+          - insert
+          - policy
+          - report
+      ActionDefinition:
+        $ref: '#/definitions/ActionDefinition'
+      SubsequentAction:
+        $ref: '#/definitions/SubsequentAction'
+  ActionsToBeSetup:
     type: array
     items:
-      $ref: '#/definitions/EventTrigger'
-  SubscriptionResult:
+      $ref: '#/definitions/ActionToBeSetup'
+  EventTriggerDefinition:
+    type: object
+    description: E2SM Octet string
+    properties:
+      OctetString:
+        type: string
+  SubscriptionDetail:
+    type: object
+    required:
+      - XappEventInstanceId
+      - EventTriggers
+      - ActionToBeSetupList
+    properties:
+      XappEventInstanceId:
+        type: integer
+        minimum: 0
+        maximum: 65535
+      EventTriggers:
+        $ref: '#/definitions/EventTriggerDefinition'
+      ActionToBeSetupList:
+        $ref: '#/definitions/ActionsToBeSetup'
+  SubscriptionDetailsList:
     type: array
-    description: A list of unique IDs
     items:
-      type: integer
-  ControlParams:
+      $ref: '#/definitions/SubscriptionDetail'
+  SubscriptionParams:
     type: object
+    required:
+      - ClientEndpoint
+      - Meid
+      - RANFunctionID
+      - SubscriptionDetails
     properties:
-      RequestorId:
+      SubscriptionId:
+       type: string
+       description: Optional subscription ID (Submgr allocates if not given)
+      ClientEndpoint:
+        type: object
+        description: xApp service address and port
+        properties:
+          Host:
+            description: >-
+              xApp service address name like
+              'service-ricxapp-xappname-http.ricxapp'
+            type: string
+          HTTPPort:
+            description: xApp HTTP service address port
+            type: integer
+            minimum: 0
+            maximum: 65535
+          RMRPort:
+            description: xApp RMR service address port
+            type: integer
+            minimum: 0
+            maximum: 65535
+      Meid:
+        type: string
+      RANFunctionID:
         type: integer
-      TBD:
+        minimum: 0
+        maximum: 4095
+      SubscriptionDetails:
+        $ref: '#/definitions/SubscriptionDetailsList'
+  SubscriptionResponse:
+    type: object
+    required:
+      - SubscriptionId
+      - SubscriptionInstances
+    properties:
+      SubscriptionId:
         type: string
-  PolicyParams:
+      SubscriptionInstances:
+        type: array
+        items:
+          $ref: '#/definitions/SubscriptionInstance'
+  SubscriptionInstance:
     type: object
+    required:
+      - XappEventInstanceId
+      - E2EventInstanceId
+      - ErrorCause
     properties:
-      RequestorId:
+      XappEventInstanceId:
+        type: integer
+        minimum: 0
+        maximum: 65535
+      E2EventInstanceId:
         type: integer
-      TBD:
+        minimum: 0
+        maximum: 65535
+      ErrorCause:
+        description: Empty string when no error.
         type: string
   SubscriptionData:
     type: object
@@ -185,12 +284,16 @@ definitions:
         type: integer
       Meid:
         type: string
-      Endpoint:
+      ClientEndpoint:
         type: array
         items:
           type: string
+      SubscriptionInstances:
+        type: array
+        items:
+          $ref: '#/definitions/SubscriptionInstance'
   SubscriptionList:
     type: array
     description: A list of subscriptions
     items:
-       $ref: '#/definitions/SubscriptionData'
\ No newline at end of file
+      $ref: '#/definitions/SubscriptionData'