Swagger API documentation
All of the Pomba Context Builders conform to the same API definition.
Copy and paste the following swagger.json into https://editor.swagger.io/ to browse the API documentation offline:
{
"swagger" : "2.0",
"info" : {
"version" : "1.4.0-SNAPSHOT",
"title" : "Context Builder API",
"termsOfService" : "http://onap.org"
},
"basePath" : "/{pomba-network-discovery-context-builder",
"paths" : {
"/service/context" : {
"get" : {
"summary" : "Fetch network info for service",
"description" : "Returns a JSON object which represents the Context model data",
"operationId" : "getContext",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "Authorization",
"in" : "header",
"required" : false,
"type" : "string"
}, {
"name" : "X-ONAP-PartnerName",
"in" : "header",
"required" : false,
"type" : "string"
}, {
"name" : "X-ONAP-RequestID",
"in" : "header",
"required" : false,
"type" : "string"
}, {
"name" : "X-FromAppId",
"in" : "header",
"required" : false,
"type" : "string"
}, {
"name" : "X-TransactionId",
"in" : "header",
"required" : false,
"type" : "string"
}, {
"name" : "serviceInstanceId",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "modelVersionId",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "modelInvariantId",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "OK"
},
"400" : {
"description" : "Bad Request"
},
"404" : {
"description" : "Service not available"
},
"500" : {
"description" : "Unexpected Runtime error"
}
}
}
}
},
"securityDefinitions" : {
"basicAuth" : {
"type" : "basic"
}
}
}