Versions Compared

Version Old Version 12 New Version Current
Changes made by

Sharon Chisholm

Michael O'Brien

Saved on

Key

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

The following is a work in progress. TO DO

Swagger YAML

Created using https://swagger.io/swagger-editor/

Image RemovedImage Added

Code Block
collapsetrue
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"
        type: "string"
      - name: "modelVersionId"
        in: "query"
        description: "Model UUID as published in service model metadata"
        type: "string"
      - name: "modelInvariantId"
        in: "query"
        description: "SDC generated invariant id as published in service model metadata"
        type: "string"
      responses:
        200:
          description: "successful operation"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Service"
        400:
          description: "InvalidMissing  statusmanadatory value"field in the request or HTTP header."
security:       - petstore_auth404:
        -  description: "writeError:pets"
     Requested '%1' resource was not found."
   - "read:pets"    securityDefinitions405:
   petstore_auth:     type  description: "oauth2Method  Not Allowed  :  Invalid HTTP method type used ( PUT,DELETE,POST will be rejected)"
    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:    500:
          description: "The GET request failed either due to internal Context Builder problem."
      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"        
      dataQuality:
          $ref: "#/components/schemas/dataQuality" 
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"   
      vfList:
        type: "array"
        items:
          $ref: "#/definitions/VNF"        

    xml:
      name: "Service"
  VNF:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      type:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"   
      vfModuleList:
        type: "array"
        items:
          $ref: "#/definitions/VFModule"
      vnfcList:
        type: "array"
        items:
          $ref: "#/definitions/VNFC"
    xml:
      name: "VF"
  VFModule:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"        
      minInstances:
        type: "integer"
        format: "int32"
      maxInstances:
        type: "integer"
        format: "int32"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"   
      vmList:
        type: "array"
        items:
          $ref: "#/definitions/VM"
      networkList:
        type: "array"
        items:
          $ref: "#/definitions/Network"
    xml:
      name: "VFModule"
  VNFC:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
    xml:
      name: "VNFC"
  VM:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      nfNamingCode:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
      PServerList:
        type: "array"
        items:
          $ref: "#/definitions/PServer"
      IInterfaceList:
        type: "array"
        items:
          $ref: "#/definitions/IInterface"
    xml:
      name: "VM"
  Network:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
    xml:
      name: "Network"      
  IInterface:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
      PortList:
        type: "array"
        items:
          $ref: "#/definitions/Port"
    xml:
      name: "IInterface"   
  PServer:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
    xml:
      name: "PServer"            
  Port:
    type: "object"
    properties:
      uuid:
        type: "string"
      invariantUUID:
        type: "string"
      name:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
      attributeList:
        type: "array"
        items:
          $ref: "#/components/schemas/attribute"     
    xml:
      name: "Port"      
components:
  schemas:
   dataQuality:
    type: "object"
    properties:
      status:
        type: "string"
        enum: [ok, error]
      errorText:
        type: "string"
    required:
      - status
    xml:
      name: "dataQuality"
   attribute:
    type: "object"
    properties:
      name:
        $ref: "#/components/schemas/fieldName"
      value:
        type: "string"
      dataQuality:
          $ref: "#/components/schemas/dataQuality"
    required:
      - name
      - dataQuality
    xml:
      name: "dataQuality"  
   fieldName:
    type: string
    enum:
       - adminState
        - ipAddress
        - hostName
        - imageId
        - lockedBoolean
        - macAddress
        - networkType
        - networkTechnology
        - physicalNetworkName
        - sharedNetworkBoolean
        - networkRole
        - routerExternalBoolean
  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"

Inputs

Header

Image Added

Query Parameters

Note that each instantiation of this API within a particular context builder may define each of these parameters as either mandatory, optional or not supported.

Image Added

Example JSON Response

Note the top level objects is a service

