"host": "hostname",
"basePath": "/ric/v1",
"paths": {
+ "/config": {
+ "get": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "tags": [
+ "xapp"
+ ],
+ "summary": "Returns the configuration of all xapps",
+ "operationId": "getXappConfigList",
+ "responses": {
+ "200": {
+ "description": "successful query of xApp config",
+ "schema": {
+ "$ref": "#/definitions/XappConfigList"
+ }
+ },
+ "500": {
+ "description": "Internal error"
+ }
+ }
+ }
+ },
"/subscriptions": {
"get": {
"produces": [
},
"/subscriptions/{subscriptionId}": {
"delete": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
"tags": [
"common"
],
}
}
},
+ "ConfigMetadata": {
+ "type": "object",
+ "required": [
+ "xappName",
+ "configType"
+ ],
+ "properties": {
+ "configType": {
+ "description": "The type of the content",
+ "type": "string",
+ "enum": [
+ "json",
+ "xml",
+ "other"
+ ]
+ },
+ "xappName": {
+ "description": "Name of the xApp",
+ "type": "string"
+ }
+ }
+ },
"EventTrigger": {
"type": "object",
"properties": {
}
}
},
+ "SubscriptionInstance": {
+ "type": "object",
+ "required": [
+ "RequestorId",
+ "InstanceId"
+ ],
+ "properties": {
+ "InstanceId": {
+ "type": "integer"
+ },
+ "RequestorId": {
+ "type": "integer"
+ }
+ }
+ },
"SubscriptionList": {
"description": "A list of subscriptions",
"type": "array",
}
},
"SubscriptionResponse": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SubscriptionResponseItem"
- }
- },
- "SubscriptionResponseItem": {
"type": "object",
"required": [
"SubscriptionId",
- "RequestorId",
- "InstanceId"
+ "SubscriptionInstances"
],
"properties": {
- "InstanceId": {
- "type": "integer"
- },
- "RequestorId": {
- "type": "integer"
- },
"SubscriptionId": {
"type": "string"
+ },
+ "SubscriptionInstances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SubscriptionInstance"
+ }
}
}
},
"policy",
"report"
]
+ },
+ "XAppConfig": {
+ "type": "object",
+ "required": [
+ "metadata",
+ "config"
+ ],
+ "properties": {
+ "config": {
+ "description": "Configuration in JSON format",
+ "type": "object"
+ },
+ "metadata": {
+ "$ref": "#/definitions/ConfigMetadata"
+ }
+ }
+ },
+ "XappConfigList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/XAppConfig"
+ }
}
}
}`))
"host": "hostname",
"basePath": "/ric/v1",
"paths": {
+ "/config": {
+ "get": {
+ "produces": [
+ "application/json",
+ "application/xml"
+ ],
+ "tags": [
+ "xapp"
+ ],
+ "summary": "Returns the configuration of all xapps",
+ "operationId": "getXappConfigList",
+ "responses": {
+ "200": {
+ "description": "successful query of xApp config",
+ "schema": {
+ "$ref": "#/definitions/XappConfigList"
+ }
+ },
+ "500": {
+ "description": "Internal error"
+ }
+ }
+ }
+ },
"/subscriptions": {
"get": {
"produces": [
},
"/subscriptions/{subscriptionId}": {
"delete": {
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
"tags": [
"common"
],
}
}
},
+ "ConfigMetadata": {
+ "type": "object",
+ "required": [
+ "xappName",
+ "configType"
+ ],
+ "properties": {
+ "configType": {
+ "description": "The type of the content",
+ "type": "string",
+ "enum": [
+ "json",
+ "xml",
+ "other"
+ ]
+ },
+ "xappName": {
+ "description": "Name of the xApp",
+ "type": "string"
+ }
+ }
+ },
"EventTrigger": {
"type": "object",
"properties": {
}
}
},
+ "SubscriptionInstance": {
+ "type": "object",
+ "required": [
+ "RequestorId",
+ "InstanceId"
+ ],
+ "properties": {
+ "InstanceId": {
+ "type": "integer"
+ },
+ "RequestorId": {
+ "type": "integer"
+ }
+ }
+ },
"SubscriptionList": {
"description": "A list of subscriptions",
"type": "array",
}
},
"SubscriptionResponse": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/SubscriptionResponseItem"
- }
- },
- "SubscriptionResponseItem": {
"type": "object",
"required": [
"SubscriptionId",
- "RequestorId",
- "InstanceId"
+ "SubscriptionInstances"
],
"properties": {
- "InstanceId": {
- "type": "integer"
- },
- "RequestorId": {
- "type": "integer"
- },
"SubscriptionId": {
"type": "string"
+ },
+ "SubscriptionInstances": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SubscriptionInstance"
+ }
}
}
},
"policy",
"report"
]
+ },
+ "XAppConfig": {
+ "type": "object",
+ "required": [
+ "metadata",
+ "config"
+ ],
+ "properties": {
+ "config": {
+ "description": "Configuration in JSON format",
+ "type": "object"
+ },
+ "metadata": {
+ "$ref": "#/definitions/ConfigMetadata"
+ }
+ }
+ },
+ "XappConfigList": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/XAppConfig"
+ }
}
}
}`))