Versions Compared

Version Old Version 5 New Version 6
Changes made by

Zhe Huang (Felix)

Zhe Huang (Felix)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • messaging: this schema defines the messaging parameters structure

    Code Block
    	    "messaging": {
			"type": "object",
			"$id": "#/properties/messaging",
			"title": "The Messaging Schema",
			"properties": {
				"ports": {
	  	     	   	"$id": "#/properties/messaging/ports",
	  				"type": "array",
	  				"title": "The Ports for Messaging",
					"items":{
	  					"$id": "#/properties/messaging/ports/items",
	  					"type": "object",
	  					"title": "The Item of Port",
	  					"required": [
	  						"name",
	  						"container",
	  						"port"
	  					],
	  					"properties": {
							"name": {
								"$id": "#/properties/messaging/ports/items/name",
								"type": "string",
								"title": "The Name of the Port",
								"default": "App",
								"examples": [
									"App"
								]
							},
							"container": {
								"$id": "#/properties/messaging/ports/items/container",
								"type": "string",
								"title": "The Container of the Port",
								"default": "xapp",
								"examples": [
									"xapp"
								]
							},
							"port": {
								"$id": "#/properties/messaging/ports/items/port",
								"type": "integer",
								"title": "The Port Number",
								"default": 8080,
								"examples": [
									8080
								]
							}
					  	}
					}
				},
				"maxSize": {
					"$id": "#/properties/messaging/maxsize",
					"type": "integer",
					"title": "The Maximum RMR Buffer Size",
					"default": 2072,
					"examples": [
						2072
					]
				},
				"numWorkers": {
					"$id": "#/properties/messaging/numworkers",
					"type": "integer",
					"title": "The Number of RMR workers",
					"default": 1,
					"examples": [
						1
					]
				},
                "txMessages": {
					"$id": "#/properties/messaging/txmessages",
                    "type": "array",
					"title": "The txMessage Types",
                    "items":{
						"$id": "#/properties/messaging/txmessages/item",
						"type": "string",
						"title": "The txMessage Types Item",
						"default": "RIC_SUB",
						"examples": [
							"RIC_SUB"
						]
					}
                },
                "rxMessages": {
					"$id": "#/properties/messaging/rxmessages",
                    "type": "array",
					"title": "The rxMessage Types",
                    "items":{
						"$id": "#/properties/messaging/rxmessages/item",
						"type": "string",
						"title": "The rxMessage Types Item",
						"default": "RIC_SUB",
						"examples": [
							"RIC_SUB"
						]
					}
                },
                "policies": {
					"$id": "#/properties/messaging/policies",
                    "type": "array",
					"title": "The Policies Types",
                    "items":{
						"$id": "#/properties/messaging/policies/item",
						"type": "integer",
						"title": "The Policy Types Item",
						"default": 1,
						"examples": [
							1
						]
					}
                }
			},
            "required": [
                "ports",
		        "maxSize",
				"numWorkers",
				"txMessages",
				"rxMessages",
				"policies"
            ]
				
		},


  • Controls: controls is an xApp specify section. xApp developer shall defines the schema for this section to describe the internal xApp parameter structure. it has a basic structure of 

    Code Block
    		"controls": {
			"type": "object",
			"$id": "#/properties/controls",
			"title": "The Controls Schema",
		},


  • metrics: this schema defines the metrics structure

    Code Block
    		"metrics": {
			"type": "array",
			"$id": "#/properties/metrics",
			"title": "The Metrics Schema",
			"items": {
				"$id": "#/properties/metrics/items",
				"type": "object",
				"title": "The Metrics Items Schema",
				"required": [
					"objectName",
					"objectInstance",
					"name",
					"type",
					"description"
				],
				"properties": {
					"objectName": {
						"$id": "#/properties/metrics/items/objectname",
						"type": "string",
						"title": "The Object Name"
					},
					"objectInstance": {
						"$id": "#/properties/metrics/items/objectinstance",
						"type": "string",
						"title": "The Object Instance"
					},
					"name": {
						"$id": "#/properties/metrics/items/name",
						"type": "string",
						"title": "The Object Name"
					},
					"type": {
						"$id": "#/properties/metrics/items/type",
						"type": "string",
						"title": "The Object Type"
					},
					"description": {
						"$id": "#/properties/metrics/items/description",
						"type": "string",
						"title": "The Object Description"
					}
				}
			}
		}
	}