Code Block
[
  {
    "uuid": "string",
    "invariantUUID": "string",
    "name": "string",
    "dataQuality": {
      "status": "ok",
      "errorText": "string"
    },
    "attributeList": [
      {
        "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
        "value": "string",
        "dataQuality": {
          "status": "ok",
          "errorText": "string"
        }
      }
    ],
    "vfList": [
      {
        "uuid": "string",
        "invariantUUID": "string",
        "name": "string",
        "type": "string",
        "dataQuality": {
          "status": "ok",
          "errorText": "string"
        },
        "attributeList": [
          {
            "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
            "value": "string",
            "dataQuality": {
              "status": "ok",
              "errorText": "string"
            }
          }
        ],
        "vfModuleList": [
          {
            "uuid": "string",
            "invariantUUID": "string",
            "name": "string",
            "minInstances": 0,
            "maxInstances": 0,
            "dataQuality": {
              "status": "ok",
              "errorText": "string"
            },
            "attributeList": [
              {
                "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
                "value": "string",
                "dataQuality": {
                  "status": "ok",
                  "errorText": "string"
                }
              }
            ],
            "vmList": [
              {
                "uuid": "string",
                "invariantUUID": "string",
                "name": "string",
                "nfNamingCode": "string",
                "dataQuality": {
                  "status": "ok",
                  "errorText": "string"
                },
                "attributeList": [
                  {
                    "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
                    "value": "string",
                    "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
                    }
                  }
                ],
                "PServerList": [
           type: "string"      {
  description: "Univseral indentifier"       invariantUUID:         type"uuid": "string",
      name:         type: "string"         description"invariantUUID": "Service Namestring",
              attributeList:         type"name": "arraystring",
        items:           $ref: "#/components/schemas/attribute"dataQuality": {
             vfList:         type"status": "arrayok",
         items:             $ref"errorText": "#/definitions/VFstring"
              dataQuality:      },
     $ref: "#/components/schemas/dataQuality"      xml:       name: "ServiceattributeList": [
 VF:      type: "object"     properties:       uuid:  {
      type: "string"       invariantUUID:         type: "stringname": "adminState - ipAddress - hostName - name:lockedBoolean - macAddress - networkType     type: "string"
      nfNamingCode:
- networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
       type: "string"       type:         type"value": "string",
      attributeList:           type: "array"      "dataQuality": {
 items:            $ref: "#/components/schemas/attribute"          vfModuleList:  "status": "ok",
     type: "array"         items:           $ref"errorText": "#/definitions/VFModule"string"
         vnfcList:          type: "array"    }
    items:           $ref: "#/definitions/VNFC"      }
dataQuality:           $ref: "#/components/schemas/dataQuality"     xml:   ]
   name: "VF"   VFModule:     type: "object"     properties:}
      uuid:         type: "string" ],
      invariantUUID:         type: "stringIInterfaceList": [
     name:         type: "string"   {
           nfNamingCode:         type"uuid": "string",
      minInstances:         type: "integer"         format"invariantUUID": "int32"
    string",
 maxInstances:         type: "integer"         format"name": "int32string"
,
     attributeList:         type: "array"       "dataQuality": {
items:           $ref: "#/components/schemas/attribute"          dataQuality"status": "ok",
         $ref: "#/components/schemas/dataQuality"     xml:       name"errorText": "VFModulestring"
  VNFC:     type: "object"     properties:       uuid:},
        type: "string"       invariantUUID:         type: "string"
"attributeList": [
     name:         type: "string"       nfNamingCode:{
        type: "string"       attributeList:         type"name": "array"adminState - ipAddress - hostName - lockedBoolean - macAddress - items:networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
$ref: "#/components/schemas/attribute"            dataQuality:           $ref"value": "#/components/schemas/dataQuality"string",
     xml:          name: "VNFC" components:   schemas:    "dataQuality": {
   type:  "object"     properties:       status:         type"status": "stringok",
        enum: [ok, error]       errorText:         type"errorText": "string"
        required:           - status    }
xml:       name: "dataQuality"    attribute:     type: "object"    }
properties:       name:         $ref: "#/components/schemas/fieldName"   ],
   value:         type: "string"       dataQuality"PortList": [
         $ref: "#/components/schemas/dataQuality"     required:       -{
name       - dataQuality     xml:       name: "dataQuality"   "uuid": "string",
 fieldName:     type: string     enum:        - adminState   "invariantUUID": "string",
    - ipAddress         - hostName         - lockedBoolean"name": "string",
        - macAddress         - networkType     "dataQuality": {
  - physicalNetworkName         - sharedNetworkBoolean         - routerExternalBoolean   ApiResponse:"status": "ok",
    type: "object"     properties:       code:         type"errorText": "integerstring"
        format: "int32"              type:  },
      type: "string"       message:         type: "stringattributeList": externalDocs:[
   description: "Find out more about Swagger"   url: "http://swagger.io

Inputs

Image Removed

Example JSON Response

Note the top level objects is a service

Code Block
[   {     "uuid": "string",     "invariantUUID": "string",{
     "name": "string",     "attributeList": [       {         "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
        "value": "string",
        "dataQuality": {           "statusvalue": "okstring",
                "errorText": "string"         }  "dataQuality": {
   }     ],     "vfList": [       {         "uuidstatus": "stringok",
        "invariantUUID": "string",            "name": "string",         "nfNamingCodeerrorText": "string",
        "type": "string",         "attributeList": [          }
{             "name": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - physicalNetworkName -}
sharedNetworkBoolean - routerExternalBoolean",             "value": "string",         ]
     "dataQuality": {               "status": "ok", }
              "errorText": "string"     ]
       }           }
        ],        ]
"vfModuleList":  [           { }
           "uuid": "string" ],
            "invariantUUIDnetworkList": "string", [
              {
  "name": "string",             "nfNamingCodeuuid": "string",
        
   "minInstances": 0,             "maxInstancesinvariantUUID": 0"string",
                "attributeListname": [ "string",
                "dataQuality": {
                  "namestatus": "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - physicalNetworkName - sharedNetworkBoolean - routerExternalBoolean",
"ok",
                  "errorText": "string"
               "value": "string" },
                "dataQualityattributeList": {[
                  "status": "ok",{
                    "errorTextname": "string"adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole }- routerExternalBoolean",
             }       "value": "string",
    ],                "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
            }           }
    
   ],         "vnfcList": [      }
    {            ]
"uuid": "string",             "invariantUUID": "string",}
            ]
"name": "string",         }
   "nfNamingCode": "string",    ],
        "attributeListvnfcList": [
              {
  
             "nameuuid": "string"adminState -,
ipAddress - hostName - lockedBoolean - macAddress - networkType - physicalNetworkName - sharedNetworkBoolean - routerExternalBoolean"invariantUUID": "string",
   
            "valuename": "string",

               "dataQuality": {
                  "status": "ok",
                  "errorText": "string"
            },
   }         "attributeList": [
    }          {
   ],             "dataQualityname": { "adminState - ipAddress - hostName - lockedBoolean - macAddress - networkType - networkTechnology - physicalNetworkName - sharedNetworkBoolean - networkRole - routerExternalBoolean",
                "statusvalue": "okstring",
                "errorTextdataQuality": "string"{
            }      "status": "ok",
   }         ],         "dataQualityerrorText": {"string"
          "status": "ok",     }
     "errorText": "string"        }
}       }     ],
    "dataQuality": {     }
 "status": "ok",      ]
"errorText": "string"     }
    ]
  }
]


Error

Image Added