Versions Compared

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"
    ],	  	
    				],
    	    					"propertiesdependencies": {
    							"name": {
    								"$id": "#/properties/messaging/ports/items/name",
    								"type": "string",
    								"title": "The Name of the Port"      "txMessages": ["rxMessages", "policies"],
    								  "defaultrxMessages": "App"["txMessages", "policies"],
    								  "examplespolicies": [
    									"App""rxMessages", "txMessages"]
    								]    },
    	  						},"properties": {
    							"containername": {
    								"$id": "#/properties/messaging/ports/items/containername",
    								"type": "string",
    								"title": "The ContainerName of the Port",
    								"default": "xappApp",
    								"examples": [
    									"xappApp"
    								]
    							},
    							"portcontainer": {
    								"$id": "#/properties/messaging/ports/items/portcontainer",
    								"type": "integerstring",
    								"title": "TheThe Container of the Port Number",
    								"default": 8080"xapp",
    								"examples": [
    									8080"xapp"
    								]
    							}
    					  	}
    					},
    				},
    				"maxSizeport": {
    								"$id": "#/properties/messaging/maxsizeports/items/port",
    								"type": "integer",
    								"title": "The Maximum RMR Buffer SizePort Number",
    								"default": 20728080,
    								"examples": [
    						2072			8080
    								]
    							},
    							"numWorkersdescription": {
    								"$id": "#/properties/messaging/numworkersmessaging/ports/items/description",
    								"type": "integerstring",
    								"title": "The Numberdescription offor RMRthe workersport",
    								"default": "port 1description",
    								"examples": [
    								1	"port description"
    								]
    							},
    			                "txMessages": {
    								"$id": "#/properties/messaging/ports/items/txmessages",
    			                    "type": "array",
    								"title": "The txMessage Types",
    			                    "items":{
    									"$id": "#/properties/messaging/ports/items//txmessages/item",
    									"type": "string",
    									"title": "The txMessage Types Item",
    									"default": "RIC_SUB",
    									"examples": [
    										"RIC_SUB"
    									]
    								}
    			                },
    			                "rxMessages": {
    								"$id": "#/properties/messaging/ports/items/rxmessages",
    			                    "type": "array",
    								"title": "The rxMessage Types",
    			                    "items":{
    									"$id": "#/properties/messaging/ports/items/rxmessages/item",
    									"type": "string",
    									"title": "The rxMessage Types Item",
    									"default": "RIC_SUB",
    									"examples": [
    										"RIC_SUB"
    									]
    								}
    			                },
    			                "policies": {
    								"$id": "#/properties/messaging/ports/items/policies",
    			                    "type": "array",
    								"title": "The Policies Types",
    			                    "items":{
    									"$id": "#/properties/messaging/ports/items/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"
    					}
    				}
    			}
    		}
    	}