X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=api%2Fxapp_rest_api.yaml;h=c2e1be0d8b5ccdc5249638524eba8d0037c0b7ed;hb=refs%2Fheads%2Fmaster;hp=2890b90355cf9118a69ca144233be774b514ba05;hpb=1f555883dfe854ff50b26a2e677278360283d88a;p=ric-plt%2Fxapp-frame.git diff --git a/api/xapp_rest_api.yaml b/api/xapp_rest_api.yaml index 2890b90..c2e1be0 100644 --- 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.2 + version: 0.0.4 title: RIC subscription license: name: Apache 2.0 @@ -63,9 +63,13 @@ paths: schema: $ref: '#/definitions/SubscriptionResponse' '400': + description: Not Found + '404': description: Invalid input '500': description: Internal error + '503': + description: Service Unavailable '/subscriptions/{subscriptionId}': delete: tags: @@ -243,6 +247,23 @@ definitions: type: integer minimum: 0 maximum: 4095 + E2SubscriptionDirectives: + description: Optional. If not set Submgr uses its default values + type: object + properties: + E2TimeoutTimerValue: + description: How long time response is waited from E2 node + type: integer + minimum: 1 + maximum: 10 + E2RetryCount: + description: How many times E2 subscription request is retried + type: integer + minimum: 0 + maximum: 10 + RMRRoutingNeeded: + description: Subscription needs RMR route from E2Term to xApp + type: boolean SubscriptionDetails: $ref: '#/definitions/SubscriptionDetailsList' SubscriptionResponse: @@ -262,7 +283,6 @@ definitions: required: - XappEventInstanceId - E2EventInstanceId - - ErrorCause properties: XappEventInstanceId: type: integer @@ -273,8 +293,16 @@ definitions: minimum: 0 maximum: 65535 ErrorCause: - description: Empty string when no error. + description: Descriptive error cause. Empty string when no error. + type: string + ErrorSource: + description: Source of error cause. + type: string + enum: [SUBMGR, RTMGR, DBAAS, ASN1, E2Node] + TimeoutType: + description: Type timeout. xApp should retry if timeout occurs. type: string + enum: [E2-Timeout, RTMGR-Timeout, DBAAS-Timeout] SubscriptionData: type: object properties: