summaryrefslogtreecommitdiffstats
path: root/docs/api/swagger
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/swagger')
-rw-r--r--docs/api/swagger/healthcheck-api.json99
-rw-r--r--docs/api/swagger/nodetemplates-api.json1742
-rw-r--r--docs/api/swagger/policy-api.json1101
-rw-r--r--docs/api/swagger/policytype-api.json665
-rw-r--r--docs/api/swagger/statistics-api.json147
5 files changed, 0 insertions, 3754 deletions
diff --git a/docs/api/swagger/healthcheck-api.json b/docs/api/swagger/healthcheck-api.json
deleted file mode 100644
index fefd595a..00000000
--- a/docs/api/swagger/healthcheck-api.json
+++ /dev/null
@@ -1,99 +0,0 @@
-{
- "swagger" : "2.0",
- "basePath" : "/",
- "tags" : [{
- "name" : "HealthCheck"
- }],
- "schemes" : [ "http", "https" ],
- "paths" : {
- "/policy/api/v1/healthcheck" : {
- "get" : {
- "tags" : [ "HealthCheck" ],
- "summary" : "Perform a system healthcheck",
- "description" : "Returns healthy status of the Policy API component",
- "operationId" : "getHealthCheck",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [{
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Healthcheck report will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/HealthCheckReport"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- }
- },
- "securityDefinitions" : {
- "basicAuth" : {
- "description" : "",
- "type" : "basic"
- }
- },
- "definitions" : {
- "HealthCheckReport" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "url" : {
- "type" : "string"
- },
- "healthy" : {
- "type" : "boolean"
- },
- "code" : {
- "type" : "integer",
- "format" : "int32"
- },
- "message" : {
- "type" : "string"
- }
- }
- }
- }
-}
diff --git a/docs/api/swagger/nodetemplates-api.json b/docs/api/swagger/nodetemplates-api.json
deleted file mode 100644
index bd8ed48e..00000000
--- a/docs/api/swagger/nodetemplates-api.json
+++ /dev/null
@@ -1,1742 +0,0 @@
-{
- "swagger": "2.0",
- "basePath": "/",
- "tags": [
- {
- "name": "nodeTemplate"
- }
- ],
- "schemes": [
- "http",
- "https"
- ],
- "paths": {
- "/policy/api/v1/nodetemplates":{
- "get":{
- "tags":[
- "nodeTemplates"
- ],
- "summary":"Retrieve all the available tosca node templates",
- "description":"Returns all the node templates from the service template",
- "operationId":"getAllNodeTemplatesUsingGET",
- "produces":[
- "application/json",
- "application/yaml"
- ],
- "parameters":[
- {
- "name":"X-ONAP-RequestID",
- "in":"header",
- "description":"RequestID for http transaction",
- "required":false,
- "type":"string",
- "format":"uuid"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaNodeTemplateRes",
- "originalRef":"ToscaNodeTemplateRes"
- }
- }
- },
- "401":{
- "description":"Authentication Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "403":{
- "description":"Authorization Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "404":{
- "description":"Resource Not Found",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "500":{
- "description":"Internal Server Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- }
- },
- "security":[
- {
- "basicAuth":[
-
- ]
- }
- ],
- "x-interface info":{
- "api-version":"1.0.0",
- "last-mod-release":"Jakarta"
- }
- },
- "post":{
- "tags":[
- "nodeTemplate"
- ],
- "summary":"Create one or more new node templates",
- "description":"Client should provide TOSCA body of the new node templates",
- "operationId":"createToscaNodeTemplatesUsingPOST",
- "consumes":[
- "application/json"
- ],
- "produces":[
- "application/json",
- "application/yaml"
- ],
- "parameters":[
- {
- "in":"body",
- "name":"body",
- "description":"Entity body of tosca node templates",
- "required":true,
- "schema":{
- "$ref":"#/definitions/ToscaServiceTemplateReq",
- "originalRef":"ToscaServiceTemplateReq"
- }
- },
- {
- "name":"X-ONAP-RequestID",
- "in":"header",
- "description":"RequestID for http transaction",
- "required":false,
- "type":"string",
- "format":"uuid"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "$ref":"#/definitions/ToscaServiceTemplateRes",
- "originalRef":"ToscaServiceTemplateRes"
- }
- },
- "201":{
- "description":"Created"
- },
- "400":{
- "description":"Invalid Body",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "401":{
- "description":"Authentication Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "403":{
- "description":"Authorization Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "404":{
- "description":"Resource Not Found",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "406":{
- "description":"Not Acceptable Payload",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "500":{
- "description":"Internal Server Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- }
- },
- "security":[
- {
- "basicAuth":[
-
- ]
- }
- ],
- "x-interface info":{
- "api-version":"1.0.0",
- "last-mod-release":"Jakarta"
- }
- },
- "put":{
- "tags":[
- "nodeTemplate"
- ],
- "summary":"Updates one or more new node templates",
- "description":"Client should provide TOSCA body of the updated node templates",
- "operationId":"updateToscaNodeTemplatesUsingPUT",
- "consumes":[
- "application/json"
- ],
- "produces":[
- "application/json",
- "application/yaml"
- ],
- "parameters":[
- {
- "in":"body",
- "name":"body",
- "description":"Entity body of tosca node templates",
- "required":true,
- "schema":{
- "$ref":"#/definitions/ToscaServiceTemplateReq",
- "originalRef":"ToscaServiceTemplateReq"
- }
- },
- {
- "name":"X-ONAP-RequestID",
- "in":"header",
- "description":"RequestID for http transaction",
- "required":false,
- "type":"string",
- "format":"uuid"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "$ref":"#/definitions/ToscaServiceTemplateRes",
- "originalRef":"ToscaServiceTemplateRes"
- }
- },
- "201":{
- "description":"Created"
- },
- "400":{
- "description":"Invalid Body",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "401":{
- "description":"Authentication Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "403":{
- "description":"Authorization Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "404":{
- "description":"Resource Not Found",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "406":{
- "description":"Not Acceptable Payload",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "500":{
- "description":"Internal Server Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- }
- },
- "security":[
- {
- "basicAuth":[
-
- ]
- }
- ],
- "x-interface info":{
- "api-version":"1.0.0",
- "last-mod-release":"Jakarta"
- }
- }
- },
- "/policy/api/v1/nodetemplates/{name}/versions/{version}":{
- "get":{
- "tags":[
- "nodeTemplates"
- ],
- "summary":"Retrieve one version of a tosca node template",
- "description":"Returns a particular version of a node template",
- "operationId":"getSpecificVersionOfNodeTemplateUsingGET",
- "produces":[
- "application/json",
- "application/yaml"
- ],
- "parameters":[
- {
- "name":"name",
- "in":"path",
- "description":"Name of the node template",
- "required":true,
- "type":"string"
- },
- {
- "name":"version",
- "in":"path",
- "description":"Version of the node template",
- "required":true,
- "type":"string"
- },
- {
- "name":"X-ONAP-RequestID",
- "in":"header",
- "description":"RequestID for http transaction",
- "required":false,
- "type":"string",
- "format":"uuid"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaNodeTemplateRes",
- "originalRef":"ToscaNodeTemplateRes"
- }
- }
- },
- "401":{
- "description":"Authentication Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "403":{
- "description":"Authorization Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "404":{
- "description":"Resource Not Found",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "500":{
- "description":"Internal Server Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- }
- },
- "security":[
- {
- "basicAuth":[
-
- ]
- }
- ],
- "x-interface info":{
- "api-version":"1.0.0",
- "last-mod-release":"Jakarta"
- }
- },
- "delete":{
- "tags":[
- "nodeTemplate"
- ],
- "summary":"Deletes a specific node templates",
- "description":"Client should provide the name and version of the node template to be deleted",
- "operationId":"deleteToscaNodeTemplatesUsingDELETE",
- "produces":[
- "application/json",
- "application/yaml"
- ],
- "parameters":[
- {
- "name":"name",
- "in":"path",
- "description":"Name of the node template",
- "required":true,
- "type":"string"
- },
- {
- "name":"version",
- "in":"path",
- "description":"Version of the node template",
- "required":true,
- "type":"string"
- },
- {
- "name":"X-ONAP-RequestID",
- "in":"header",
- "description":"RequestID for http transaction",
- "required":false,
- "type":"string",
- "format":"uuid"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "$ref":"#/definitions/ToscaServiceTemplateRes",
- "originalRef":"ToscaServiceTemplateRes"
- }
- },
- "204":{
- "description":"No Content"
- },
- "400":{
- "description":"Invalid Body",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "401":{
- "description":"Authentication Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "403":{
- "description":"Authorization Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "404":{
- "description":"Resource Not Found",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "406":{
- "description":"Not Acceptable Payload",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- },
- "500":{
- "description":"Internal Server Error",
- "headers":{
- "X-LatestVersion":{
- "type":"string"
- },
- "X-PatchVersion":{
- "type":"string"
- },
- "X-MinorVersion":{
- "type":"string"
- },
- "X-ONAP-RequestID":{
- "type":"string",
- "format":"uuid"
- }
- }
- }
- },
- "security":[
- {
- "basicAuth":[
-
- ]
- }
- ],
- "x-interface info":{
- "api-version":"1.0.0",
- "last-mod-release":"Jakarta"
- }
- }
- }
- },
- "definitions": {
-
- "ToscaCapabilityAssignmentReq":{
- "type":"object",
- "properties":{
- "attributes":{
- "type":"object"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "occurrences":{
- "type":"array",
- "items":{
- "type":"object"
- }
- },
- "properties":{
- "type":"object"
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaCapabilityAssignmentReq"
- },
- "ToscaCapabilityAssignmentRes":{
- "type":"object",
- "properties":{
- "attributes":{
- "type":"object"
- },
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "identifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "occurrences":{
- "type":"array",
- "items":{
- "type":"object"
- }
- },
- "properties":{
- "type":"object"
- },
- "type":{
- "type":"string"
- },
- "typeIdentifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaCapabilityAssignmentRes"
- },
- "ToscaCapabilityTypeReq":{
- "type":"object",
- "properties":{
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaCapabilityTypeReq"
- },
- "ToscaCapabilityTypeRes":{
- "type":"object",
- "properties":{
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaCapabilityTypeRes"
- },
- "ToscaConceptIdentifier":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaConceptIdentifier"
- },
- "ToscaConstraint":{
- "type":"object",
- "properties":{
- "equal":{
- "type":"string"
- },
- "greaterOrEqual":{
- "type":"string"
- },
- "greaterThan":{
- "type":"string"
- },
- "lessOrEqual":{
- "type":"string"
- },
- "lessThan":{
- "type":"string"
- },
- "rangeValues":{
- "type":"array",
- "items":{
- "type":"string"
- }
- },
- "validValues":{
- "type":"array",
- "items":{
- "type":"string"
- }
- }
- },
- "title":"ToscaConstraint"
- },
- "ToscaDataTypeReq":{
- "type":"object",
- "properties":{
- "constraints":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaConstraint",
- "originalRef":"ToscaConstraint"
- }
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaDataTypeReq"
- },
- "ToscaDataTypeRes":{
- "type":"object",
- "properties":{
- "constraints":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaConstraint",
- "originalRef":"ToscaConstraint"
- }
- },
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaDataTypeRes"
- },
- "ToscaEntityKey":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaEntityKey"
- },
- "ToscaNodeTemplateReq":{
- "type":"object",
- "properties":{
- "capabilities":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaCapabilityAssignmentReq",
- "originalRef":"ToscaCapabilityAssignmentReq"
- }
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object"
- },
- "requirements":{
- "type":"array",
- "items":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRequirementReq",
- "originalRef":"ToscaRequirementReq"
- }
- }
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaNodeTemplateReq"
- },
- "ToscaNodeTemplateRes":{
- "type":"object",
- "properties":{
- "capabilities":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaCapabilityAssignmentRes",
- "originalRef":"ToscaCapabilityAssignmentRes"
- }
- },
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "identifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object"
- },
- "requirements":{
- "type":"array",
- "items":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRequirementRes",
- "originalRef":"ToscaRequirementRes"
- }
- }
- },
- "type":{
- "type":"string"
- },
- "typeIdentifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaNodeTemplateRes"
- },
- "ToscaNodeTypeReq":{
- "type":"object",
- "properties":{
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "requirements":{
- "type":"array",
- "items":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRequirementReq",
- "originalRef":"ToscaRequirementReq"
- }
- }
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaNodeTypeReq"
- },
- "ToscaNodeTypeRes":{
- "type":"object",
- "properties":{
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "requirements":{
- "type":"array",
- "items":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRequirementRes",
- "originalRef":"ToscaRequirementRes"
- }
- }
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaNodeTypeRes"
- },
- "ToscaParameter":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string"
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "value":{
- "type":"object"
- }
- },
- "title":"ToscaParameter"
- },
- "ToscaProperty":{
- "type":"object",
- "properties":{
- "constraints":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaConstraint",
- "originalRef":"ToscaConstraint"
- }
- },
- "defaultValue":{
- "type":"object"
- },
- "description":{
- "type":"string"
- },
- "entrySchema":{
- "$ref":"#/definitions/ToscaSchemaDefinition",
- "originalRef":"ToscaSchemaDefinition"
- },
- "keySchema":{
- "$ref":"#/definitions/ToscaSchemaDefinition",
- "originalRef":"ToscaSchemaDefinition"
- },
- "metadata":{
- "type":"object",
- "additionalProperties":{
- "type":"string"
- }
- },
- "name":{
- "type":"string"
- },
- "required":{
- "type":"boolean"
- },
- "status":{
- "type":"string",
- "enum":[
- "DEPRECATED",
- "EXPERIMENTAL",
- "SUPPORTED",
- "UNSUPPORTED"
- ]
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- }
- },
- "title":"ToscaProperty"
- },
- "ToscaRelationshipTypeReq":{
- "type":"object",
- "properties":{
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaRelationshipTypeReq"
- },
- "ToscaRelationshipTypeRes":{
- "type":"object",
- "properties":{
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "properties":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaProperty",
- "originalRef":"ToscaProperty"
- }
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaRelationshipTypeRes"
- },
- "ToscaRequirementReq":{
- "type":"object",
- "properties":{
- "capability":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "node":{
- "type":"string"
- },
- "occurrences":{
- "type":"array",
- "items":{
- "type":"object"
- }
- },
- "properties":{
- "type":"object"
- },
- "relationship":{
- "type":"string"
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaRequirementReq"
- },
- "ToscaRequirementRes":{
- "type":"object",
- "properties":{
- "capability":{
- "type":"string"
- },
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "identifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "node":{
- "type":"string"
- },
- "occurrences":{
- "type":"array",
- "items":{
- "type":"object"
- }
- },
- "properties":{
- "type":"object"
- },
- "relationship":{
- "type":"string"
- },
- "type":{
- "type":"string"
- },
- "typeIdentifier":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaRequirementRes"
- },
- "ToscaSchemaDefinition":{
- "type":"object",
- "properties":{
- "constraints":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ToscaConstraint",
- "originalRef":"ToscaConstraint"
- }
- },
- "description":{
- "type":"string"
- },
- "name":{
- "type":"string"
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- }
- },
- "title":"ToscaSchemaDefinition"
- },
- "ToscaServiceTemplateReq":{
- "type":"object",
- "properties":{
- "capabilityTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaCapabilityTypeReq",
- "originalRef":"ToscaCapabilityTypeReq"
- }
- },
- "dataTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaDataTypeReq",
- "originalRef":"ToscaDataTypeReq"
- }
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "nodeTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaNodeTypeReq",
- "originalRef":"ToscaNodeTypeReq"
- }
- },
- "relationshipTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRelationshipTypeReq",
- "originalRef":"ToscaRelationshipTypeReq"
- }
- },
- "toscaDefinitionsVersion":{
- "type":"string"
- },
- "toscaTopologyTemplate":{
- "$ref":"#/definitions/ToscaTopologyTemplateReq",
- "originalRef":"ToscaTopologyTemplateReq"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaServiceTemplateReq"
- },
- "ToscaServiceTemplateRes":{
- "type":"object",
- "properties":{
- "capabilityTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaCapabilityTypeRes",
- "originalRef":"ToscaCapabilityTypeRes"
- }
- },
- "dataTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaDataTypeRes",
- "originalRef":"ToscaDataTypeRes"
- }
- },
- "dataTypesAsMap":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaDataTypeRes",
- "originalRef":"ToscaDataTypeRes"
- }
- },
- "definedName":{
- "type":"string"
- },
- "definedVersion":{
- "type":"string"
- },
- "derivedFrom":{
- "type":"string"
- },
- "description":{
- "type":"string"
- },
- "key":{
- "$ref":"#/definitions/ToscaEntityKey",
- "originalRef":"ToscaEntityKey"
- },
- "metadata":{
- "type":"object"
- },
- "name":{
- "type":"string"
- },
- "nodeTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaNodeTypeRes",
- "originalRef":"ToscaNodeTypeRes"
- }
- },
- "relationshipTypes":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaRelationshipTypeRes",
- "originalRef":"ToscaRelationshipTypeRes"
- }
- },
- "toscaDefinitionsVersion":{
- "type":"string"
- },
- "toscaTopologyTemplate":{
- "$ref":"#/definitions/ToscaTopologyTemplateRes",
- "originalRef":"ToscaTopologyTemplateRes"
- },
- "type":{
- "type":"string"
- },
- "typeVersion":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaServiceTemplateRes"
- },
- "ToscaTopologyTemplateReq":{
- "type":"object",
- "properties":{
- "description":{
- "type":"string"
- },
- "inputs":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaParameter",
- "originalRef":"ToscaParameter"
- }
- },
- "nodeTemplates":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaNodeTemplateReq",
- "originalRef":"ToscaNodeTemplateReq"
- }
- }
- },
- "title":"ToscaTopologyTemplateReq"
- },
- "ToscaTopologyTemplateRes":{
- "type":"object",
- "properties":{
- "description":{
- "type":"string"
- },
- "inputs":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaParameter",
- "originalRef":"ToscaParameter"
- }
- },
- "nodeTemplates":{
- "type":"object",
- "additionalProperties":{
- "$ref":"#/definitions/ToscaNodeTemplateRes",
- "originalRef":"ToscaNodeTemplateRes"
- }
- }
- },
- "title":"ToscaTopologyTemplateRes"
- }
- }
-}
diff --git a/docs/api/swagger/policy-api.json b/docs/api/swagger/policy-api.json
deleted file mode 100644
index 95c73973..00000000
--- a/docs/api/swagger/policy-api.json
+++ /dev/null
@@ -1,1101 +0,0 @@
-{
- "swagger" : "2.0",
- "basePath" : "/",
- "tags" : [ {
- "name" : "Policy"
- } ],
- "schemes" : [ "http", "https" ],
- "paths" : {
- "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies" : {
- "get" : {
- "tags" : [ "Policy" ],
- "summary" : "Retrieve all versions of a policy created for a particular policy type version",
- "description" : "Returns a list of all versions of specified policy created for the specified policy type version",
- "operationId" : "getAllPolicies",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; All policies matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- },
- "post" : {
- "tags" : [ "Policy" ],
- "summary" : "Create a new policy for a policy type version",
- "description" : "Create a new policy for a policy type. Client should provide TOSCA body of the new policy",
- "operationId" : "createPolicy",
- "consumes" : [ "application/json", "application/yaml" ],
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Entity body of policy",
- "required" : true,
- "type" : "ToscaServiceTemplate",
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly created policy matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "400" : {
- "description" : "Invalid Body"
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "406" : {
- "description" : "Not Acceptable Version"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}" : {
- "get" : {
- "tags" : [ "Policy" ],
- "summary" : "Retrieve all version details of a policy created for a particular policy type version",
- "description" : "Returns a list of all version details of the specified policy",
- "operationId" : "getAllVersionsOfPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; All versions of specified policy matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}" : {
- "get" : {
- "tags" : [ "Policy" ],
- "summary" : "Retrieve one version of a policy created for a particular policy type version",
- "description" : "Returns a particular version of specified policy created for the specified policy type version",
- "operationId" : "getSpecificVersionOfPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyVersion",
- "in" : "path",
- "description" : "Version of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; The specified policy matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- },
- "delete" : {
- "tags" : [ "Policy" ],
- "summary" : "Delete a particular version of a policy",
- "description" : "Delete a particular version of a policy. It must follow one rule. Rule: the version that has been deployed in PDP group(s) cannot be deleted",
- "operationId" : "deleteSpecificVersionOfPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "PolicyType ID",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyVersion",
- "in" : "path",
- "description" : "Version of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly deleted policy matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "409" : {
- "description" : "Delete Conflict, Rule Violation"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest" : {
- "get" : {
- "tags" : [ "Policy" ],
- "summary" : "Retrieve the latest version of a particular policy",
- "description" : "Returns the latest version of specified policy",
- "operationId" : "getLatestVersionOfPolicy",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyTypeVersion",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "policyId",
- "in" : "path",
- "description" : "ID of policy",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Latest version of specified policy matching specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policies/{policyId}/versions/{policyVersion}": {
- "get": {
- "tags": [
- "Policy"
- ],
- "summary": "Retrieve specific version of a specified policy",
- "description": "Returns a particular version of specified policy",
- "operationId": "getSpecificPolicy",
- "consumes": [
- "application/json",
- "application/yaml"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "policyId",
- "in": "path",
- "description": "Name of policy",
- "required": true,
- "type": "string"
- },
- {
- "name": "policyVersion",
- "in": "path",
- "description": "Version of policy",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- },
- {
- "name": "mode",
- "in": "query",
- "description": "Fetch mode for policies, BARE for bare policies (default), REFERENCED for fully referenced policies",
- "required": false,
- "type": "string",
- "default": "bare",
- "enum": [
- "BARE",
- "REFERENCED"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "headers": {
- "X-MinorVersion": {
- "type": "string",
- "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion": {
- "type": "string",
- "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion": {
- "type": "string",
- "description": "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid",
- "description": "Used to track REST transactions for logging purpose"
- }
- },
- "schema": {
- "$ref": "#/definitions/ToscaServiceTemplate"
- }
- },
- "401": {
- "description": "Authentication Error"
- },
- "403": {
- "description": "Authorization Error"
- },
- "404": {
- "description": "Resource Not Found"
- },
- "500": {
- "description": "Internal Server Error"
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Guilin"
- }
- },
- "delete": {
- "tags": [
- "Policy"
- ],
- "summary": "Delete a particular version of a policy",
- "description": "Rule: the version that has been deployed in PDP group(s) cannot be deleted",
- "operationId": "deleteSpecificPolicy",
- "consumes": [
- "application/json",
- "application/yaml"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "policyId",
- "in": "path",
- "description": "ID of policy",
- "required": true,
- "type": "string"
- },
- {
- "name": "policyVersion",
- "in": "path",
- "description": "Version of policy",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "headers": {
- "X-MinorVersion": {
- "type": "string",
- "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion": {
- "type": "string",
- "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion": {
- "type": "string",
- "description": "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid",
- "description": "Used to track REST transactions for logging purpose"
- }
- },
- "schema": {
- "$ref": "#/definitions/ToscaServiceTemplate"
- }
- },
- "401": {
- "description": "Authentication Error"
- },
- "403": {
- "description": "Authorization Error"
- },
- "404": {
- "description": "Resource Not Found"
- },
- "409": {
- "description": "Delete Conflict, Rule Violation"
- },
- "500": {
- "description": "Internal Server Error"
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Guilin"
- }
- }
- },
- "/policy/api/v1/policies" : {
- "get": {
- "tags": [
- "Policy"
- ],
- "summary": "Retrieve all versions of available policies",
- "description": "Returns all version of available policies",
- "operationId": "getPolicies",
- "consumes": [
- "application/json",
- "application/yaml"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- },
- {
- "name": "mode",
- "in": "query",
- "description": "Fetch mode for policies, BARE for bare policies (default), REFERENCED for fully referenced policies",
- "required": false,
- "type": "string",
- "default": "bare",
- "enum": [
- "BARE",
- "REFERENCED"
- ]
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "headers": {
- "X-MinorVersion": {
- "type": "string",
- "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion": {
- "type": "string",
- "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion": {
- "type": "string",
- "description": "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid",
- "description": "Used to track REST transactions for logging purpose"
- }
- },
- "schema": {
- "$ref": "#/definitions/ToscaServiceTemplate"
- }
- },
- "401": {
- "description": "Authentication Error"
- },
- "403": {
- "description": "Authorization Error"
- },
- "404": {
- "description": "Resource Not Found"
- },
- "500": {
- "description": "Internal Server Error"
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Guilin"
- }
- },
- "post" : {
- "tags" : [ "Policy" ],
- "summary" : "Create one or more new policies",
- "description" : "Create one or more new policies. Client should provide TOSCA body of the new policies",
- "operationId" : "createPolicies",
- "consumes" : [ "application/json", "application/yaml" ],
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Entity body of policies",
- "required" : true,
- "type" : "ToscaServiceTemplate",
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly created policies will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "400" : {
- "description" : "Invalid Body"
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "406" : {
- "description" : "Not Acceptable Version"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Frankfurt"
- }
- }
- }
- },
- "securityDefinitions" : {
- "basicAuth" : {
- "description" : "",
- "type" : "basic"
- }
- },
- "definitions" : {
- "ToscaConstraint" : {
- "type" : "object",
- "properties" : {
- "valid_values" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "equal" : {
- "type" : "string"
- },
- "greater_than" : {
- "type" : "string"
- },
- "greater_or_equal" : {
- "type" : "string"
- },
- "less_than" : {
- "type" : "string"
- },
- "less_or_equal" : {
- "type" : "string"
- }
- }
- },
- "ToscaDataType" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- },
- "properties" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaProperty"
- }
- }
- }
- },
- "ToscaEntrySchema" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "typeVersion" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- }
- }
- },
- "ToscaPolicyType" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "properties" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaProperty"
- }
- }
- }
- },
- "ToscaPolicyTypeIdentifier" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- }
- }
- },
- "ToscaProperty" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "typeVersion" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "default" : {
- "type" : "string"
- },
- "required" : {
- "type" : "boolean"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- },
- "entry_schema" : {
- "$ref" : "#/definitions/ToscaEntrySchema"
- }
- }
- },
- "ToscaServiceTemplate" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "tosca_definitions_version" : {
- "type" : "string"
- },
- "topology_template" : {
- "$ref" : "#/definitions/ToscaTopologyTemplate"
- },
- "policy_types" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaPolicyType"
- }
- }
- },
- "data_types" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaDataType"
- }
- }
- }
- }
- },
- "ToscaTopologyTemplate" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "policies" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaPolicy"
- }
- }
- }
- }
- }
- }
-} \ No newline at end of file
diff --git a/docs/api/swagger/policytype-api.json b/docs/api/swagger/policytype-api.json
deleted file mode 100644
index 627f318e..00000000
--- a/docs/api/swagger/policytype-api.json
+++ /dev/null
@@ -1,665 +0,0 @@
-{
- "swagger" : "2.0",
- "basePath" : "/",
- "tags" : [ {
- "name" : "PolicyType"
- } ],
- "schemes" : [ "http", "https" ],
- "paths" : {
- "/policy/api/v1/policytypes" : {
- "get" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Retrieve existing policy types",
- "description" : "Returns a list of existing policy types stored in Policy Framework",
- "operationId" : "getAllPolicyTypes",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; All policy types will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- },
- "post" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Create a new policy type",
- "description" : "Create a new policy type. Client should provide TOSCA body of the new policy type",
- "operationId" : "createPolicyType",
- "consumes" : [ "application/json", "application/yaml" ],
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "in" : "body",
- "name" : "body",
- "description" : "Entity body of policy type",
- "required" : true,
- "type" : "ToscaServiceTemplate",
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; The newly created policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "400" : {
- "description" : "Invalid Body"
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "406" : {
- "description" : "Not Acceptable Version"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}" : {
- "get" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Retrieve all available versions of a policy type",
- "description" : "Returns a list of all available versions for the specified policy type",
- "operationId" : "getAllVersionsOfPolicyType",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; All versions of specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}/versions/{versionId}" : {
- "get" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Retrieve one particular version of a policy type",
- "description" : "Returns a particular version for the specified policy type",
- "operationId" : "getSpecificVersionOfPolicyType",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "versionId",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; One specified version of specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- },
- "delete" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Delete one version of a policy type",
- "description" : "Delete one version of a policy type. It must follow two rules. Rule 1: pre-defined policy types cannot be deleted; Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted. The parameterizing TOSCA policies must be deleted first.",
- "operationId" : "deleteSpecificVersionOfPolicyType",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "versionId",
- "in" : "path",
- "description" : "Version of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Newly deleted policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "409" : {
- "description" : "Delete Conflict, Rule Violation"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- },
- "/policy/api/v1/policytypes/{policyTypeId}/versions/latest" : {
- "get" : {
- "tags" : [ "PolicyType" ],
- "summary" : "Retrieve latest version of a policy type",
- "description" : "Returns latest version for the specified policy type",
- "operationId" : "getLatestVersionOfPolicyType",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "policyTypeId",
- "in" : "path",
- "description" : "ID of policy type",
- "required" : true,
- "type" : "string"
- }, {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; Latest version of specified policy type will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/ToscaServiceTemplate"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "404" : {
- "description" : "Resource Not Found"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- }
- },
- "securityDefinitions" : {
- "basicAuth" : {
- "description" : "",
- "type" : "basic"
- }
- },
- "definitions" : {
- "ToscaConstraint" : {
- "type" : "object",
- "properties" : {
- "valid_values" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "equal" : {
- "type" : "string"
- },
- "greater_than" : {
- "type" : "string"
- },
- "greater_or_equal" : {
- "type" : "string"
- },
- "less_than" : {
- "type" : "string"
- },
- "less_or_equal" : {
- "type" : "string"
- }
- }
- },
- "ToscaDataType" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- },
- "properties" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaProperty"
- }
- }
- }
- },
- "ToscaEntrySchema" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "typeVersion" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- }
- }
- },
- "ToscaPolicyType" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "properties" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaProperty"
- }
- }
- }
- },
- "ToscaPolicyTypeIdentifier" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- }
- }
- },
- "ToscaProperty" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "typeVersion" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "default" : {
- "type" : "string"
- },
- "required" : {
- "type" : "boolean"
- },
- "status" : {
- "type" : "string",
- "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
- },
- "constraints" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/definitions/ToscaConstraint"
- }
- },
- "entry_schema" : {
- "$ref" : "#/definitions/ToscaEntrySchema"
- }
- }
- },
- "ToscaServiceTemplate" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- },
- "derived_from" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "description" : {
- "type" : "string"
- },
- "tosca_definitions_version" : {
- "type" : "string"
- },
- "topology_template" : {
- "$ref" : "#/definitions/ToscaTopologyTemplate"
- },
- "policy_types" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaPolicyType"
- }
- }
- },
- "data_types" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaDataType"
- }
- }
- }
- }
- },
- "ToscaTopologyTemplate" : {
- "type" : "object",
- "properties" : {
- "description" : {
- "type" : "string"
- },
- "policies" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/definitions/ToscaPolicy"
- }
- }
- }
- }
- }
- }
-}
diff --git a/docs/api/swagger/statistics-api.json b/docs/api/swagger/statistics-api.json
deleted file mode 100644
index f41900c0..00000000
--- a/docs/api/swagger/statistics-api.json
+++ /dev/null
@@ -1,147 +0,0 @@
-{
- "swagger" : "2.0",
- "basePath" : "/",
- "tags" : [{
- "name" : "Statistics"
- }],
- "schemes" : [ "http", "https" ],
- "paths" : {
- "/policy/api/v1/statistics" : {
- "get" : {
- "tags" : [ "Statistics" ],
- "summary" : "Retrieve current statistics",
- "description" : "Returns current statistics including the counters of API invocation",
- "operationId" : "getStatistics",
- "produces" : [ "application/json", "application/yaml" ],
- "parameters" : [ {
- "name" : "X-ONAP-RequestID",
- "in" : "header",
- "description" : "RequestID for http transaction",
- "required" : false,
- "type" : "string",
- "format" : "uuid"
- } ],
- "responses" : {
- "200" : {
- "description" : "successful operation; All statistics counters of API invocation will be returned.",
- "headers" : {
- "X-MinorVersion" : {
- "type" : "string",
- "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
- },
- "X-PatchVersion" : {
- "type" : "string",
- "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
- },
- "X-LatestVersion" : {
- "type" : "string",
- "description" : "Used only to communicate an API's latest version"
- },
- "X-ONAP-RequestID" : {
- "type" : "string",
- "format" : "uuid",
- "description" : "Used to track REST transactions for logging purpose"
- }
- },
- "schema" : {
- "$ref" : "#/definitions/StatisticsReport"
- }
- },
- "401" : {
- "description" : "Authentication Error"
- },
- "403" : {
- "description" : "Authorization Error"
- },
- "500" : {
- "description" : "Internal Server Error"
- }
- },
- "security" : [ {
- "basicAuth" : [ ]
- } ],
- "x-interface info" : {
- "api-version" : "1.0.0",
- "last-mod-release" : "Dublin"
- }
- }
- }
- },
- "securityDefinitions" : {
- "basicAuth" : {
- "description" : "",
- "type" : "basic"
- }
- },
- "definitions" : {
- "StatisticsReport" : {
- "type" : "object",
- "properties" : {
- "code" : {
- "type" : "integer",
- "format" : "int32"
- },
- "totalApiCallCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "apiCallSuccessCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "apiCallFailureCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "totalPolicyGetCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "totalPolicyPostCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "totalPolicyTypeGetCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "totalPolicyTypePostCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyGetSuccessCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyGetFailureCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyPostSuccessCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyPostFailureCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyTypeGetSuccessCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyTypeGetFailureCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyTypePostSuccessCount" : {
- "type" : "integer",
- "format" : "int64"
- },
- "policyTypePostFailureCount" : {
- "type" : "integer",
- "format" : "int64"
- }
- }
- }
- }
-}