so - Service Orchestrator

about summary refs log tree commit diff stats

path: root/adapters/mso-vnf-adapter/WebContent/META-INF/MANIFEST.MF

diff options

author	subhash kumar singh <subhash.kumar.singh@huawei.com>	2018-06-07 16:45:55 +0800
committer	subhash kumar singh <subhash.kumar.singh@huawei.com>	2018-06-07 16:47:53 +0800
commit	469e444a5fc0a30813381677c111e40afa5598d8 (patch)
tree	4980e36c878c8c165794732b8d6b5876944c2885 /adapters/mso-vnf-adapter/WebContent/META-INF/MANIFEST.MF
parent	5620466ed7664346278e99967d8600b127454091 (diff)

Add OOF API documentation

Add OOF API documentation Change-Id: I9adc172093cd547f4ddd3f07b1070054fbe0b3f1 Issue-ID: SO-660 Signed-off-by: subhash kumar singh <subhash.kumar.singh@huawei.com>

Diffstat (limited to 'adapters/mso-vnf-adapter/WebContent/META-INF/MANIFEST.MF')

0 files changed, 0 insertions, 0 deletions

6 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325

{
	"swagger": "2.0",
	"info": {
		"version": "2018.08.01",
		"title": "networkelementnamegenprodtest Service"
	},
	"basePath": "/web",
	"paths": {
		"/service/v1/addPolicy": {
			"post": {
				"summary": "Respond Hello <name>!",
				"description": "Returns a JSON object with a string to say hello. Uses 'world' if a name is not specified",
				"operationId": "addPolicyToDB",
				"produces": [
					"application/json"
				],
				"responses": {
					"200": {
						"description": "successful operation",
						"schema": {
							"type": "object",
							"additionalProperties": {
								"type": "object"
							}
						}
					},
					"404": {
						"description": "Service not available"
					},
					"500": {
						"description": "Unexpected Runtime error"
					}
				}
			}
		},
		"/service/v1/genNetworkElementName": {
			"post": {
				"summary": "Generates name",
				"description": "Generates network element name based on a naming policy1 ",
				"operationId": "generateNetworkElementName",
				"produces": [
					"application/json"
				],
				"parameters": [
					{
						"in": "body",
						"name": "body",
						"required": true,
						"schema": {
							"$ref": "#/definitions/NameGenRequest"
						}
					}
				],
				"responses": {
					"200": {
						"description": "successful operation",
						"schema": {
							"$ref": "#/definitions/NameGenResponse"
						}
					},
					"404": {
						"description": "Service not available"
					},
					"500": {
						"description": "Unexpected Runtime error"
					}
				}
			},
			"delete": {
				"summary": "Release an existing name by external key",
				"description": "Release network element name ",
				"operationId": "releaseNetworkElementName",
				"produces": [
					"application/json"
				],"parameters": [ 
					{
						"in": "body",
						"name": "body",
						"required": true,
						"schema": {
							"$ref": "#/definitions/NameGenDeleteRequest"
						}
					}
				],
				"responses": {
					"200": {
						"description": "successful operation",
						"schema": {
							"$ref": "#/definitions/NameGenDeleteResponse"
						}
					},
					"404": {
						"description": "Service not available"
					},
					"500": {
						"description": "Unexpected Runtime error"
					}
				}
			}
		}, 
		"/service/v1/getpolicyresponse/{policyName}": {
			"get": {
				"summary": "Respond Hello <name>!",
				"description": "Returns a JSON object with a string to say hello. Uses 'world' if a name is not specified",
				"operationId": "getPolicyResponse",
				"produces": [
					"application/json"
				],
				"responses": {
					"200": {
						"description": "successful operation",
						"schema": {
							"type": "object",
							"additionalProperties": {
								"type": "object"
							}
						}
					},
					"404": {
						"description": "Service not available"
					},
					"500": {
						"description": "Unexpected Runtime error"
					}
				}
			}
		}
	},
	"definitions": {
		"HelloWorld": {
			"type": "object",
			"properties": {
				"message": {
					"type": "string"
				}
			}
		},
		"NameGenRequest": {
			"title": "NameGenRequest",
			"$schema": "http://json-schema.org/draft-07/schema#",
			"type": "object",
			"required": [
				"elements"
			],
			"properties": {
				"elements": {
					"type": "array",
					"items": {
						"$ref": "#/definitions/element"
					}
				}
			},
			"additionalProperties": false,
			"definitions": {
				"element": {
					"type": "object",
					"required": [
						"resource-name",
						"external-key",
						"policy-instance-name",
						"naming-type"
					],
					"properties": {
						"resource-name": {
							"type": "string",
							"description": "Name of the resource"
						},
						"resource-value": {
							"type": "string",
							"description": "Optional. If given, request will be considered as update request"
						},
						"external-key": {
							"type": "string",
							"description": "Key identifier for generated name. This will be used in release/update request"
						},
						"policy-instance-name": {
							"type": "string",
							"description": "Name of the policy to be used for name generation"
						},
						"naming-type": {
							"type": "string",
							"description": "Naming type of the resource"
						}
					},
					"additionalProperties": {
						"type": "string"
					}
				}
			}
		},
		"NameGenResponse": {
			"type": "object",
			  "description":"Response with generated names for each naming type. Either elements(one or more) or an error block will be present",
			  "properties": {
				"elements" : {
					"type":"array",
					"items": { "$ref": "#/definitions/respelement" }
				},
				"error" : {
					"type":"object",
			        "required": ["errorId", "message"],
					"properties":{
						"errorId":{"type":"string" , "description":"error code"},
						"message": {"type":"string", "description":"error message"}
						}
				}
			  }
		},
		"element": {
			"type": "object",
			"required": [
				"resource-name",
				"external-key",
				"policy-instance-name",
				"naming-type"
			],
			"properties": {
				"resource-name": {
					"type": "string",
					"description": "Name of the resource"
				},
				"resource-value": {
					"type": "string",
					"description": "Optional. If given, request will be considered as update request"
				},
				"external-key": {
					"type": "string",
					"description": "Key identifier for generated name. This will be used in release/update request"
				},
				"policy-instance-name": {
					"type": "string",
					"description": "Name of the policy to be used for name generation"
				},
				"naming-type": {
					"type": "string",
					"description": "Naming type of the resource"
				},
				"${naming-ingredients(zero or more)}": {
					"type": "string",
					"description": "values to subsitute in the naming recipe"
				}
			},
			"additionalProperties": {
				"type": "string"
			}
		},
		"respelement": {
		"type":"object",
		"required": [ "resource-name","resource-value","external-key"],
		 "properties": {
           "resource-value": {
				"type": "string",
				"description": "Optional. If given, request will be considered as update request"
			},
			"resource-name": {
				"type": "string",
				 "description": "Name of the resource"
			},
			"external-key": { 
				"type": "string",
				"description": "Key identifier for generated name. This will be used in release/update request"
			}
		 }
		},
		"NameGenDeleteRequest": {
			"title": "NameGenRequest",
			"$schema": "http://json-schema.org/draft-07/schema#",
			"type": "object",
			"required": [
				"elements"
			],
			"properties": {
				"elements": {
					"type": "array",
					"items": {
						"$ref": "#/definitions/deleteelement"
					}
				}
			}
		},
		"deleteelement": {
			"type": "object",
			"required": [ "external-key" ],
			"properties": {
				"external-key": {
					"type": "string",
					"description": "External key of the name that is being released"
				}
			}
		},"NameGenDeleteResponse": {
			"title": "NameGenRequest",
			"$schema": "http://json-schema.org/draft-07/schema#",
			"type": "object",
			"required": [
				"elements"
			],
			"properties": {
				"elements": {
					"type": "array",
					"items": {
						"$ref": "#/definitions/deleteresponseelement"
					}
				}
			}
		},
		"deleteresponseelement": {
			"type": "object",
			"required": [ "resource-value","resource_name","external-key" ],
			"properties": {
				"resource-value": {
					"type": "string",
					"description": "Name that is being release"
				},
				"resource-name": {
					"type": "string",
					"description": "Resource Name"
				},
				"external-key": {
					"type": "string",
					"description": "External key of the name that is being released"
				}
			}
		}
	}
}


context:
space:
mode: