"schema" : {
"type" : "string"
}
+ }, {
+ "description" : "model",
+ "in" : "query",
+ "name" : "model",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"200" : {
"schema" : {
"type" : "string"
}
+ }, {
+ "description" : "model",
+ "in" : "query",
+ "name" : "model",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"200" : {
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "componentModel",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"200" : {
"schema" : {
"type" : "string"
}
- } ],
- "responses" : {
- "200" : {
- "description" : "Interface lifecycle types"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Interface lifecycle types not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "allowedMethods" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "cookies" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "comment" : {
- "type" : "string"
- },
- "domain" : {
- "type" : "string"
- },
- "expiry" : {
- "type" : "string",
- "format" : "date-time"
- },
- "httpOnly" : {
- "type" : "boolean"
- },
- "maxAge" : {
- "type" : "integer",
- "format" : "int32"
- },
- "name" : {
- "type" : "string"
- },
- "path" : {
- "type" : "string"
- },
- "secure" : {
- "type" : "boolean"
- },
- "value" : {
- "type" : "string"
- },
- "version" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- }
- },
- "date" : {
- "type" : "string",
- "format" : "date-time"
- },
- "entity" : {
- "type" : "object"
- },
- "entityTag" : {
- "type" : "object",
- "properties" : {
- "value" : {
- "type" : "string"
- },
- "weak" : {
- "type" : "boolean"
- }
- }
- },
- "headers" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "language" : {
- "type" : "object",
- "properties" : {
- "country" : {
- "type" : "string"
- },
- "displayCountry" : {
- "type" : "string"
- },
- "displayLanguage" : {
- "type" : "string"
- },
- "displayName" : {
- "type" : "string"
- },
- "displayScript" : {
- "type" : "string"
- },
- "displayVariant" : {
- "type" : "string"
- },
- "extensionKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "iso3Country" : {
- "type" : "string"
- },
- "iso3Language" : {
- "type" : "string"
- },
- "language" : {
- "type" : "string"
- },
- "script" : {
- "type" : "string"
- },
- "unicodeLocaleAttributes" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "unicodeLocaleKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "variant" : {
- "type" : "string"
- }
- }
- },
- "lastModified" : {
- "type" : "string",
- "format" : "date-time"
- },
- "length" : {
- "type" : "integer",
- "format" : "int32"
- },
- "links" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "params" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "rel" : {
- "type" : "string"
- },
- "rels" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "title" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "uri" : {
- "type" : "string",
- "format" : "uri"
- },
- "uriBuilder" : {
- "type" : "object"
- }
- }
- },
- "uniqueItems" : true
- },
- "location" : {
- "type" : "string",
- "format" : "uri"
- },
- "mediaType" : {
- "type" : "object",
- "properties" : {
- "parameters" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "subtype" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "wildcardSubtype" : {
- "type" : "boolean"
- },
- "wildcardType" : {
- "type" : "boolean"
- }
- }
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "status" : {
- "type" : "integer",
- "format" : "int32"
- },
- "statusInfo" : {
- "type" : "object",
- "properties" : {
- "family" : {
- "type" : "string",
- "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
- },
- "reasonPhrase" : {
- "type" : "string"
- },
- "statusCode" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- },
- "stringHeaders" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns interface lifecycle types",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/nodeTypes" : {
- "get" : {
- "description" : "Get node types",
- "operationId" : "getAllNodeTypesServlet",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
+ }, {
+ "description" : "model",
+ "in" : "query",
+ "name" : "model",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "nodeTypes"
+ "description" : "Interface lifecycle types"
},
"400" : {
"description" : "Invalid content / Missing content"
"description" : "Restricted operation"
},
"404" : {
- "description" : "Node types not found"
+ "description" : "Interface lifecycle types not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns node types",
+ "summary" : "Returns interface lifecycle types",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/notif/vsp/archived" : {
+ "/v1/catalog/lock" : {
"post" : {
- "description" : "Notify about an archived VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=true",
- "operationId" : "onVspArchived",
+ "description" : "Toggle disable locking",
+ "operationId" : "toggleDisableLocking",
"parameters" : [ {
"in" : "header",
"name" : "USER_ID",
"content" : {
"application/json" : {
"schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "type" : "boolean"
}
}
- }
+ },
+ "description" : "Disable Locking"
},
"responses" : {
"200" : {
- "description" : "Success"
- },
- "400" : {
- "description" : "Bad request"
- },
- "403" : {
- "description" : "Restricted operation"
+ "description" : "Disable locking successfully updated"
},
"500" : {
- "description" : "Internal Error. A list of the failed CSAR IDs may be returned."
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/notif/vsp/restored" : {
- "post" : {
- "description" : "Notify about a restored VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=false",
- "operationId" : "onVspRestored",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
+ "description" : "Update disable locking failed"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
}
}
}
}
},
- "responses" : {
- "200" : {
- "description" : "Success"
- },
- "400" : {
- "description" : "Bad request"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "500" : {
- "description" : "Internal Error. A list of the failed CSAR IDs may be returned."
- }
- },
"servers" : [ {
"url" : "/sdc2/rest",
"variables" : { }
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/policyTypes" : {
+ "/v1/catalog/model" : {
"get" : {
- "description" : "Get policy types ",
- "operationId" : "getPolicyTypes",
+ "description" : "List all the existing TOSCA models",
+ "operationId" : "listModels",
"parameters" : [ {
- "description" : "An optional parameter to indicate the type of the container from where this call is executed",
- "in" : "query",
- "name" : "internalComponentType",
+ "in" : "header",
+ "name" : "USER_ID",
"schema" : {
"type" : "string"
}
}, {
- "description" : "The user id",
- "in" : "header",
- "name" : "USER_ID",
- "required" : true,
+ "in" : "query",
+ "name" : "modelType",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "policy types found"
+ "description" : "Listing successful"
},
"403" : {
"description" : "Restricted operation"
},
- "500" : {
- "description" : "The GET request failed due to internal SDC problem."
- },
"default" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/PolicyTypeDefinition"
+ "$ref" : "#/components/schemas/Model"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns policy types",
+ "summary" : "List TOSCA models",
"tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/relationshipTypes" : {
- "get" : {
- "description" : "Get relationship types",
- "operationId" : "getAllRelationshipTypesServlet",
+ },
+ "post" : {
+ "description" : "Create a TOSCA model, along with its imports files",
+ "operationId" : "createModel",
"parameters" : [ {
"in" : "header",
"name" : "USER_ID",
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "multipart/form-data" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "model" : {
+ "$ref" : "#/components/schemas/ModelCreateRequest"
+ },
+ "modelImportsZip" : {
+ "type" : "object",
+ "description" : "the model TOSCA imports zipped"
+ }
+ },
+ "required" : [ "model", "modelImportsZip" ]
+ }
+ }
+ }
+ },
"responses" : {
- "200" : {
- "description" : "relationshipTypes"
+ "201" : {
+ "description" : "Model created"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Relationship types not found"
+ "409" : {
+ "description" : "Model already exists"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns relationship types",
+ "summary" : "Create a TOSCA model",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/resources" : {
- "post" : {
- "description" : "Create Resource",
- "operationId" : "createResource",
+ "/v1/catalog/model/imports" : {
+ "put" : {
+ "description" : "Update a model TOSCA imports",
+ "operationId" : "updateModelImports",
"parameters" : [ {
"in" : "header",
"name" : "USER_ID",
} ],
"requestBody" : {
"content" : {
- "application/json" : {
+ "multipart/form-data" : {
"schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Resource object to be created",
- "required" : true
- },
- "responses" : {
- "201" : {
- "description" : "Resource created"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "409" : {
- "description" : "Resource already exist"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
+ "type" : "object",
+ "properties" : {
+ "modelImportsZip" : {
+ "type" : "object",
+ "description" : "the model TOSCA imports zipped"
+ },
+ "modelName" : {
+ "type" : "string",
+ "description" : "model to be created"
}
- }
+ },
+ "required" : [ "modelImportsZip", "modelName" ]
}
}
}
},
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns created resource",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/certified/abstract" : {
- "get" : {
- "operationId" : "getCertifiedAbstractResources",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "default" : {
- "content" : {
- "application/json" : { }
- },
- "description" : "default response"
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/certified/notabstract" : {
- "get" : {
- "operationId" : "getCertifiedNotAbstractResources",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "default" : {
- "content" : {
- "application/json" : { }
- },
- "description" : "default response"
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/csar/{csaruuid}" : {
- "get" : {
- "description" : "Create Resource",
- "operationId" : "getResourceFromCsar",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "csaruuid",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
"responses" : {
- "201" : {
- "description" : "Resource retrieced"
+ "204" : {
+ "description" : "Model imports updated"
},
"400" : {
"description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns resource created from csar uuid",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/importReplaceResource" : {
- "post" : {
- "description" : "Import Resource",
- "operationId" : "importReplaceResource",
- "parameters" : [ {
- "description" : "The user id",
- "in" : "header",
- "name" : "USER_ID",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "X-ECOMP-RequestID header",
- "in" : "header",
- "name" : "X-ECOMP-RequestID",
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "X-ECOMP-InstanceID header",
- "in" : "header",
- "name" : "X-ECOMP-InstanceID",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "Determines the format of the body of the response",
- "in" : "header",
- "name" : "Accept",
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "The username and password",
- "in" : "header",
- "name" : "Authorization",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "*/*" : {
- "schema" : {
- "type" : "object",
- "properties" : {
- "resourceZip" : {
- "$ref" : "#/components/schemas/FormDataContentDisposition"
- },
- "resourceZipMetadata" : {
- "type" : "string",
- "description" : "resourceMetadata"
- }
- }
- }
- }
- }
- },
- "responses" : {
- "201" : {
- "description" : "Resource created"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "409" : {
- "description" : "Resource already exist"
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns imported resource",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}" : {
- "get" : {
- "description" : "Retrieve Resource by name and version",
- "operationId" : "getResourceByNameAndVersion",
- "parameters" : [ {
- "in" : "path",
- "name" : "resourceName",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "resourceVersion",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Resource found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Resource not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns resource according to resourceId",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/validate-name/{resourceName}" : {
- "get" : {
- "description" : "validate resource name",
- "operationId" : "validateResourceName",
- "parameters" : [ {
- "in" : "path",
- "name" : "resourceName",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "subtype",
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Resource found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "checks if the chosen resource name is available ",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/{componentId}/archive" : {
- "post" : {
- "description" : "Archive Resource",
- "operationId" : "archiveResources",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Archive successful"
- },
- "400" : {
- "description" : "Bad request"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Resource not found"
- },
- "500" : {
- "description" : "Internal Error"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Marks a resource as archived. Can be restored with restore action",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/{componentId}/restore" : {
- "post" : {
- "description" : "Restore Resource",
- "operationId" : "restoreResource",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Restore successful"
- },
- "400" : {
- "description" : "Bad request"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Resource not found"
- },
- "500" : {
- "description" : "Internal Error"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Restores a resource from archive.",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/{resourceId}" : {
- "delete" : {
- "operationId" : "deleteResource",
- "parameters" : [ {
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "default" : {
- "content" : {
- "*/*" : { }
- },
- "description" : "default response"
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "tags" : [ "SDCE-2 APIs" ]
- },
- "get" : {
- "description" : "Retrieve Resource",
- "operationId" : "getResourceById",
- "parameters" : [ {
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Resource found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Resource not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns resource according to resourceId",
- "tags" : [ "SDCE-2 APIs" ]
- },
- "put" : {
- "description" : "Update Resource",
- "operationId" : "updateResource",
- "parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Resource object to be updated",
- "required" : true
- },
- "responses" : {
- "200" : {
- "description" : "Resource updated"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "409" : {
- "description" : "Resource already exist"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns updated resource",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/resources/{resourceId}/additionalinfo" : {
- "get" : {
- "description" : "Get all Additional Information under resource",
- "operationId" : "getAllResourceAdditionalInformationLabel",
- "parameters" : [ {
- "description" : "resource id to update with new property",
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "list of additional information"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "409" : {
- "description" : "Additional information key already exist"
+ },
+ "404" : {
+ "description" : "Model not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns Additional Inforamtion property",
+ "summary" : "Update a model TOSCA imports",
"tags" : [ "SDCE-2 APIs" ]
- },
- "post" : {
- "description" : "Create Additional Information Label and Value",
- "operationId" : "createResourceAdditionalInformationLabel",
+ }
+ },
+ "/v1/catalog/nodeTypes" : {
+ "get" : {
+ "description" : "Get node types",
+ "operationId" : "getAllNodeTypesServlet",
"parameters" : [ {
- "description" : "resource id to update with new property",
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "header",
"name" : "USER_ID",
"schema" : {
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Additional information key value to be created",
- "required" : true
- },
"responses" : {
- "201" : {
- "description" : "Additional information created"
+ "200" : {
+ "description" : "nodeTypes"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "409" : {
- "description" : "Additional information key already exist"
+ "404" : {
+ "description" : "Node types not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns created Additional Inforamtion property",
+ "summary" : "Returns node types",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/resources/{resourceId}/additionalinfo/{labelId}" : {
- "delete" : {
- "description" : "Create Additional Information Label and Value",
- "operationId" : "updateResourceAdditionalInformationLabel",
+ "/v1/catalog/notif/vsp/archived" : {
+ "post" : {
+ "description" : "Notify about an archived VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=true",
+ "operationId" : "onVspArchived",
"parameters" : [ {
- "description" : "resource id to update with new property",
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
+ "in" : "header",
+ "name" : "USER_ID",
"schema" : {
"type" : "string"
}
- }, {
- "description" : "label id",
- "in" : "path",
- "name" : "labelId",
- "required" : true,
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Success"
+ },
+ "400" : {
+ "description" : "Bad request"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "500" : {
+ "description" : "Internal Error. A list of the failed CSAR IDs may be returned."
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/notif/vsp/restored" : {
+ "post" : {
+ "description" : "Notify about a restored VSP. All VFs with relation to the given CSAR IDs will be martked as vspArchived=false",
+ "operationId" : "onVspRestored",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Success"
+ },
+ "400" : {
+ "description" : "Bad request"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "500" : {
+ "description" : "Internal Error. A list of the failed CSAR IDs may be returned."
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/policyTypes" : {
+ "get" : {
+ "description" : "Get policy types ",
+ "operationId" : "getPolicyTypes",
+ "parameters" : [ {
+ "description" : "An optional parameter to indicate the type of the container from where this call is executed",
+ "in" : "query",
+ "name" : "internalComponentType",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "componentModel",
"schema" : {
"type" : "string"
}
}, {
+ "description" : "The user id",
"in" : "header",
"name" : "USER_ID",
+ "required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "Additional information deleted"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "description" : "policy types found"
},
"403" : {
"description" : "Restricted operation"
},
- "409" : {
- "description" : "Additional information key already exist"
+ "500" : {
+ "description" : "The GET request failed due to internal SDC problem."
},
"default" : {
"content" : {
"schema" : {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : {
- "allowedMethods" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "cookies" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "comment" : {
- "type" : "string"
- },
- "domain" : {
- "type" : "string"
- },
- "expiry" : {
- "type" : "string",
- "format" : "date-time"
- },
- "httpOnly" : {
- "type" : "boolean"
- },
- "maxAge" : {
- "type" : "integer",
- "format" : "int32"
- },
- "name" : {
- "type" : "string"
- },
- "path" : {
- "type" : "string"
- },
- "secure" : {
- "type" : "boolean"
- },
- "value" : {
- "type" : "string"
- },
- "version" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- }
- },
- "date" : {
- "type" : "string",
- "format" : "date-time"
- },
- "entity" : {
- "type" : "object"
- },
- "entityTag" : {
- "type" : "object",
- "properties" : {
- "value" : {
- "type" : "string"
- },
- "weak" : {
- "type" : "boolean"
- }
- }
- },
- "headers" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "language" : {
- "type" : "object",
- "properties" : {
- "country" : {
- "type" : "string"
- },
- "displayCountry" : {
- "type" : "string"
- },
- "displayLanguage" : {
- "type" : "string"
- },
- "displayName" : {
- "type" : "string"
- },
- "displayScript" : {
- "type" : "string"
- },
- "displayVariant" : {
- "type" : "string"
- },
- "extensionKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "iso3Country" : {
- "type" : "string"
- },
- "iso3Language" : {
- "type" : "string"
- },
- "language" : {
- "type" : "string"
- },
- "script" : {
- "type" : "string"
- },
- "unicodeLocaleAttributes" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "unicodeLocaleKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "variant" : {
- "type" : "string"
- }
- }
- },
- "lastModified" : {
- "type" : "string",
- "format" : "date-time"
- },
- "length" : {
- "type" : "integer",
- "format" : "int32"
- },
- "links" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "params" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "rel" : {
- "type" : "string"
- },
- "rels" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "title" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "uri" : {
- "type" : "string",
- "format" : "uri"
- },
- "uriBuilder" : {
- "type" : "object"
- }
- }
- },
- "uniqueItems" : true
- },
- "location" : {
- "type" : "string",
- "format" : "uri"
- },
- "mediaType" : {
- "type" : "object",
- "properties" : {
- "parameters" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "subtype" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "wildcardSubtype" : {
- "type" : "boolean"
- },
- "wildcardType" : {
- "type" : "boolean"
- }
- }
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "status" : {
- "type" : "integer",
- "format" : "int32"
- },
- "statusInfo" : {
- "type" : "object",
- "properties" : {
- "family" : {
- "type" : "string",
- "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
- },
- "reasonPhrase" : {
- "type" : "string"
- },
- "statusCode" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- },
- "stringHeaders" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
+ "$ref" : "#/components/schemas/PolicyTypeDefinition"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted Additional Inforamtion property",
+ "summary" : "Returns policy types",
"tags" : [ "SDCE-2 APIs" ]
- },
+ }
+ },
+ "/v1/catalog/relationshipTypes" : {
"get" : {
- "description" : "Get Additional Information by id",
- "operationId" : "getResourceAdditionalInformationLabel",
+ "description" : "Get relationship types",
+ "operationId" : "getAllRelationshipTypesServlet",
"parameters" : [ {
- "description" : "resource id to update with new property",
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "label id",
- "in" : "path",
- "name" : "labelId",
- "required" : true,
+ "in" : "header",
+ "name" : "USER_ID",
"schema" : {
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
+ "description" : "model",
+ "in" : "query",
+ "name" : "model",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "fetched additional information"
+ "description" : "relationshipTypes"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "409" : {
- "description" : "Additional information key already exist"
+ "404" : {
+ "description" : "Relationship types not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns Additional Inforamtion property",
+ "summary" : "Returns relationship types",
"tags" : [ "SDCE-2 APIs" ]
- },
- "put" : {
- "description" : "Update Additional Information Label and Value",
- "operationId" : "updateResourceAdditionalInformationLabel_1",
+ }
+ },
+ "/v1/catalog/resources" : {
+ "post" : {
+ "description" : "Create Resource",
+ "operationId" : "createResource",
"parameters" : [ {
- "description" : "resource id to update with new property",
- "in" : "path",
- "name" : "resourceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "label id",
- "in" : "path",
- "name" : "labelId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "header",
"name" : "USER_ID",
"schema" : {
}
}
},
- "description" : "Additional information key value to be created",
+ "description" : "Resource object to be created",
"required" : true
},
"responses" : {
- "200" : {
- "description" : "Additional information updated"
+ "201" : {
+ "description" : "Resource created"
},
"400" : {
"description" : "Invalid content / Missing content"
"description" : "Restricted operation"
},
"409" : {
- "description" : "Additional information key already exist"
+ "description" : "Resource already exist"
},
"default" : {
"content" : {
"schema" : {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : {
- "allowedMethods" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "cookies" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "comment" : {
- "type" : "string"
- },
- "domain" : {
- "type" : "string"
- },
- "expiry" : {
- "type" : "string",
- "format" : "date-time"
- },
- "httpOnly" : {
- "type" : "boolean"
- },
- "maxAge" : {
- "type" : "integer",
- "format" : "int32"
- },
- "name" : {
- "type" : "string"
- },
- "path" : {
- "type" : "string"
- },
- "secure" : {
- "type" : "boolean"
- },
- "value" : {
- "type" : "string"
- },
- "version" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- }
- },
- "date" : {
- "type" : "string",
- "format" : "date-time"
- },
- "entity" : {
- "type" : "object"
- },
- "entityTag" : {
- "type" : "object",
- "properties" : {
- "value" : {
- "type" : "string"
- },
- "weak" : {
- "type" : "boolean"
- }
- }
- },
- "headers" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "language" : {
- "type" : "object",
- "properties" : {
- "country" : {
- "type" : "string"
- },
- "displayCountry" : {
- "type" : "string"
- },
- "displayLanguage" : {
- "type" : "string"
- },
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns created resource",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/certified/abstract" : {
+ "get" : {
+ "operationId" : "getCertifiedAbstractResources",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "application/json" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/certified/notabstract" : {
+ "get" : {
+ "operationId" : "getCertifiedNotAbstractResources",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "application/json" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/csar/{csaruuid}" : {
+ "get" : {
+ "description" : "Create Resource",
+ "operationId" : "getResourceFromCsar",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "csaruuid",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "201" : {
+ "description" : "Resource retrieced"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns resource created from csar uuid",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/importReplaceResource" : {
+ "post" : {
+ "description" : "Import Resource",
+ "operationId" : "importReplaceResource",
+ "parameters" : [ {
+ "description" : "The user id",
+ "in" : "header",
+ "name" : "USER_ID",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "X-ECOMP-RequestID header",
+ "in" : "header",
+ "name" : "X-ECOMP-RequestID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "X-ECOMP-InstanceID header",
+ "in" : "header",
+ "name" : "X-ECOMP-InstanceID",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "Determines the format of the body of the response",
+ "in" : "header",
+ "name" : "Accept",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "The username and password",
+ "in" : "header",
+ "name" : "Authorization",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "resourceZip" : {
+ "$ref" : "#/components/schemas/FormDataContentDisposition"
+ },
+ "resourceZipMetadata" : {
+ "type" : "string",
+ "description" : "resourceMetadata"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "201" : {
+ "description" : "Resource created"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Resource already exist"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns imported resource",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/resourceName/{resourceName}/resourceVersion/{resourceVersion}" : {
+ "get" : {
+ "description" : "Retrieve Resource by name and version",
+ "operationId" : "getResourceByNameAndVersion",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "resourceName",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "resourceVersion",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Resource found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Resource not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns resource according to resourceId",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/validate-name/{resourceName}" : {
+ "get" : {
+ "description" : "validate resource name",
+ "operationId" : "validateResourceName",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "resourceName",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "subtype",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Resource found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "checks if the chosen resource name is available ",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/{componentId}/archive" : {
+ "post" : {
+ "description" : "Archive Resource",
+ "operationId" : "archiveResources",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Archive successful"
+ },
+ "400" : {
+ "description" : "Bad request"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Resource not found"
+ },
+ "500" : {
+ "description" : "Internal Error"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Marks a resource as archived. Can be restored with restore action",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/{componentId}/restore" : {
+ "post" : {
+ "description" : "Restore Resource",
+ "operationId" : "restoreResource",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Restore successful"
+ },
+ "400" : {
+ "description" : "Bad request"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Resource not found"
+ },
+ "500" : {
+ "description" : "Internal Error"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Restores a resource from archive.",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/{resourceId}" : {
+ "delete" : {
+ "operationId" : "deleteResource",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "*/*" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "get" : {
+ "description" : "Retrieve Resource",
+ "operationId" : "getResourceById",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Resource found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Resource not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns resource according to resourceId",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "put" : {
+ "description" : "Update Resource",
+ "operationId" : "updateResource",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Resource object to be updated",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Resource updated"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Resource already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns updated resource",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/{resourceId}/additionalinfo" : {
+ "get" : {
+ "description" : "Get all Additional Information under resource",
+ "operationId" : "getAllResourceAdditionalInformationLabel",
+ "parameters" : [ {
+ "description" : "resource id to update with new property",
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "list of additional information"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Additional information key already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns Additional Inforamtion property",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "post" : {
+ "description" : "Create Additional Information Label and Value",
+ "operationId" : "createResourceAdditionalInformationLabel",
+ "parameters" : [ {
+ "description" : "resource id to update with new property",
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Additional information key value to be created",
+ "required" : true
+ },
+ "responses" : {
+ "201" : {
+ "description" : "Additional information created"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Additional information key already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns created Additional Inforamtion property",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/resources/{resourceId}/additionalinfo/{labelId}" : {
+ "delete" : {
+ "description" : "Create Additional Information Label and Value",
+ "operationId" : "updateResourceAdditionalInformationLabel",
+ "parameters" : [ {
+ "description" : "resource id to update with new property",
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "label id",
+ "in" : "path",
+ "name" : "labelId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Additional information deleted"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Additional information key already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns deleted Additional Inforamtion property",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "get" : {
+ "description" : "Get Additional Information by id",
+ "operationId" : "getResourceAdditionalInformationLabel",
+ "parameters" : [ {
+ "description" : "resource id to update with new property",
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "label id",
+ "in" : "path",
+ "name" : "labelId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "fetched additional information"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Additional information key already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns Additional Inforamtion property",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "put" : {
+ "description" : "Update Additional Information Label and Value",
+ "operationId" : "updateResourceAdditionalInformationLabel_1",
+ "parameters" : [ {
+ "description" : "resource id to update with new property",
+ "in" : "path",
+ "name" : "resourceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "label id",
+ "in" : "path",
+ "name" : "labelId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Additional information key value to be created",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Additional information updated"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Additional information key already exist"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
"displayName" : {
"type" : "string"
},
"type" : "string",
"format" : "binary",
"description" : "FileInputStream"
+ },
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
}
}
}
"type" : "string",
"format" : "binary",
"description" : "FileInputStream"
+ },
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
}
}
}
"format" : "binary",
"description" : "FileInputStream"
},
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
+ },
"toscaTypeMetadata" : {
"type" : "string",
"description" : "toscaTypeMetadata"
"schema" : {
"type" : "object",
"properties" : {
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
"interfaceLifecycleTypeZip" : {
"type" : "string",
"format" : "binary",
"description" : "FileInputStream"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
}
}
}
"schema" : {
"type" : "object",
"properties" : {
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
+ },
"policyTypesZip" : {
"type" : "string",
"format" : "binary",
"schema" : {
"type" : "object",
"properties" : {
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model"
+ },
"relationshipTypeZip" : {
"type" : "string",
"format" : "binary",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "componentModel",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "includeNormativeExtensionModels",
+ "schema" : {
+ "type" : "boolean"
+ }
}, {
"in" : "header",
"name" : "USER_ID",
"schema" : {
"type" : "string"
}
- }, {
- "in" : "query",
- "name" : "searchText",
- "schema" : {
- "type" : "string"
- }
+ }, {
+ "in" : "query",
+ "name" : "searchText",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "uid list",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns component instances",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties" : {
+ "get" : {
+ "description" : "Get properties",
+ "operationId" : "getInputPropertiesForComponentInstance",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "instanceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "inputId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns properties list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs" : {
+ "get" : {
+ "description" : "Get Inputs only",
+ "operationId" : "getComponentInstanceInputs",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "instanceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "originComponentUid",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns Inputs list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs" : {
+ "get" : {
+ "description" : "Get Outputs only",
+ "operationId" : "getComponentInstanceOutputs",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "instanceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "originComponentUid",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns Outputs list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/create/input" : {
+ "post" : {
+ "description" : "Create inputs on service",
+ "operationId" : "createInput",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "ComponentIns Inputs Object to be created",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Return inputs list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/create/inputs" : {
+ "post" : {
+ "description" : "Create inputs on service",
+ "operationId" : "createMultipleInputs",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "ComponentIns Inputs Object to be created",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Return inputs list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/create/listInput" : {
+ "post" : {
+ "description" : "Create a list input on service",
+ "operationId" : "createListInput",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
"in" : "header",
"name" : "USER_ID",
}
}
},
- "description" : "uid list",
+ "description" : "ComponentIns Inputs Object to be created",
"required" : true
},
"responses" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns component instances",
+ "summary" : "Return input",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{inputId}/properties" : {
- "get" : {
- "description" : "Get properties",
- "operationId" : "getInputPropertiesForComponentInstance",
+ "/v1/catalog/{componentType}/{componentId}/create/outputs" : {
+ "post" : {
+ "description" : "Create outputs on service",
+ "operationId" : "createMultipleOutputs",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"type" : "string"
}
}, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "ComponentIns Outputs Object to be created",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Return outputs list",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/create/policies" : {
+ "post" : {
+ "description" : "Create policies on service",
+ "operationId" : "declareProperties",
+ "parameters" : [ {
"in" : "path",
- "name" : "instanceId",
+ "name" : "componentType",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
- "name" : "inputId",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "ComponentIns policies Object to be created",
+ "required" : true
+ },
"responses" : {
"200" : {
"description" : "Component found"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns properties list",
+ "summary" : "Return policies list",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/inputs" : {
- "get" : {
- "description" : "Get Inputs only",
- "operationId" : "getComponentInstanceInputs",
+ "/v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}" : {
+ "delete" : {
+ "description" : "Delete data type from service",
+ "operationId" : "deleteDataType",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
}
}, {
"in" : "path",
- "name" : "instanceId",
+ "name" : "dataTypeName",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Data type deleted"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Data type not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Delete service input",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "get" : {
+ "description" : "Get data type in service",
+ "operationId" : "getDataType",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
- "name" : "originComponentUid",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
+ "in" : "path",
+ "name" : "dataTypeName",
+ "required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "Component found"
+ "description" : "Data type found"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
+ "description" : "Data type not found"
},
"default" : {
"content" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "$ref" : "#/components/schemas/DataTypeDefinition"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns Inputs list",
+ "summary" : "Get data type in service",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/componentInstances/{instanceId}/{originComponentUid}/outputs" : {
+ "/v1/catalog/{componentType}/{componentId}/dataTypes" : {
"get" : {
- "description" : "Get Outputs only",
- "operationId" : "getComponentInstanceOutputs",
+ "description" : "Get data types that service has",
+ "operationId" : "getDataTypes",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"schema" : {
"type" : "string"
}
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Data type found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Get data types in service",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/delete/{inputId}/input" : {
+ "delete" : {
+ "description" : "Delete input from service",
+ "operationId" : "deleteInput",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
"in" : "path",
- "name" : "instanceId",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
- "name" : "originComponentUid",
+ "name" : "inputId",
"required" : true,
"schema" : {
"type" : "string"
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Service Input to be deleted",
+ "required" : true
+ },
"responses" : {
"200" : {
- "description" : "Component found"
+ "description" : "Input deleted"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
+ "description" : "Input not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns Outputs list",
+ "summary" : "Delete service input",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/create/input" : {
- "post" : {
- "description" : "Create inputs on service",
- "operationId" : "createInput",
+ "/v1/catalog/{componentType}/{componentId}/delete/{outputId}/output" : {
+ "delete" : {
+ "description" : "Delete output from service",
+ "operationId" : "deleteOutput",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "outputId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
"in" : "header",
"name" : "USER_ID",
}
}
},
- "description" : "ComponentIns Inputs Object to be created",
+ "description" : "Service Output to be deleted",
"required" : true
},
"responses" : {
"200" : {
- "description" : "Component found"
+ "description" : "Output deleted"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
+ "description" : "Output not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Return inputs list",
+ "summary" : "Delete service output",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/create/inputs" : {
- "post" : {
- "description" : "Create inputs on service",
- "operationId" : "createMultipleInputs",
+ "/v1/catalog/{componentType}/{componentId}/dependencies" : {
+ "get" : {
+ "description" : "Autometed upgrade",
+ "operationId" : "getComponentDependencies",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"content" : {
"application/json" : {
"schema" : {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}
}
},
- "description" : "ComponentIns Inputs Object to be created",
+ "description" : "Consumer Object to be created",
"required" : true
},
"responses" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Return inputs list",
+ "summary" : "....",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/create/listInput" : {
- "post" : {
- "description" : "Create a list input on service",
- "operationId" : "createListInput",
+ "/v1/catalog/{componentType}/{componentId}/filteredDataByParams" : {
+ "get" : {
+ "description" : "Retrieve Resource",
+ "operationId" : "getComponentDataFilteredByParams",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "include",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
}, {
"in" : "header",
"name" : "USER_ID",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "ComponentIns Inputs Object to be created",
- "required" : true
- },
"responses" : {
"200" : {
- "description" : "Component found"
+ "description" : "Resource found"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
+ "description" : "Resource not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Return input",
+ "summary" : "Returns resource according to resourceId",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/create/outputs" : {
- "post" : {
- "description" : "Create outputs on service",
- "operationId" : "createMultipleOutputs",
+ "/v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}" : {
+ "get" : {
+ "description" : "Retrieve properties belonging to component instances of specific component by name and optionally resource type",
+ "operationId" : "getFilteredComponentInstanceProperties",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "ComponentIns Outputs Object to be created",
- "required" : true
- },
- "responses" : {
- "200" : {
- "description" : "Component found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Return outputs list",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/create/policies" : {
- "post" : {
- "description" : "Create policies on service",
- "operationId" : "declareProperties",
- "parameters" : [ {
"in" : "path",
- "name" : "componentType",
+ "name" : "propertyNameFragment",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
+ "in" : "query",
+ "name" : "resourceType",
"schema" : {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
}
}, {
"in" : "header",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "ComponentIns policies Object to be created",
- "required" : true
- },
"responses" : {
"200" : {
"description" : "Component found"
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "type" : "string"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Return policies list",
+ "summary" : "Returns properties belonging to component instances of specific component by name and optionally resource type",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/dataType/{dataTypeName}" : {
- "delete" : {
- "description" : "Delete data type from service",
- "operationId" : "deleteDataType",
+ "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}" : {
+ "get" : {
+ "description" : "Get inputs",
+ "operationId" : "getInputsAndPropertiesForComponentInput",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
}
}, {
"in" : "path",
- "name" : "dataTypeName",
+ "name" : "inputId",
"required" : true,
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
"200" : {
- "description" : "Data type deleted"
+ "description" : "Component found"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Data type not found"
+ "description" : "Component not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Delete service input",
+ "summary" : "Returns inputs list",
"tags" : [ "SDCE-2 APIs" ]
- },
+ }
+ },
+ "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs" : {
"get" : {
- "description" : "Get data type in service",
- "operationId" : "getDataType",
+ "description" : "Get inputs",
+ "operationId" : "getInputsForComponentInput",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
}
}, {
"in" : "path",
- "name" : "dataTypeName",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Data type found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Data type not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/DataTypeDefinition"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Get data type in service",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/dataTypes" : {
- "get" : {
- "description" : "Get data types that service has",
- "operationId" : "getDataTypes",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentType",
+ "name" : "inputId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
+ "in" : "header",
+ "name" : "USER_ID",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
- "description" : "Data type found"
+ "description" : "Component found"
},
"403" : {
"description" : "Restricted operation"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Get data types in service",
+ "summary" : "Returns inputs list",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/delete/{inputId}/input" : {
- "delete" : {
- "description" : "Delete input from service",
- "operationId" : "deleteInput",
+ "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities" : {
+ "get" : {
+ "description" : "Get Component Requirments And Capabilities",
+ "operationId" : "getRequirementAndCapabilities",
"parameters" : [ {
"in" : "path",
"name" : "componentType",
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "inputId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
}, {
"in" : "header",
"name" : "USER_ID",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Service Input to be deleted",
- "required" : true
- },
"responses" : {
"200" : {
- "description" : "Input deleted"
+ "description" : "Component found"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Input not found"
+ "description" : "Component not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Delete service input",
+ "summary" : "Returns Requirements And Capabilities according to componentId",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/delete/{outputId}/output" : {
- "delete" : {
- "description" : "Delete output from service",
- "operationId" : "deleteOutput",
+ "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}" : {
+ "post" : {
+ "description" : "Add Component Substitution Filter Constraint",
+ "operationId" : "addSubstitutionFilter",
"parameters" : [ {
+ "description" : "Component Id",
"in" : "path",
- "name" : "componentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "valid value: resources / services",
"in" : "path",
- "name" : "componentId",
+ "name" : "componentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "services", "services" ]
}
}, {
+ "description" : "Constraint type. Valid values: properties / capabilities",
"in" : "path",
- "name" : "outputId",
+ "name" : "constraintType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "properties", "capabilities" ]
}
}, {
"in" : "header",
}
}
},
- "description" : "Service Output to be deleted",
+ "description" : "UIConstraint data",
"required" : true
},
"responses" : {
- "200" : {
- "description" : "Output deleted"
+ "201" : {
+ "description" : "Add Substitution Filter Constraint"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Output not found"
- },
"default" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "type" : "object",
+ "properties" : {
+ "allowedMethods" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "cookies" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "properties" : {
+ "comment" : {
+ "type" : "string"
+ },
+ "domain" : {
+ "type" : "string"
+ },
+ "expiry" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "httpOnly" : {
+ "type" : "boolean"
+ },
+ "maxAge" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "secure" : {
+ "type" : "boolean"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ }
+ },
+ "date" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "entity" : {
+ "type" : "object"
+ },
+ "entityTag" : {
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ },
+ "weak" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "headers" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "language" : {
+ "type" : "object",
+ "properties" : {
+ "country" : {
+ "type" : "string"
+ },
+ "displayCountry" : {
+ "type" : "string"
+ },
+ "displayLanguage" : {
+ "type" : "string"
+ },
+ "displayName" : {
+ "type" : "string"
+ },
+ "displayScript" : {
+ "type" : "string"
+ },
+ "displayVariant" : {
+ "type" : "string"
+ },
+ "extensionKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "iso3Country" : {
+ "type" : "string"
+ },
+ "iso3Language" : {
+ "type" : "string"
+ },
+ "language" : {
+ "type" : "string"
+ },
+ "script" : {
+ "type" : "string"
+ },
+ "unicodeLocaleAttributes" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "unicodeLocaleKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "uniqueItems" : true
+ },
+ "variant" : {
+ "type" : "string"
+ }
+ }
+ },
+ "lastModified" : {
+ "type" : "string",
+ "format" : "date-time"
+ },
+ "length" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "links" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "params" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "rel" : {
+ "type" : "string"
+ },
+ "rels" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "title" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uri" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "uriBuilder" : {
+ "type" : "object"
+ }
+ }
+ },
+ "uniqueItems" : true
+ },
+ "location" : {
+ "type" : "string",
+ "format" : "uri"
+ },
+ "mediaType" : {
+ "type" : "object",
+ "properties" : {
+ "parameters" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "subtype" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "wildcardSubtype" : {
+ "type" : "boolean"
+ },
+ "wildcardType" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ }
+ },
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "statusInfo" : {
+ "type" : "object",
+ "properties" : {
+ "family" : {
+ "type" : "string",
+ "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
+ },
+ "reasonPhrase" : {
+ "type" : "string"
+ },
+ "statusCode" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "stringHeaders" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
}
}
}
}
}
},
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Delete service output",
+ "summary" : "Add Component Substitution Filter Constraint",
"tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/dependencies" : {
- "get" : {
- "description" : "Autometed upgrade",
- "operationId" : "getComponentDependencies",
+ },
+ "put" : {
+ "description" : "Update Component Substitution Filter Constraint",
+ "operationId" : "updateSubstitutionFilter",
"parameters" : [ {
+ "description" : "Component Id",
"in" : "path",
- "name" : "componentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "valid value: resources / services",
"in" : "path",
- "name" : "componentId",
+ "name" : "componentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "services", "services" ]
+ }
+ }, {
+ "description" : "Constraint type. Valid values: properties / capabilities",
+ "in" : "path",
+ "name" : "constraintType",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "properties", "capabilities" ]
}
}, {
"in" : "header",
"content" : {
"application/json" : {
"schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "type" : "string"
}
}
},
- "description" : "Consumer Object to be created",
+ "description" : "UIConstraint data",
"required" : true
},
"responses" : {
- "200" : {
- "description" : "Component found"
+ "201" : {
+ "description" : "Update Substitution Filter Constraint"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Component not found"
- },
"default" : {
"content" : {
"application/json" : {
}
}
},
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "....",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/filteredDataByParams" : {
- "get" : {
- "description" : "Retrieve Resource",
- "operationId" : "getComponentDataFilteredByParams",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "include",
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Resource found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Resource not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns resource according to resourceId",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/filteredproperties/{propertyNameFragment}" : {
- "get" : {
- "description" : "Retrieve properties belonging to component instances of specific component by name and optionally resource type",
- "operationId" : "getFilteredComponentInstanceProperties",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "propertyNameFragment",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "resourceType",
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Component found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns properties belonging to component instances of specific component by name and optionally resource type",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}" : {
- "get" : {
- "description" : "Get inputs",
- "operationId" : "getInputsAndPropertiesForComponentInput",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "inputId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Component found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns inputs list",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/inputs/{inputId}/inputs" : {
- "get" : {
- "description" : "Get inputs",
- "operationId" : "getInputsForComponentInput",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "inputId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Component found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns inputs list",
+ "summary" : "Update Component Substitution Filter Constraint",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/requirmentsCapabilities" : {
- "get" : {
- "description" : "Get Component Requirments And Capabilities",
- "operationId" : "getRequirementAndCapabilities",
+ "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}" : {
+ "delete" : {
+ "description" : "Delete Component Substitution Filter Constraint",
+ "operationId" : "deleteSubstitutionFilterConstraint",
"parameters" : [ {
- "in" : "path",
- "name" : "componentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
+ "description" : "Component Id",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Component found"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Resource"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns Requirements And Capabilities according to componentId",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}" : {
- "post" : {
- "description" : "Add Component Substitution Filter Constraint",
- "operationId" : "addSubstitutionFilter",
- "parameters" : [ {
- "description" : "Component Id",
+ "description" : "Constraint Index",
"in" : "path",
- "name" : "componentId",
+ "name" : "constraintIndex",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "integer",
+ "format" : "int32"
}
}, {
"description" : "valid value: resources / services",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "UIConstraint data",
- "required" : true
- },
"responses" : {
"201" : {
- "description" : "Add Substitution Filter Constraint"
+ "description" : "Delete Substitution Filter Constraint"
},
"400" : {
"description" : "Invalid content / Missing content"
}
}
},
- "summary" : "Add Component Substitution Filter Constraint",
+ "summary" : "Delete Component Substitution Filter Constraint",
"tags" : [ "SDCE-2 APIs" ]
- },
- "put" : {
- "description" : "Update Component Substitution Filter Constraint",
- "operationId" : "updateSubstitutionFilter",
+ }
+ },
+ "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation" : {
+ "get" : {
+ "description" : "Validate Component Conformance Level",
+ "operationId" : "conformanceLevelValidation",
"parameters" : [ {
- "description" : "Component Id",
"in" : "path",
- "name" : "componentId",
+ "name" : "componentType",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "valid value: resources / services",
"in" : "path",
- "name" : "componentType",
+ "name" : "componentUuid",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "services", "services" ]
+ "type" : "string"
}
}, {
- "description" : "Constraint type. Valid values: properties / capabilities",
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Component found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns the result according to conformance level in BE config",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}" : {
+ "get" : {
+ "description" : "Get component Artifacts",
+ "operationId" : "getComponentArtifacts",
+ "parameters" : [ {
+ "description" : "valid values: resources / services",
"in" : "path",
- "name" : "constraintType",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "properties", "capabilities" ]
+ "enum" : [ "resources", "services" ]
}
}, {
- "in" : "header",
- "name" : "USER_ID",
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "artifactGroupType",
+ "required" : true,
"schema" : {
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "UIConstraint data",
- "required" : true
- },
"responses" : {
- "201" : {
- "description" : "Update Substitution Filter Constraint"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "200" : {
+ "description" : "Component artifacts"
},
- "403" : {
- "description" : "Restricted operation"
+ "404" : {
+ "description" : "Resource/Artifact not found"
},
"default" : {
"content" : {
}
}
},
- "summary" : "Update Component Substitution Filter Constraint",
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns artifacts",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}/{constraintIndex}" : {
- "delete" : {
- "description" : "Delete Component Substitution Filter Constraint",
- "operationId" : "deleteSubstitutionFilterConstraint",
+ "/v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances" : {
+ "post" : {
+ "description" : "Batch Delete ResourceInstances",
+ "operationId" : "batchDeleteResourceInstances",
"parameters" : [ {
- "description" : "Component Id",
+ "description" : "valid values: resources / services / products",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
+ }
+ }, {
"in" : "path",
"name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Component Instance Id List",
+ "required" : true
+ },
+ "responses" : {
+ "203" : {
+ "description" : "ResourceInstances deleted"
+ },
+ "400" : {
+ "description" : "Invalid Content / Missing Content"
+ },
+ "403" : {
+ "description" : "Restricted Operation"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}" : {
+ "get" : {
+ "description" : "Get group artifacts ",
+ "operationId" : "getGroupById",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
- "description" : "Constraint Index",
"in" : "path",
- "name" : "constraintIndex",
+ "name" : "componentId",
"required" : true,
"schema" : {
- "type" : "integer",
- "format" : "int32"
+ "type" : "string"
}
}, {
- "description" : "valid value: resources / services",
"in" : "path",
- "name" : "componentType",
+ "name" : "groupId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "services", "services" ]
+ "type" : "string"
}
}, {
- "description" : "Constraint type. Valid values: properties / capabilities",
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "group found"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Group not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Resource"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns artifacts metadata according to groupId",
+ "tags" : [ "SDCE-2 APIs" ]
+ },
+ "put" : {
+ "description" : "Update Group metadata",
+ "operationId" : "updateGroup",
+ "parameters" : [ {
"in" : "path",
- "name" : "constraintType",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "properties", "capabilities" ]
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "groupId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
}
}, {
"in" : "header",
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GroupDefinition"
+ }
+ }
+ },
+ "description" : "GroupDefinition",
+ "required" : true
+ },
"responses" : {
- "201" : {
- "description" : "Delete Substitution Filter Constraint"
+ "200" : {
+ "description" : "Group updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
+ "404" : {
+ "description" : "component / group Not found"
+ },
"default" : {
"content" : {
"application/json" : {
}
}
},
- "summary" : "Delete Component Substitution Filter Constraint",
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns updated Group",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{componentType}/{componentUuid}/conformanceLevelValidation" : {
- "get" : {
- "description" : "Validate Component Conformance Level",
- "operationId" : "conformanceLevelValidation",
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}" : {
+ "post" : {
+ "description" : "Create group ",
+ "operationId" : "createGroup",
"parameters" : [ {
"in" : "path",
- "name" : "componentType",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"in" : "path",
- "name" : "componentUuid",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "groupType",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
- "200" : {
- "description" : "Component found"
+ "201" : {
+ "description" : "Group created"
+ },
+ "400" : {
+ "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
},
"403" : {
"description" : "Restricted operation"
"404" : {
"description" : "Component not found"
},
+ "500" : {
+ "description" : "Internal Error"
+ },
"default" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "$ref" : "#/components/schemas/GroupDefinition"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns the result according to conformance level in BE config",
+ "summary" : "Creates new group in component and returns it",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/artifactsByType/{artifactGroupType}" : {
- "get" : {
- "description" : "Get component Artifacts",
- "operationId" : "getComponentArtifacts",
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}" : {
+ "delete" : {
+ "description" : "Delete Group",
+ "operationId" : "deleteGroup",
"parameters" : [ {
- "description" : "valid values: resources / services",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
+ "type" : "string"
}
}, {
"in" : "path",
}
}, {
"in" : "path",
- "name" : "artifactGroupType",
+ "name" : "groupUniqueId",
"required" : true,
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"responses" : {
- "200" : {
- "description" : "Component artifacts"
+ "201" : {
+ "description" : "ResourceInstance deleted"
+ },
+ "400" : {
+ "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
+ },
+ "403" : {
+ "description" : "Restricted operation"
},
"404" : {
- "description" : "Resource/Artifact not found"
+ "description" : "Component not found"
+ },
+ "500" : {
+ "description" : "Internal Error"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns artifacts",
+ "summary" : "Returns deleted group id",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/batchDeleteResourceInstances" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members" : {
"post" : {
- "description" : "Batch Delete ResourceInstances",
- "operationId" : "batchDeleteResourceInstances",
+ "description" : "Update group members ",
+ "operationId" : "updateGroupMembers",
"parameters" : [ {
- "description" : "valid values: resources / services / products",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
+ "type" : "string"
}
}, {
"in" : "path",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "groupUniqueId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "description" : "List of members unique ids",
+ "required" : true
+ },
+ "responses" : {
+ "200" : {
+ "description" : "Group members updated"
+ },
+ "400" : {
+ "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Component not found"
+ },
+ "500" : {
+ "description" : "Internal Error"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Updates list of members and returns it",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata" : {
+ "put" : {
+ "description" : "Update Group Metadata",
+ "operationId" : "updateGroupMetadata",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "groupUniqueId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
} ],
"requestBody" : {
"content" : {
}
}
},
- "description" : "Component Instance Id List",
+ "description" : "Service object to be Updated",
"required" : true
},
"responses" : {
- "203" : {
- "description" : "ResourceInstances deleted"
+ "200" : {
+ "description" : "Group Updated"
},
"400" : {
- "description" : "Invalid Content / Missing Content"
+ "description" : "Invalid content / Missing content"
},
"403" : {
- "description" : "Restricted Operation"
+ "description" : "Restricted operation"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GroupDefinition"
+ }
+ }
+ }
+ }
}
},
"servers" : [ {
"url" : "/sdc2/rest",
"variables" : { }
} ],
+ "summary" : "Returns updated group definition",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupId}" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties" : {
"get" : {
- "description" : "Get group artifacts ",
- "operationId" : "getGroupById",
+ "description" : "Get List of properties on a group",
+ "operationId" : "getGroupProperties",
"parameters" : [ {
"in" : "path",
"name" : "containerComponentType",
}
}, {
"in" : "path",
- "name" : "groupId",
+ "name" : "groupUniqueId",
"required" : true,
"schema" : {
"type" : "string"
} ],
"responses" : {
"200" : {
- "description" : "group found"
+ "description" : "Group Updated"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Group not found"
- },
"default" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/Resource"
+ "$ref" : "#/components/schemas/GroupProperty"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns artifacts metadata according to groupId",
+ "summary" : "Returns list of properties",
"tags" : [ "SDCE-2 APIs" ]
},
"put" : {
- "description" : "Update Group metadata",
- "operationId" : "updateGroup",
+ "description" : "Updates List of properties on a group (only values)",
+ "operationId" : "updateGroupProperties",
"parameters" : [ {
"in" : "path",
"name" : "containerComponentType",
}
}, {
"in" : "path",
- "name" : "groupId",
+ "name" : "groupUniqueId",
"required" : true,
"schema" : {
"type" : "string"
"content" : {
"application/json" : {
"schema" : {
- "$ref" : "#/components/schemas/GroupDefinition"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GroupProperty"
+ }
}
}
},
- "description" : "GroupDefinition",
+ "description" : "Group Properties to be Updated",
"required" : true
},
"responses" : {
"200" : {
- "description" : "Group updated"
+ "description" : "Group Updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "component / group Not found"
- },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GroupProperty"
+ }
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Returns updated list of properties",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/paths-to-delete" : {
+ "get" : {
+ "description" : "Check if forwarding path to delete on version change",
+ "operationId" : "changeResourceInstanceVersion_1",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "componentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "componentInstanceId",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "query",
+ "name" : "newComponentInstanceId",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "valid values: resources / services",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
+ }
+ } ],
+ "responses" : {
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated Group",
+ "summary" : "Returns forwarding paths to delete",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupType}" : {
- "post" : {
- "description" : "Create group ",
- "operationId" : "createGroup",
+ "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}" : {
+ "delete" : {
+ "description" : "Delete Policy",
+ "operationId" : "deletePolicy",
"parameters" : [ {
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "groupType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "201" : {
- "description" : "Group created"
- },
- "400" : {
- "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "500" : {
- "description" : "Internal Error"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GroupDefinition"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Creates new group in component and returns it",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}" : {
- "delete" : {
- "description" : "Delete Group",
- "operationId" : "deleteGroup",
- "parameters" : [ {
+ "description" : "valid values: resources / services",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
"in" : "path",
- "name" : "groupUniqueId",
+ "name" : "policyId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "USER_ID of modifier user",
"in" : "header",
"name" : "USER_ID",
+ "required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
- "201" : {
- "description" : "ResourceInstance deleted"
+ "204" : {
+ "description" : "Policy was deleted"
},
"400" : {
- "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
- },
- "500" : {
- "description" : "Internal Error"
+ "description" : "component / policy Not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted group id",
+ "summary" : "No body",
"tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members" : {
- "post" : {
- "description" : "Update group members ",
- "operationId" : "updateGroupMembers",
+ },
+ "get" : {
+ "description" : "Get Policy",
+ "operationId" : "getPolicy",
"parameters" : [ {
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "groupUniqueId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- },
- "description" : "List of members unique ids",
- "required" : true
- },
- "responses" : {
- "200" : {
- "description" : "Group members updated"
- },
- "400" : {
- "description" : "field name invalid type/length, characters; mandatory field is absent, already exists (name)"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Component not found"
- },
- "500" : {
- "description" : "Internal Error"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Updates list of members and returns it",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/metadata" : {
- "put" : {
- "description" : "Update Group Metadata",
- "operationId" : "updateGroupMetadata",
- "parameters" : [ {
+ "description" : "valid values: resources / services",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
"in" : "path",
- "name" : "groupUniqueId",
+ "name" : "policyId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "USER_ID of modifier user",
"in" : "header",
"name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Service object to be Updated",
- "required" : true
- },
- "responses" : {
- "200" : {
- "description" : "Group Updated"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GroupDefinition"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns updated group definition",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties" : {
- "get" : {
- "description" : "Get List of properties on a group",
- "operationId" : "getGroupProperties",
- "parameters" : [ {
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "groupUniqueId",
"required" : true,
"schema" : {
"type" : "string"
}
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
} ],
"responses" : {
"200" : {
- "description" : "Group Updated"
+ "description" : "Policy was found"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GroupProperty"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns list of properties",
- "tags" : [ "SDCE-2 APIs" ]
- },
- "put" : {
- "description" : "Updates List of properties on a group (only values)",
- "operationId" : "updateGroupProperties",
- "parameters" : [ {
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "groupUniqueId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- } ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GroupProperty"
- }
- }
- }
- },
- "description" : "Group Properties to be Updated",
- "required" : true
- },
- "responses" : {
- "200" : {
- "description" : "Group Updated"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
- },
- "403" : {
- "description" : "Restricted operation"
+ "404" : {
+ "description" : "component / policy Not found"
},
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GroupProperty"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns updated list of properties",
- "tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/paths-to-delete" : {
- "get" : {
- "description" : "Check if forwarding path to delete on version change",
- "operationId" : "changeResourceInstanceVersion_1",
- "parameters" : [ {
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "componentInstanceId",
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "query",
- "name" : "newComponentInstanceId",
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "valid values: resources / services",
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
- }
- } ],
- "responses" : {
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns forwarding paths to delete",
+ "summary" : "Returns Policy",
"tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}" : {
- "delete" : {
- "description" : "Delete Policy",
- "operationId" : "deletePolicy",
+ },
+ "put" : {
+ "description" : "Update Policy metadata",
+ "operationId" : "updatePolicy",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "PolicyDefinition",
+ "required" : true
+ },
"responses" : {
- "204" : {
- "description" : "Policy was deleted"
+ "200" : {
+ "description" : "Policy updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "No body",
+ "summary" : "Returns updated Policy",
"tags" : [ "SDCE-2 APIs" ]
- },
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties" : {
"get" : {
- "description" : "Get Policy",
- "operationId" : "getPolicy",
+ "description" : "Get component policy properties",
+ "operationId" : "getPolicyProperties",
"parameters" : [ {
+ "description" : "the id of the component which is the container of the policy",
"in" : "path",
"name" : "componentId",
"required" : true,
"enum" : [ "resources", "services" ]
}
}, {
+ "description" : "the id of the policy which its properties are to return",
"in" : "path",
"name" : "policyId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "USER_ID of modifier user",
+ "description" : "the userid",
"in" : "header",
"name" : "USER_ID",
"required" : true,
} ],
"responses" : {
"200" : {
- "description" : "Policy was found"
+ "description" : "Properties found"
},
"400" : {
- "description" : "Invalid content / Missing content"
+ "description" : "invalid content - Error: containerComponentType is invalid"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "component / policy Not found"
+ "description" : "Componentorpolicy not found"
+ },
+ "500" : {
+ "description" : "The GET request failed due to internal SDC problem."
},
"default" : {
"content" : {
"schema" : {
"type" : "array",
"items" : {
- "type" : "object",
- "properties" : {
- "allowedMethods" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "cookies" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "object",
- "properties" : {
- "comment" : {
- "type" : "string"
- },
- "domain" : {
- "type" : "string"
- },
- "expiry" : {
- "type" : "string",
- "format" : "date-time"
- },
- "httpOnly" : {
- "type" : "boolean"
- },
- "maxAge" : {
- "type" : "integer",
- "format" : "int32"
- },
- "name" : {
- "type" : "string"
- },
- "path" : {
- "type" : "string"
- },
- "secure" : {
- "type" : "boolean"
- },
- "value" : {
- "type" : "string"
- },
- "version" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- }
- },
- "date" : {
- "type" : "string",
- "format" : "date-time"
- },
- "entity" : {
- "type" : "object"
- },
- "entityTag" : {
- "type" : "object",
- "properties" : {
- "value" : {
- "type" : "string"
- },
- "weak" : {
- "type" : "boolean"
- }
- }
- },
- "headers" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "language" : {
- "type" : "object",
- "properties" : {
- "country" : {
- "type" : "string"
- },
- "displayCountry" : {
- "type" : "string"
- },
- "displayLanguage" : {
- "type" : "string"
- },
- "displayName" : {
- "type" : "string"
- },
- "displayScript" : {
- "type" : "string"
- },
- "displayVariant" : {
- "type" : "string"
- },
- "extensionKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "iso3Country" : {
- "type" : "string"
- },
- "iso3Language" : {
- "type" : "string"
- },
- "language" : {
- "type" : "string"
- },
- "script" : {
- "type" : "string"
- },
- "unicodeLocaleAttributes" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "unicodeLocaleKeys" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- },
- "uniqueItems" : true
- },
- "variant" : {
- "type" : "string"
- }
- }
- },
- "lastModified" : {
- "type" : "string",
- "format" : "date-time"
- },
- "length" : {
- "type" : "integer",
- "format" : "int32"
- },
- "links" : {
- "type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "params" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "rel" : {
- "type" : "string"
- },
- "rels" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "title" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "uri" : {
- "type" : "string",
- "format" : "uri"
- },
- "uriBuilder" : {
- "type" : "object"
- }
- }
- },
- "uniqueItems" : true
- },
- "location" : {
- "type" : "string",
- "format" : "uri"
- },
- "mediaType" : {
- "type" : "object",
- "properties" : {
- "parameters" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "subtype" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "wildcardSubtype" : {
- "type" : "boolean"
- },
- "wildcardType" : {
- "type" : "boolean"
- }
- }
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "object"
- }
- }
- },
- "status" : {
- "type" : "integer",
- "format" : "int32"
- },
- "statusInfo" : {
- "type" : "object",
- "properties" : {
- "family" : {
- "type" : "string",
- "enum" : [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
- },
- "reasonPhrase" : {
- "type" : "string"
- },
- "statusCode" : {
- "type" : "integer",
- "format" : "int32"
- }
- }
- },
- "stringHeaders" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- }
+ "$ref" : "#/components/schemas/PropertyDataDefinition"
}
}
}
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns Policy",
+ "summary" : "Returns component policy properties",
"tags" : [ "SDCE-2 APIs" ]
},
"put" : {
- "description" : "Update Policy metadata",
- "operationId" : "updatePolicy",
+ "description" : "Update Policy properties",
+ "operationId" : "updatePolicyProperties",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
},
"responses" : {
"200" : {
- "description" : "Policy updated"
+ "description" : "Policy properties updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/properties" : {
- "get" : {
- "description" : "Get component policy properties",
- "operationId" : "getPolicyProperties",
- "parameters" : [ {
- "description" : "the id of the component which is the container of the policy",
- "in" : "path",
- "name" : "componentId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "valid values: resources / services",
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
- }
- }, {
- "description" : "the id of the policy which its properties are to return",
- "in" : "path",
- "name" : "policyId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "description" : "the userid",
- "in" : "header",
- "name" : "USER_ID",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "Properties found"
- },
- "400" : {
- "description" : "invalid content - Error: containerComponentType is invalid"
- },
- "403" : {
- "description" : "Restricted operation"
- },
- "404" : {
- "description" : "Componentorpolicy not found"
- },
- "500" : {
- "description" : "The GET request failed due to internal SDC problem."
- },
- "default" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/PropertyDataDefinition"
- }
- }
- }
- }
- }
- },
- "servers" : [ {
- "url" : "/sdc2/rest",
- "variables" : { }
- } ],
- "summary" : "Returns component policy properties",
- "tags" : [ "SDCE-2 APIs" ]
- },
- "put" : {
- "description" : "Update Policy properties",
- "operationId" : "updatePolicyProperties",
+ "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets" : {
+ "post" : {
+ "description" : "update policy targets",
+ "operationId" : "updatePolicyTargets",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
"content" : {
"application/json" : {
"schema" : {
- "type" : "string"
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/PolicyTargetDTO"
+ }
}
}
- },
- "description" : "PolicyDefinition",
- "required" : true
+ }
},
"responses" : {
- "200" : {
- "description" : "Policy properties updated"
+ "201" : {
+ "description" : "Policy target updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "component / policy Not found"
- },
"default" : {
"content" : {
"application/json" : {
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/targets" : {
- "post" : {
- "description" : "update policy targets",
- "operationId" : "updatePolicyTargets",
+ "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare" : {
+ "put" : {
+ "description" : "undeclare Policy",
+ "operationId" : "undeclarePolicy",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/PolicyTargetDTO"
- }
- }
- }
- }
- },
"responses" : {
- "201" : {
- "description" : "Policy target updated"
+ "204" : {
+ "description" : "Policy was undeclared"
},
"400" : {
"description" : "Invalid content / Missing content"
"403" : {
"description" : "Restricted operation"
},
+ "404" : {
+ "description" : "component / policy Not found"
+ },
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated Policy",
+ "summary" : "No body",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyId}/undeclare" : {
- "put" : {
- "description" : "undeclare Policy",
- "operationId" : "undeclarePolicy",
+ "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}" : {
+ "post" : {
+ "description" : "Create Policy",
+ "operationId" : "createPolicy",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
}
}, {
"in" : "path",
- "name" : "policyId",
+ "name" : "policyTypeName",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
- "204" : {
- "description" : "Policy was undeclared"
+ "201" : {
+ "description" : "Policy created"
},
"400" : {
"description" : "Invalid content / Missing content"
"description" : "Restricted operation"
},
"404" : {
- "description" : "component / policy Not found"
+ "description" : "Component not found"
+ },
+ "409" : {
+ "description" : "Policy already exist"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "No body",
+ "summary" : "Returns created Policy",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/policies/{policyTypeName}" : {
- "post" : {
- "description" : "Create Policy",
- "operationId" : "createPolicy",
+ "/v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}" : {
+ "get" : {
+ "description" : "Get relation",
+ "operationId" : "getRelationById",
"parameters" : [ {
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "valid values: resources / services",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
+ "type" : "string"
}
}, {
"in" : "path",
- "name" : "policyTypeName",
+ "name" : "relationId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "USER_ID of modifier user",
"in" : "header",
"name" : "USER_ID",
- "required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
- "201" : {
- "description" : "Policy created"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "200" : {
+ "description" : "relation found"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component not found"
- },
- "409" : {
- "description" : "Policy already exist"
+ "description" : "Relation not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns created Policy",
+ "summary" : "Returns relation metadata according to relationId",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/relationId/{relationId}" : {
- "get" : {
- "description" : "Get relation",
- "operationId" : "getRelationById",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance" : {
+ "post" : {
+ "description" : "Create ComponentInstance",
+ "operationId" : "createComponentInstance",
"parameters" : [ {
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
+ "description" : "valid values: resources / services",
"in" : "path",
- "name" : "relationId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
+ "description" : "USER_ID of modifier user",
"in" : "header",
"name" : "USER_ID",
+ "required" : true,
"schema" : {
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "RI object to be created",
+ "required" : true
+ },
"responses" : {
- "200" : {
- "description" : "relation found"
+ "201" : {
+ "description" : "Component created"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Relation not found"
+ "409" : {
+ "description" : "Component instance already exist"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns relation metadata according to relationId",
+ "summary" : "Returns created ComponentInstance",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate" : {
"post" : {
- "description" : "Create ComponentInstance",
- "operationId" : "createComponentInstance",
+ "description" : "Associate RI to RI",
+ "operationId" : "associateRIToRI",
"parameters" : [ {
+ "description" : "unique id of the container component",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "valid values: resources / services",
+ "description" : "allowed values are resources /services / products",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "resources", "services" ]
+ "enum" : [ "resources", "services", "products" ]
}
}, {
- "description" : "USER_ID of modifier user",
"in" : "header",
"name" : "USER_ID",
- "required" : true,
"schema" : {
"type" : "string"
}
}
}
},
- "description" : "RI object to be created",
+ "description" : "RelationshipInfo",
"required" : true
},
"responses" : {
"201" : {
- "description" : "Component created"
+ "description" : "Relationship created"
},
"400" : {
"description" : "Invalid content / Missing content"
},
"403" : {
- "description" : "Restricted operation"
+ "description" : "Missing information"
},
"409" : {
- "description" : "Component instance already exist"
+ "description" : "Relationship already exist"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns created ComponentInstance",
+ "summary" : "Returns created RelationshipInfo",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/associate" : {
- "post" : {
- "description" : "Associate RI to RI",
- "operationId" : "associateRIToRI",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate" : {
+ "put" : {
+ "description" : "Batch Dissociate RI from RI",
+ "operationId" : "batchDissociateRIFromRI",
"parameters" : [ {
- "description" : "unique id of the container component",
+ "description" : "allowed values are resources/services/products",
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
}
}, {
- "description" : "allowed values are resources /services / products",
+ "description" : "unique id of the container component",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
+ "type" : "string"
}
}, {
"in" : "header",
},
"responses" : {
"201" : {
- "description" : "Relationship created"
+ "description" : "Relationship deleted"
},
"400" : {
- "description" : "Invalid content / Missing content"
+ "description" : "Invalid Content / Missing Content"
},
"403" : {
- "description" : "Missing information"
- },
- "409" : {
- "description" : "Relationship already exist"
+ "description" : "Missing Information"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns created RelationshipInfo",
+ "summary" : "Returns deleted RelationShip Info",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/batchDissociate" : {
- "put" : {
- "description" : "Batch Dissociate RI from RI",
- "operationId" : "batchDissociateRIFromRI",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate" : {
+ "post" : {
+ "description" : "Create RI and associate RI to RI",
+ "operationId" : "createAndAssociateRIToRI",
"parameters" : [ {
- "description" : "allowed values are resources/services/products",
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
- }
- }, {
- "description" : "unique id of the container component",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
+ "description" : "valid values: resources / services",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "RelationshipInfo",
- "required" : true
- },
"responses" : {
"201" : {
- "description" : "Relationship deleted"
+ "description" : "RI created"
},
"400" : {
- "description" : "Invalid Content / Missing Content"
+ "description" : "Invalid content / Missing content"
},
"403" : {
- "description" : "Missing Information"
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Relationship already exist"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted RelationShip Info",
+ "summary" : "Returns created RI and RelationshipInfo",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/createAndAssociate" : {
- "post" : {
- "description" : "Create RI and associate RI to RI",
- "operationId" : "createAndAssociateRIToRI",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate" : {
+ "put" : {
+ "description" : "Dissociate RI from RI",
+ "operationId" : "dissociateRIFromRI",
"parameters" : [ {
+ "description" : "allowed values are resources /services / products",
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
}
}, {
- "description" : "valid values: resources / services",
+ "description" : "unique id of the container component",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "RelationshipInfo",
+ "required" : true
+ },
"responses" : {
"201" : {
- "description" : "RI created"
+ "description" : "Relationship deleted"
},
"400" : {
"description" : "Invalid content / Missing content"
},
"403" : {
- "description" : "Restricted operation"
- },
- "409" : {
- "description" : "Relationship already exist"
+ "description" : "Missing information"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns created RI and RelationshipInfo",
+ "summary" : "Returns deleted RelationshipInfo",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/dissociate" : {
- "put" : {
- "description" : "Dissociate RI from RI",
- "operationId" : "dissociateRIFromRI",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance" : {
+ "post" : {
+ "description" : "Update resource instance multiple component",
+ "operationId" : "updateMultipleComponentInstance",
"parameters" : [ {
- "description" : "allowed values are resources /services / products",
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
- }
- }, {
- "description" : "unique id of the container component",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "header",
- "name" : "USER_ID",
+ "description" : "valid values: resources / services / products",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
}
} ],
"requestBody" : {
}
}
},
- "description" : "RelationshipInfo",
+ "description" : "Component Instance JSON Array",
"required" : true
},
"responses" : {
- "201" : {
- "description" : "Relationship deleted"
+ "200" : {
+ "description" : "Resource instance updated"
},
"400" : {
"description" : "Invalid content / Missing content"
},
"403" : {
- "description" : "Missing information"
+ "description" : "Restricted operation"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted RelationshipInfo",
+ "summary" : "Returns updated resource instance",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/multipleComponentInstance" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}" : {
"post" : {
- "description" : "Update resource instance multiple component",
- "operationId" : "updateMultipleComponentInstance",
+ "description" : "Update resource instance",
+ "operationId" : "updateComponentInstanceMetadata",
"parameters" : [ {
"in" : "path",
"name" : "componentId",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "componentInstanceId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
"description" : "valid values: resources / services / products",
"in" : "path",
"enum" : [ "resources", "services", "products" ]
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Component Instance JSON Array",
- "required" : true
- },
"responses" : {
"200" : {
"description" : "Resource instance updated"
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts" : {
"post" : {
- "description" : "Update resource instance",
- "operationId" : "updateComponentInstanceMetadata",
+ "description" : "Load Resource Instance artifact payload",
+ "operationId" : "loadComponentInstanceArtifact",
"parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "Content-MD5",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "valid values: resources / services",
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
"in" : "path",
- "name" : "componentInstanceId",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "valid values: resources / services / products",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentInstanceId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
+ "type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "json describe the artifact",
+ "required" : true
+ },
"responses" : {
"200" : {
- "description" : "Resource instance updated"
+ "description" : "Artifact updated"
},
"400" : {
"description" : "Invalid content / Missing content"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated resource instance",
+ "summary" : "Returns updated artifact",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts" : {
- "post" : {
- "description" : "Load Resource Instance artifact payload",
- "operationId" : "loadComponentInstanceArtifact",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}" : {
+ "delete" : {
+ "description" : "Delete Resource Instance artifact",
+ "operationId" : "deleteComponentInstanceArtifact",
"parameters" : [ {
"in" : "header",
"name" : "USER_ID",
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "path",
+ "name" : "artifactId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
} ],
"requestBody" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated artifact",
+ "summary" : "Returns deleted artifact",
"tags" : [ "SDCE-2 APIs" ]
- }
- },
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}" : {
- "delete" : {
- "description" : "Delete Resource Instance artifact",
- "operationId" : "deleteComponentInstanceArtifact",
+ },
+ "post" : {
+ "description" : "Update Resource Instance artifact payload",
+ "operationId" : "updateComponentInstanceArtifact",
"parameters" : [ {
"in" : "header",
"name" : "USER_ID",
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted artifact",
+ "summary" : "Returns updated artifact",
"tags" : [ "SDCE-2 APIs" ]
- },
+ }
+ },
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams" : {
"post" : {
- "description" : "Update Resource Instance artifact payload",
- "operationId" : "updateComponentInstanceArtifact",
+ "description" : "Update Resource Instance HEAT_ENV parameters",
+ "operationId" : "updateRIArtifact",
"parameters" : [ {
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "header",
- "name" : "Content-MD5",
- "schema" : {
- "type" : "string"
- }
- }, {
"description" : "valid values: resources / services",
"in" : "path",
"name" : "containerComponentType",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/artifacts/{artifactId}/heatParams" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attributes" : {
"post" : {
- "description" : "Update Resource Instance HEAT_ENV parameters",
- "operationId" : "updateRIArtifact",
+ "description" : "Update resource instance attribute",
+ "operationId" : "updateResourceInstanceAttribute",
"parameters" : [ {
- "description" : "valid values: resources / services",
+ "description" : "service id",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
+ "type" : "string"
}
}, {
+ "description" : "valid values: resources / services",
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
+ "description" : "resource instance id",
"in" : "path",
"name" : "componentInstanceId",
"required" : true,
"type" : "string"
}
}, {
- "in" : "path",
- "name" : "artifactId",
- "required" : true,
+ "description" : "id of user initiating the operation",
+ "in" : "header",
+ "name" : "USER_ID",
"schema" : {
"type" : "string"
}
}
}
},
- "description" : "json describe the artifact",
+ "description" : "Component Instance Properties JSON Array",
"required" : true
},
"responses" : {
- "200" : {
- "description" : "Artifact updated"
+ "201" : {
+ "description" : "Resource instance created"
},
"400" : {
"description" : "Invalid content / Missing content"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated artifact",
+ "summary" : "Returns updated resource instance property",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/attribute" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion" : {
"post" : {
- "description" : "Update resource instance attribute",
- "operationId" : "updateResourceInstanceAttribute",
+ "description" : "Update resource instance",
+ "operationId" : "changeResourceInstanceVersion",
"parameters" : [ {
- "description" : "service id",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "valid values: resources / services",
- "in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
- }
- }, {
- "description" : "resource instance id",
"in" : "path",
"name" : "componentInstanceId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "id of user initiating the operation",
- "in" : "header",
- "name" : "USER_ID",
+ "description" : "valid values: resources / services",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
} ],
"responses" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated resource instance attribute",
+ "summary" : "Returns updated resource instance",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/changeVersion" : {
- "post" : {
- "description" : "Update resource instance",
- "operationId" : "changeResourceInstanceVersion",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}" : {
+ "get" : {
+ "description" : "Get group artifacts ",
+ "operationId" : "getGroupArtifactById",
"parameters" : [ {
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "valid values: resources / services",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "groupInstId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
}
} ],
"responses" : {
- "201" : {
- "description" : "Resource instance created"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "200" : {
+ "description" : "group found"
},
"403" : {
"description" : "Restricted operation"
},
+ "404" : {
+ "description" : "Group not found"
+ },
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated resource instance",
+ "summary" : "Returns artifacts metadata according to groupInstId",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstId}" : {
- "get" : {
- "description" : "Get group artifacts ",
- "operationId" : "getGroupArtifactById",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property" : {
+ "post" : {
+ "description" : "Update resource instance property",
+ "operationId" : "updateGroupInstanceProperty",
"parameters" : [ {
+ "description" : "service id",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "componentId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "valid values: resources / services",
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
}
}, {
+ "description" : "resource instance id",
"in" : "path",
"name" : "componentInstanceId",
"required" : true,
"type" : "string"
}
}, {
+ "description" : "group instance id",
"in" : "path",
- "name" : "groupInstId",
+ "name" : "groupInstanceId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
+ "description" : "id of user initiating the operation",
"in" : "header",
"name" : "USER_ID",
"schema" : {
}
} ],
"responses" : {
- "200" : {
- "description" : "group found"
+ "201" : {
+ "description" : "Resource instance created"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
- "404" : {
- "description" : "Group not found"
- },
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns artifacts metadata according to groupInstId",
+ "summary" : "Returns updated resource instance property",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}/property" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs" : {
"post" : {
"description" : "Update resource instance property",
- "operationId" : "updateGroupInstanceProperty",
+ "operationId" : "updateResourceInstanceInput",
"parameters" : [ {
"description" : "service id",
"in" : "path",
"schema" : {
"type" : "string"
}
- }, {
- "description" : "group instance id",
- "in" : "path",
- "name" : "groupInstanceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
}, {
"description" : "id of user initiating the operation",
"in" : "header",
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Component Instance Properties JSON Array",
+ "required" : true
+ },
"responses" : {
"201" : {
"description" : "Resource instance created"
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/inputs" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties" : {
"post" : {
"description" : "Update resource instance property",
- "operationId" : "updateResourceInstanceInput",
+ "operationId" : "updateResourceInstanceProperties",
"parameters" : [ {
"description" : "service id",
"in" : "path",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/properties" : {
- "post" : {
- "description" : "Update resource instance property",
- "operationId" : "updateResourceInstanceProperties",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}" : {
+ "delete" : {
+ "description" : "Update resource instance",
+ "operationId" : "deleteResourceInstanceProperty",
"parameters" : [ {
"description" : "service id",
"in" : "path",
"schema" : {
"type" : "string"
}
+ }, {
+ "description" : "property id",
+ "in" : "path",
+ "name" : "propertyId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
}, {
"description" : "id of user initiating the operation",
"in" : "header",
"type" : "string"
}
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "Component Instance Properties JSON Array",
- "required" : true
- },
"responses" : {
"201" : {
"description" : "Resource instance created"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated resource instance property",
+ "summary" : "Returns deleted resource instance property",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{componentInstanceId}/property/{propertyId}" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}" : {
"delete" : {
- "description" : "Update resource instance",
- "operationId" : "deleteResourceInstanceProperty",
+ "description" : "Delete ResourceInstance",
+ "operationId" : "deleteResourceInstance",
"parameters" : [ {
- "description" : "service id",
"in" : "path",
"name" : "componentId",
"required" : true,
"type" : "string"
}
}, {
- "description" : "valid values: resources / services",
"in" : "path",
- "name" : "containerComponentType",
- "required" : true,
- "schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
- }
- }, {
- "description" : "resource instance id",
- "in" : "path",
- "name" : "componentInstanceId",
+ "name" : "resourceInstanceId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "property id",
+ "description" : "valid values: resources / services / products",
"in" : "path",
- "name" : "propertyId",
+ "name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string"
- }
- }, {
- "description" : "id of user initiating the operation",
- "in" : "header",
- "name" : "USER_ID",
- "schema" : {
- "type" : "string"
+ "type" : "string",
+ "enum" : [ "resources", "services", "products" ]
}
} ],
"responses" : {
"201" : {
- "description" : "Resource instance created"
+ "description" : "ResourceInstance deleted"
},
"400" : {
"description" : "Invalid content / Missing content"
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns deleted resource instance property",
+ "summary" : "Returns delete resourceInstance",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstance/{resourceInstanceId}" : {
- "delete" : {
- "description" : "Delete ResourceInstance",
- "operationId" : "deleteResourceInstance",
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}" : {
+ "get" : {
+ "description" : "Download component Artifact in Base64",
+ "operationId" : "downloadResourceInstanceArtifactBase64",
"parameters" : [ {
+ "description" : "valid values: resources / services",
+ "in" : "path",
+ "name" : "containerComponentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "resources", "services" ]
+ }
+ }, {
"in" : "path",
"name" : "componentId",
"required" : true,
}
}, {
"in" : "path",
- "name" : "resourceInstanceId",
+ "name" : "componentInstanceId",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
- "description" : "valid values: resources / services / products",
"in" : "path",
- "name" : "containerComponentType",
+ "name" : "artifactId",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services", "products" ]
+ "type" : "string"
}
} ],
"responses" : {
- "201" : {
- "description" : "ResourceInstance deleted"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "200" : {
+ "description" : "ResourceInstance artifact downloaded"
},
- "403" : {
- "description" : "Restricted operation"
+ "404" : {
+ "description" : "ResourceInstance/Artifact not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns delete resourceInstance",
+ "summary" : "Returns downloaded artifact",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifacts/{artifactId}" : {
+ "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}" : {
"get" : {
- "description" : "Download component Artifact in Base64",
- "operationId" : "downloadResourceInstanceArtifactBase64",
+ "description" : "Get component Artifacts",
+ "operationId" : "getComponentInstanceArtifacts",
"parameters" : [ {
"description" : "valid values: resources / services",
"in" : "path",
}
}, {
"in" : "path",
- "name" : "artifactId",
+ "name" : "artifactGroupType",
"required" : true,
"schema" : {
"type" : "string"
} ],
"responses" : {
"200" : {
- "description" : "ResourceInstance artifact downloaded"
+ "description" : "Component artifacts"
},
"404" : {
- "description" : "ResourceInstance/Artifact not found"
+ "description" : "Resource/Artifact not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns downloaded artifact",
+ "summary" : "Returns artifacts",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/resourceInstances/{componentInstanceId}/artifactsByType/{artifactGroupType}" : {
- "get" : {
- "description" : "Get component Artifacts",
- "operationId" : "getComponentInstanceArtifacts",
+ "/v1/catalog/{containerComponentType}/{componentId}/update/inputs" : {
+ "post" : {
+ "description" : "Update resource inputs",
+ "operationId" : "updateComponentInputs",
"parameters" : [ {
"description" : "valid values: resources / services",
"in" : "path",
"schema" : {
"type" : "string"
}
- }, {
- "in" : "path",
- "name" : "componentInstanceId",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
- }, {
- "in" : "path",
- "name" : "artifactGroupType",
- "required" : true,
- "schema" : {
- "type" : "string"
- }
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "json describe the input",
+ "required" : true
+ },
"responses" : {
"200" : {
- "description" : "Component artifacts"
+ "description" : "Input updated"
},
- "404" : {
- "description" : "Resource/Artifact not found"
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns artifacts",
+ "summary" : "Returns updated input",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{componentId}/update/inputs" : {
- "post" : {
- "description" : "Update resource inputs",
- "operationId" : "updateComponentInputs",
+ "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes" : {
+ "get" : {
+ "description" : "Get component instance attributes",
+ "operationId" : "getInstanceAttributesById",
"parameters" : [ {
- "description" : "valid values: resources / services",
"in" : "path",
"name" : "containerComponentType",
"required" : true,
"schema" : {
- "type" : "string",
- "enum" : [ "resources", "services" ]
+ "type" : "string"
}
}, {
"in" : "path",
- "name" : "componentId",
+ "name" : "containerComponentId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentInstanceUniqueId",
"required" : true,
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
} ],
- "requestBody" : {
- "content" : {
- "application/json" : {
- "schema" : {
- "type" : "string"
- }
- }
- },
- "description" : "json describe the input",
- "required" : true
- },
"responses" : {
"200" : {
- "description" : "Input updated"
- },
- "400" : {
- "description" : "Invalid content / Missing content"
+ "description" : "Attributes found"
},
"403" : {
"description" : "Restricted operation"
},
+ "404" : {
+ "description" : "Component/Component Instance - not found"
+ },
"default" : {
"content" : {
"application/json" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns updated input",
+ "summary" : "Returns component instance attributes",
"tags" : [ "SDCE-2 APIs" ]
}
},
- "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/attributes" : {
- "get" : {
- "description" : "Get component instance attributes",
- "operationId" : "getInstanceAttributesById",
+ "/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/capability" : {
+ "put" : {
+ "description" : "Update Component Instance Capability",
+ "operationId" : "updateInstanceRequirement",
"parameters" : [ {
"in" : "path",
"name" : "containerComponentType",
"type" : "string"
}
} ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ComponentInstanceCapabilityUpdateModel"
+ }
+ }
+ },
+ "description" : "Component instance capability to update",
+ "required" : true
+ },
"responses" : {
"200" : {
- "description" : "Attributes found"
+ "description" : "Resource instance capability successfully updated"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
},
"403" : {
"description" : "Restricted operation"
},
"404" : {
- "description" : "Component/Component Instance - not found"
+ "description" : "Component/Component Instance/Capability not found"
},
"default" : {
"content" : {
"url" : "/sdc2/rest",
"variables" : { }
} ],
- "summary" : "Returns component instance attributes",
+ "summary" : "Returns updated Component Instance Capability",
"tags" : [ "SDCE-2 APIs" ]
}
},
"/v1/catalog/{containerComponentType}/{containerComponentId}/componentInstances/{componentInstanceUniqueId}/requirement/{capabilityType}/requirementName/{requirementName}" : {
"put" : {
"description" : "Update Instance Requirement",
- "operationId" : "updateInstanceRequirement",
+ "operationId" : "updateInstanceRequirement_1",
"parameters" : [ {
"in" : "path",
"name" : "containerComponentType",
"tags" : [ "SDCE-2 APIs" ]
}
},
+ "/v1/category/{componentType}/{categoryName}/baseTypes" : {
+ "get" : {
+ "description" : "Get base types for category",
+ "operationId" : "getCategoryBaseTypes",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "categoryName",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "componentType",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "model",
+ "in" : "query",
+ "name" : "model",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Returns base types Ok"
+ },
+ "404" : {
+ "description" : "No base types were found"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Get base types for category",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
"/v1/category/{componentType}/{categoryUniqueId}" : {
"delete" : {
"description" : "Delete component category",
"instanceUniqueId" : {
"type" : "string"
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"empty" : {
"type" : "boolean"
},
+ "external" : {
+ "type" : "boolean"
+ },
+ "externalName" : {
+ "type" : "string"
+ },
"leftOccurrences" : {
"type" : "string"
},
"empty" : {
"type" : "boolean"
},
+ "external" : {
+ "type" : "boolean"
+ },
+ "externalName" : {
+ "type" : "string"
+ },
"leftOccurrences" : {
"type" : "string"
},
"lifecycleState" : {
"type" : "string"
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"instanceUniqueId" : {
"type" : "string"
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
}
}
},
+ "ComponentInstanceCapabilityUpdateModel" : {
+ "type" : "object",
+ "properties" : {
+ "external" : {
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 1
+ },
+ "ownerId" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 1
+ },
+ "ownerName" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 1
+ },
+ "type" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 1
+ },
+ "uniqueId" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 1
+ }
+ },
+ "required" : [ "external", "name", "ownerId", "ownerName", "type", "uniqueId" ]
+ },
"ComponentInstanceInput" : {
"type" : "object",
"properties" : {
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"type" : "integer",
"format" : "int64"
},
+ "model" : {
+ "type" : "string"
+ },
"operations" : {
"type" : "object",
"additionalProperties" : {
"instanceUniqueId" : {
"type" : "string"
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"consumerBusinessLogic" : {
"type" : "boolean"
},
- "dcae" : {
- "$ref" : "#/components/schemas/DcaeConfig"
- },
"defaultImports" : {
"type" : "array",
"items" : {
"type" : "boolean"
},
"skipUpgradeVSPs" : {
- "type" : "boolean",
- "writeOnly" : true
- },
- "skipUpgradeVSPsFlag" : {
"type" : "boolean"
},
"startMigrationFrom" : {
"format" : "int32"
},
"supportAllottedResourcesAndProxy" : {
- "type" : "boolean",
- "writeOnly" : true
- },
- "supportAllottedResourcesAndProxyFlag" : {
"type" : "boolean"
},
"switchoverDetector" : {
"empty" : {
"type" : "boolean"
},
+ "model" : {
+ "type" : "string"
+ },
"modificationTime" : {
"type" : "integer",
"format" : "int64"
}
}
},
- "DcaeConfig" : {
- "type" : "object",
- "properties" : {
- "healthCheckUri" : {
- "type" : "string"
- },
- "host" : {
- "type" : "string"
- },
- "port" : {
- "type" : "integer",
- "format" : "int32"
- },
- "protocol" : {
- "type" : "string"
- }
- }
- },
"DistributionStatusInfo" : {
"type" : "object",
"properties" : {
"inputName" : {
"type" : "string"
},
+ "inputType" : {
+ "type" : "string"
+ },
"list" : {
"type" : "boolean"
},
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"modificationTime" : {
"type" : "integer",
"format" : "int64"
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"type" : "integer",
"format" : "int64"
},
+ "model" : {
+ "type" : "string"
+ },
"operations" : {
"type" : "object",
"additionalProperties" : {
"MetadataKeyDataDefinition" : {
"type" : "object",
"properties" : {
+ "defaultValue" : {
+ "type" : "string"
+ },
"empty" : {
"type" : "boolean"
},
}
}
},
+ "Model" : {
+ "type" : "object",
+ "properties" : {
+ "derivedFrom" : {
+ "type" : "string"
+ },
+ "modelType" : {
+ "type" : "string",
+ "enum" : [ "NORMATIVE", "NORMATIVE_EXTENSION" ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ }
+ },
+ "ModelCreateRequest" : {
+ "type" : "object",
+ "properties" : {
+ "derivedFrom" : {
+ "type" : "string"
+ },
+ "modelType" : {
+ "type" : "string",
+ "enum" : [ "NORMATIVE", "NORMATIVE_EXTENSION" ]
+ },
+ "name" : {
+ "type" : "string",
+ "maxLength" : 2147483647,
+ "minLength" : 2
+ }
+ },
+ "required" : [ "name" ]
+ },
"NameIdPair" : {
"type" : "object",
"additionalProperties" : {
"OnboardingConfig" : {
"type" : "object",
"properties" : {
- "downloadCsarUri" : {
+ "getLatestVspPackageUri" : {
+ "type" : "string"
+ },
+ "getVspPackageUri" : {
+ "type" : "string"
+ },
+ "getVspUri" : {
"type" : "string"
},
"healthCheckUri" : {
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"toscaDefaultValue" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"instanceUniqueId" : {
"type" : "string"
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"instanceUniqueId" : {
"type" : "string"
},
- "invariantName" : {
- "type" : "string"
- },
- "invariantUUID" : {
- "type" : "string"
- },
+ "invariantName" : {
+ "type" : "string"
+ },
+ "invariantUUID" : {
+ "type" : "string"
+ },
+ "isDeclaredListInput" : {
+ "type" : "boolean"
+ },
+ "isFromCsar" : {
+ "type" : "boolean"
+ },
+ "label" : {
+ "type" : "string"
+ },
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "normalizedName" : {
+ "type" : "string"
+ },
+ "ownerId" : {
+ "type" : "string"
+ },
+ "ownerIdIfEmpty" : {
+ "type" : "string",
+ "writeOnly" : true
+ },
+ "parentPropertyType" : {
+ "type" : "string"
+ },
+ "parentUniqueId" : {
+ "type" : "string"
+ },
+ "password" : {
+ "type" : "boolean"
+ },
+ "policyTypeName" : {
+ "type" : "string"
+ },
+ "policyTypeUid" : {
+ "type" : "string"
+ },
+ "policyUUID" : {
+ "type" : "string"
+ },
+ "properties" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/PropertyDataDefinition"
+ }
+ },
+ "propertyConstraints" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "propertyId" : {
+ "type" : "string"
+ },
+ "required" : {
+ "type" : "boolean"
+ },
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaDefinition"
+ },
+ "schemaProperty" : {
+ "$ref" : "#/components/schemas/PropertyDataDefinition"
+ },
+ "schemaType" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "subPropertyInputPath" : {
+ "type" : "string"
+ },
+ "targets" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uniqueId" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PolicyTargetDTO" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ },
+ "uniqueIds" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "PolicyTypeDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "creationTime" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "derivedFrom" : {
+ "type" : "string"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "empty" : {
+ "type" : "boolean"
+ },
+ "highestVersion" : {
+ "type" : "boolean"
+ },
+ "icon" : {
+ "type" : "string"
+ },
+ "metadata" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "model" : {
+ "type" : "string"
+ },
+ "modificationTime" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "ownerId" : {
+ "type" : "string"
+ },
+ "ownerIdIfEmpty" : {
+ "type" : "string",
+ "writeOnly" : true
+ },
+ "properties" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/PropertyDefinition"
+ }
+ },
+ "targets" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "uniqueId" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PropertyAssignmentUi" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PropertyConstraint" : {
+ "type" : "object"
+ },
+ "PropertyDataDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "annotations" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/Annotation"
+ }
+ },
+ "defaultValue" : {
+ "type" : "string"
+ },
+ "definition" : {
+ "type" : "boolean"
+ },
+ "description" : {
+ "type" : "string"
+ },
+ "empty" : {
+ "type" : "boolean"
+ },
+ "getInputProperty" : {
+ "type" : "boolean"
+ },
+ "getInputValues" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GetInputValueDataDefinition"
+ }
+ },
+ "getPolicyValues" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/GetPolicyValueDataDefinition"
+ }
+ },
+ "hidden" : {
+ "type" : "boolean"
+ },
+ "immutable" : {
+ "type" : "boolean"
+ },
+ "inputId" : {
+ "type" : "string"
+ },
+ "inputPath" : {
+ "type" : "string"
+ },
+ "instanceUniqueId" : {
+ "type" : "string"
+ },
"isDeclaredListInput" : {
"type" : "boolean"
},
- "isFromCsar" : {
- "type" : "boolean"
- },
"label" : {
"type" : "string"
},
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
- "name" : {
- "type" : "string"
- },
- "normalizedName" : {
- "type" : "string"
- },
- "ownerId" : {
- "type" : "string"
- },
- "ownerIdIfEmpty" : {
- "type" : "string",
- "writeOnly" : true
- },
- "parentPropertyType" : {
- "type" : "string"
- },
- "parentUniqueId" : {
- "type" : "string"
- },
- "password" : {
- "type" : "boolean"
- },
- "policyTypeName" : {
- "type" : "string"
- },
- "policyTypeUid" : {
- "type" : "string"
- },
- "policyUUID" : {
- "type" : "string"
- },
- "properties" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/PropertyDataDefinition"
- }
- },
- "propertyConstraints" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "propertyId" : {
- "type" : "string"
- },
- "required" : {
+ "mappedToComponentProperty" : {
"type" : "boolean"
},
- "schema" : {
- "$ref" : "#/components/schemas/SchemaDefinition"
- },
- "schemaProperty" : {
- "$ref" : "#/components/schemas/PropertyDataDefinition"
- },
- "schemaType" : {
- "type" : "string"
- },
- "status" : {
- "type" : "string"
- },
- "subPropertyInputPath" : {
- "type" : "string"
- },
- "targets" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- },
- "type" : {
- "type" : "string"
- },
- "uniqueId" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- }
- }
- },
- "PolicyTargetDTO" : {
- "type" : "object",
- "properties" : {
- "type" : {
- "type" : "string"
- },
- "uniqueIds" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- },
- "PolicyTypeDefinition" : {
- "type" : "object",
- "properties" : {
- "creationTime" : {
- "type" : "integer",
- "format" : "int64"
- },
- "derivedFrom" : {
- "type" : "string"
- },
- "description" : {
- "type" : "string"
- },
- "empty" : {
- "type" : "boolean"
- },
- "highestVersion" : {
- "type" : "boolean"
- },
- "icon" : {
- "type" : "string"
- },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
- "modificationTime" : {
- "type" : "integer",
- "format" : "int64"
- },
- "name" : {
- "type" : "string"
- },
- "ownerId" : {
- "type" : "string"
- },
- "ownerIdIfEmpty" : {
- "type" : "string",
- "writeOnly" : true
- },
- "properties" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/PropertyDefinition"
- }
- },
- "targets" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- },
- "type" : {
- "type" : "string"
- },
- "uniqueId" : {
- "type" : "string"
- },
- "version" : {
- "type" : "string"
- }
- }
- },
- "PropertyAssignmentUi" : {
- "type" : "object",
- "properties" : {
- "name" : {
- "type" : "string"
- },
- "type" : {
- "type" : "string"
- },
- "value" : {
- "type" : "string"
- }
- }
- },
- "PropertyConstraint" : {
- "type" : "object"
- },
- "PropertyDataDefinition" : {
- "type" : "object",
- "properties" : {
- "annotations" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/Annotation"
- }
- },
- "defaultValue" : {
- "type" : "string"
- },
- "definition" : {
- "type" : "boolean"
- },
- "description" : {
- "type" : "string"
- },
- "empty" : {
- "type" : "boolean"
- },
- "getInputProperty" : {
- "type" : "boolean"
- },
- "getInputValues" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GetInputValueDataDefinition"
- }
- },
- "getPolicyValues" : {
- "type" : "array",
- "items" : {
- "$ref" : "#/components/schemas/GetPolicyValueDataDefinition"
- }
- },
- "hidden" : {
- "type" : "boolean"
- },
- "immutable" : {
- "type" : "boolean"
- },
- "inputId" : {
+ "model" : {
"type" : "string"
},
- "inputPath" : {
- "type" : "string"
- },
- "instanceUniqueId" : {
- "type" : "string"
- },
- "isDeclaredListInput" : {
- "type" : "boolean"
- },
- "label" : {
- "type" : "string"
- },
- "metadata" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"label" : {
"type" : "string"
},
+ "mappedToComponentProperty" : {
+ "type" : "boolean"
+ },
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"subPropertyInputPath" : {
"type" : "string"
},
+ "toscaGetFunctionType" : {
+ "type" : "string",
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
+ },
"type" : {
"type" : "string"
},
"external" : {
"type" : "boolean"
},
+ "externalName" : {
+ "type" : "string"
+ },
"leftOccurrences" : {
"type" : "string"
},
"external" : {
"type" : "boolean"
},
+ "externalName" : {
+ "type" : "string"
+ },
"leftOccurrences" : {
"type" : "string"
},
"csarVersion" : {
"type" : "string"
},
+ "csarVersionId" : {
+ "type" : "string"
+ },
"dataTypes" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ]
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"substitutionFilter" : {
"$ref" : "#/components/schemas/SubstitutionFilterDataDefinition"
},
- "substitutionFilterComponents" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition"
- }
- },
"systemName" : {
"type" : "string"
},
"type" : "string",
"enum" : [ "CERTIFIED", "NOT_CERTIFIED_CHECKIN", "NOT_CERTIFIED_CHECKOUT" ]
},
+ "model" : {
+ "type" : "string"
+ },
"name" : {
"type" : "string"
},
"substitutionFilter" : {
"$ref" : "#/components/schemas/SubstitutionFilterDataDefinition"
},
- "substitutionFilterComponents" : {
- "type" : "object",
- "additionalProperties" : {
- "$ref" : "#/components/schemas/SubstitutionFilterDataDefinition"
- }
- },
"systemName" : {
"type" : "string"
},
Code Review / sdc.git / commitdiff