...
Code Block | ||
---|---|---|
| ||
swagger: "2.0" info: description: "This is the POMBA Context Builder API. It must be supported by all Context Builders" version: "0.0.1" title: "POMBA Context Builder" termsOfService: "http://onap.org" contact: email: "sharon.chisholm@amdocs.com" host: "onap.org" basePath: "/v1" tags: - name: "service" description: "Service Instances" externalDocs: description: "Find out more" url: "http://onap.org" schemes: - "http" paths: /service/context: get: tags: - "pet" summary: "Get service instance" description: "Retrieve information about a particular service instance using information avaialble to this specific context builder." operationId: "findServiceByInstance" produces: - "application/json" parameters: - name: "ServiceInstanceId" in: "query" description: "Service Instance Id of service you are interested in" required: true type: "string" responses: 200: description: "successful operation" schema: type: "array" items: $ref: "#/definitions/Service" 400: description: "Invalid status value" security: - petstore_auth: - "write:pets" - "read:pets" securityDefinitions: petstore_auth: type: "oauth2" authorizationUrl: "http://petstore.swagger.io/oauth/dialog" flow: "implicit" scopes: write:pets: "modify pets in your account" read:pets: "read your pets" api_key: type: "apiKey" name: "api_key" in: "header" definitions: Service: type: "object" properties: uuid: type: "string" description: "Univseral indentifier" invariantUUID: type: "string" name: type: "string" description: "Service Name" vfListattributeList: type: "array" items: $ref: "#/components/definitionsschemas/VFattribute" dataQualityvfList: $reftype: "#/components/schemas/dataQualityarray" xml: items: name: "Service" VF: type$ref: "object#/definitions/VF" properties: uuid: dataQuality: type: "string" $ref: "#/components/schemas/dataQuality" invariantUUIDxml: name: "Service" VF: type: "stringobject" properties: name uuid: type: "string" nfNamingCodeinvariantUUID: type: "string" typename: type: "string" vfModuleListnfNamingCode: type: "arraystring" itemstype: $reftype: "#/definitions/VFModulestring" vnfcListattributeList: type: "array" items: $ref: "#/definitionscomponents/schemas/VNFCattribute" dataQuality: vfModuleList: $reftype: "#/components/schemas/dataQualityarray" xml: items: name: "VF" VFModule: type$ref: "object#/definitions/VFModule" properties: uuidvnfcList: type: "stringarray" invariantUUID items: type$ref: "string#/definitions/VNFC" namedataQuality: type$ref: "string#/components/schemas/dataQuality" xml: nfNamingCodename: "VF" VFModule: type: "stringobject" minInstancesproperties: type: "integer"uuid: formattype: "int32string" maxInstancesinvariantUUID: type: "integerstring" name: format type: "int32string" dataQuality: nfNamingCode: $ref: "#/components/schemas/dataQuality" xmltype: "string" nameminInstances: "VFModule" VNFC: type: "objectinteger" properties: format: "int32" uuidmaxInstances: type: "stringinteger" invariantUUID: typeformat: "stringint32" nameattributeList: type: "stringarray" nfNamingCodeitems: type $ref: "string"#/components/schemas/attribute" dataQuality: $ref: "#/components/schemas/dataQuality" xml: name: "VNFCVFModule" components: schemasVNFC: dataQuality: type: "object" properties: statusuuid: type: "string" invariantUUID: enum: [ok, error] type: "string" errorTextname: type: "string" required: nfNamingCode: - status type: "string" xml: nameattributeList: "dataQuality" ApiResponse: type: "objectarray" properties: items: code: type$ref: "integer#/components/schemas/attribute" format: "int32" dataQuality: type:$ref: "#/components/schemas/dataQuality" xml: type name: "stringVNFC" components: messageschemas: dataQuality: type: "stringobject" externalDocs: descriptionproperties: "Find out more about Swagger" status: url: "http://swagger.io" |
Example JSON
Code Block |
---|
[ { "uuid": "string", "invariantUUID": "string", "name": "string", "vfList": [ { type: "string" enum: [ok, error] errorText: type: "string" required: - status xml: name: "dataQuality" attribute: type: "object" properties: name: type: "string" type: type: "string" value: type: "string" dataQuality: $ref: "#/components/schemas/dataQuality" required: - name - dataQuality xml: name: "dataQuality" ApiResponse: type: "object" properties: code: type: "integer" format: "int32" type: type: "string" message: type: "string" externalDocs: description: "Find out more about Swagger" url: "http://swagger.io" |
Example JSON
Note the top level objects is a service
Code Block |
---|
[ { "uuid": "string", "invariantUUID": "string", "name": "string", "attributeList": [ { "name": "string", "type": "string", "value": "string", "dataQuality": { "status": "ok", "errorText": "string" } } ], "vfList": [ { "uuid": "string", "invariantUUID": "string", "name": "string", "nfNamingCode": "string", "type": "string", "attributeList": [ { "name": "string", "type": "string", "value": "string", "dataQuality": { "status": "ok", "errorText": "string" } } ], "vfModuleList": [ { "uuid": "string", "invariantUUID": "string", "name": "string", "nfNamingCode": "string", "minInstances": 0, "maxInstances": 0, "attributeList": [ { "name": "string", "type": "string", "value": "string", "dataQuality": { "status": "ok", "errorText": "string" } } ], "dataQuality": { "uuidstatus": "stringok", "invariantUUID "errorText": "string", "name": "string", } "nfNamingCode": "string", } "type": "string" ], "vfModuleListvnfcList": [ { "uuid": "string", "invariantUUID": "string", "name": "string", "nfNamingCode": "string", "minInstancesattributeList": 0, [ { "maxInstances": 0, "dataQualityname": {"string", "statustype": "okstring", "errorTextvalue": "string" "string", } "dataQuality": { } ], "vnfcListstatus": [ "ok", { "uuiderrorText": "string", "invariantUUID": "string", } "name": "string", } "nfNamingCode": "string" ], "dataQuality": { "status": "ok", "errorText": "string" } } ], "dataQuality": { "status": "ok", "errorText": "string" } } ], "dataQuality": { "status": "ok", "errorText": "string" } } ] |
...