X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=api%2Fappmgr_rest_api.yaml;h=9e7c15b2aa9c5f32719e82e6b7b42cc7cf0cd253;hb=refs%2Fchanges%2F93%2F1893%2F1;hp=afa90f7d6086a1e72f6484eb0397b34a97e6817d;hpb=059775ccd9e7c5482747729890800f7a7d507a94;p=ric-plt%2Fappmgr.git diff --git a/api/appmgr_rest_api.yaml b/api/appmgr_rest_api.yaml index afa90f7..9e7c15b 100644 --- a/api/appmgr_rest_api.yaml +++ b/api/appmgr_rest_api.yaml @@ -1,7 +1,7 @@ swagger: '2.0' info: description: This is a draft API for RIC appmgr - version: 0.1.3 + version: 0.1.7 title: RIC appmgr license: name: Apache 2.0 @@ -9,7 +9,6 @@ info: host: hostname basePath: /ric/v1 schemes: - - https - http paths: /health/alive : @@ -95,7 +94,22 @@ paths: '200': description: successful query of xApps schema: - $ref: '#/definitions/AllXapps' + $ref: '#/definitions/AllDeployedXapps' + '500': + description: Internal error + '/xapps/search': + get: + summary: Returns the list of all deployable xapps + tags: + - xapp + operationId: listAllDeployableXapps + produces: + - application/json + responses: + '200': + description: successful list of deployable xApps + schema: + $ref: '#/definitions/AllDeployableXapps' '500': description: Internal error '/xapps/{xAppName}': @@ -251,7 +265,7 @@ paths: $ref: '#/definitions/ConfigMetadata' responses: '204': - description: Successful deletion of xApp + description: Successful deletion of xApp config '400': description: Invalid parameters supplied '500': @@ -275,8 +289,8 @@ paths: schema: $ref: '#/definitions/subscriptionRequest' responses: - '200': - description: Subscription successful + '201': + description: Subscription successfully created schema: $ref: '#/definitions/subscriptionResponse' '400': @@ -366,7 +380,12 @@ paths: '400': description: Invalid subscription supplied definitions: - AllXapps: + AllDeployableXapps: + type: array + items: + type: string + example: "xapp-dummy" + AllDeployedXapps: type: array items: $ref: '#/definitions/Xapp' @@ -557,4 +576,4 @@ definitions: - deleted - updated xApps: - $ref: '#/definitions/AllXapps' + $ref: '#/definitions/AllDeployedXapps'