Update openapi files
Signed-off-by: MichaelMorris <michael.morris@est.tech>
Issue-ID: SDC-4557
Change-Id: I3ca60e6c285d1e5f78ced161128ed073f152d7e1
diff --git a/docs/openapi/openapi-sdce-2-sdce-5.json b/docs/openapi/openapi-sdce-2-sdce-5.json
index eb2bfb5..875e976 100644
--- a/docs/openapi/openapi-sdce-2-sdce-5.json
+++ b/docs/openapi/openapi-sdce-2-sdce-5.json
@@ -303,6 +303,13 @@
"schema" : {
"type" : "string"
}
+ }, {
+ "in" : "query",
+ "name" : "excludePrimitives",
+ "schema" : {
+ "type" : "string",
+ "default" : "false"
+ }
} ],
"responses" : {
"200" : {
@@ -1524,6 +1531,406 @@
"tags" : [ "SDCE-2 APIs" ]
}
},
+ "/v1/catalog/customToscaFunctions/{type}" : {
+ "get" : {
+ "description" : "Retrieve default custom tosca functions values from the configuration file based on type",
+ "operationId" : "getDefaultCustomToscaFunctionValues",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "in" : "path",
+ "name" : "type",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "enum" : [ "ALL", "CUSTOM", "GET_INPUT" ]
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Returns default custom tosca functions values from configuration file Ok"
+ },
+ "404" : {
+ "description" : "Default custom tosca functions not found"
+ },
+ "500" : {
+ "description" : "Internal Server Error"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/User"
+ }
+ }
+ }
+ }
+ }
+ },
+ "summary" : "Retrieve all custom tosca functions",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/data-types/{dataTypeId}" : {
+ "delete" : {
+ "operationId" : "deleteDatatype",
+ "parameters" : [ {
+ "description" : "The data type id",
+ "in" : "path",
+ "name" : "dataTypeId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "*/*" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/data-types/{dataTypeId}/{propertyId}" : {
+ "delete" : {
+ "operationId" : "deleteProperty",
+ "parameters" : [ {
+ "description" : "The data type id",
+ "in" : "path",
+ "name" : "dataTypeId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "The property id to delete",
+ "in" : "path",
+ "name" : "propertyId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "*/*" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/data-types/{dataTypeName}/models" : {
+ "get" : {
+ "description" : "Get models for type",
+ "operationId" : "getDataTypeModels",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "dataTypeName",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "dataTypeModels"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Data type 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 list of models for type",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
"/v1/catalog/data-types/{dataTypeUid}" : {
"get" : {
"description" : "Get data types",
@@ -1671,6 +2078,59 @@
} ],
"summary" : "Create a property in the given data type",
"tags" : [ "SDCE-2 APIs" ]
+ },
+ "put" : {
+ "description" : "Update a property in the given data type",
+ "operationId" : "updateProperty",
+ "parameters" : [ {
+ "description" : "The data type id",
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PropertyDefinitionDto"
+ }
+ }
+ },
+ "description" : "Property to update",
+ "required" : true
+ },
+ "responses" : {
+ "201" : {
+ "description" : "Property updated in the data type"
+ },
+ "400" : {
+ "description" : "Invalid payload"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Data type not found"
+ },
+ "default" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PropertyDefinitionDto"
+ }
+ }
+ }
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "summary" : "Update a property in the given data type",
+ "tags" : [ "SDCE-2 APIs" ]
}
},
"/v1/catalog/dataTypes" : {
@@ -2009,6 +2469,304 @@
"tags" : [ "SDCE-2 APIs" ]
}
},
+ "/v1/catalog/downloadDataType" : {
+ "get" : {
+ "description" : "Get data types",
+ "operationId" : "downloadDataType",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "dataTypeId",
+ "in" : "query",
+ "name" : "dataTypeId",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "allDataTypes"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "404" : {
+ "description" : "Data 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 all data types from all models",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
"/v1/catalog/gab/searchFor" : {
"post" : {
"description" : "Search json paths inside the yaml",
@@ -2625,6 +3383,33 @@
"tags" : [ "SDCE-2 APIs" ]
}
},
+ "/v1/catalog/interface-types/{interfaceTypeId}" : {
+ "delete" : {
+ "operationId" : "deleteInterfaceType",
+ "parameters" : [ {
+ "description" : "The interface type id",
+ "in" : "path",
+ "name" : "interfaceTypeId",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "content" : {
+ "*/*" : { }
+ },
+ "description" : "default response"
+ }
+ },
+ "servers" : [ {
+ "url" : "/sdc2/rest",
+ "variables" : { }
+ } ],
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
"/v1/catalog/interfaceLifecycleTypes" : {
"get" : {
"description" : "Get interface lifecycle types",
@@ -4648,6 +5433,9 @@
"400" : {
"description" : "Invalid content / Missing content"
},
+ "401" : {
+ "description" : "Unauthorized Tenant"
+ },
"403" : {
"description" : "Restricted operation"
},
@@ -13343,6 +14131,9 @@
"400" : {
"description" : "Invalid content / Missing content"
},
+ "401" : {
+ "description" : "Unauthorized Tenant"
+ },
"403" : {
"description" : "Restricted operation"
},
@@ -24105,7 +24896,7 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
}
}
}
@@ -24701,7 +25492,7 @@
},
"/v1/catalog/uploadType/datatypes" : {
"post" : {
- "description" : "Create Categories from yaml",
+ "description" : "Create Data Types from zip",
"operationId" : "uploadDataTypes",
"parameters" : [ {
"in" : "header",
@@ -24727,7 +25518,322 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
+ }
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "201" : {
+ "description" : "Data types created"
+ },
+ "400" : {
+ "description" : "Invalid content / Missing content"
+ },
+ "403" : {
+ "description" : "Restricted operation"
+ },
+ "409" : {
+ "description" : "Data types 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 data types",
+ "tags" : [ "SDCE-2 APIs" ]
+ }
+ },
+ "/v1/catalog/uploadType/datatypesyaml" : {
+ "post" : {
+ "description" : "Create Data Types from yaml",
+ "operationId" : "uploadDataTypesYaml",
+ "parameters" : [ {
+ "in" : "header",
+ "name" : "USER_ID",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "multipart/form-data" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "dataTypesYaml" : {
+ "type" : "string",
+ "format" : "binary",
+ "description" : "FileInputStream"
+ },
+ "includeToModelImport" : {
+ "type" : "boolean",
+ "description" : "includeToModelImport"
+ },
+ "model" : {
+ "type" : "string",
+ "description" : "model name"
}
}
}
@@ -25042,7 +26148,7 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
},
"toscaTypeMetadata" : {
"type" : "string",
@@ -25361,7 +26467,7 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
}
}
}
@@ -25671,7 +26777,7 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
},
"policyTypesZip" : {
"type" : "string",
@@ -25990,7 +27096,7 @@
},
"model" : {
"type" : "string",
- "description" : "model"
+ "description" : "model name"
},
"relationshipTypeZip" : {
"type" : "string",
@@ -48824,6 +49930,9 @@
"type" : "string"
}
},
+ "tenant" : {
+ "type" : "string"
+ },
"uniqueId" : {
"type" : "string"
},
@@ -48855,6 +49964,9 @@
"defaultBaseType" : {
"type" : "string"
},
+ "doNotExtendBaseType" : {
+ "type" : "boolean"
+ },
"required" : {
"type" : "boolean"
}
@@ -48893,6 +50005,12 @@
"normalizedName" : {
"type" : "string"
},
+ "notApplicableMetadataKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
"ownerId" : {
"type" : "string"
},
@@ -49444,6 +50562,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -49792,6 +50913,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -49905,6 +51029,12 @@
"dataValidatorFilterExcludedUrls" : {
"type" : "string"
},
+ "defaultCustomToscaFunctions" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/CustomToscaFunction"
+ }
+ },
"defaultImports" : {
"type" : "array",
"items" : {
@@ -50386,6 +51516,17 @@
}
}
},
+ "CustomToscaFunction" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ }
+ },
"DataTypeDataDefinition" : {
"type" : "object",
"properties" : {
@@ -50412,6 +51553,9 @@
"name" : {
"type" : "string"
},
+ "normative" : {
+ "type" : "boolean"
+ },
"ownerId" : {
"type" : "string"
},
@@ -50471,6 +51615,9 @@
"name" : {
"type" : "string"
},
+ "normative" : {
+ "type" : "boolean"
+ },
"ownerId" : {
"type" : "string"
},
@@ -51426,6 +52573,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -51943,6 +53093,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -53588,6 +54741,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -53611,7 +54767,7 @@
"constraints" : {
"type" : "array",
"items" : {
- "$ref" : "#/components/schemas/PropertyConstraint"
+ "type" : "object"
}
},
"defaultValue" : {
@@ -53650,6 +54806,9 @@
"type" : "string",
"enum" : [ "EQUAL", "IN_RANGE", "GREATER_THAN", "GREATER_OR_EQUAL", "LESS_OR_EQUAL", "LENGTH", "MIN_LENGTH", "MAX_LENGTH", "VALID_VALUES", "LESS_THAN", "PATTERN", "SCHEMA" ]
},
+ "originalType" : {
+ "type" : "string"
+ },
"propertyName" : {
"type" : "string"
},
@@ -53662,7 +54821,7 @@
},
"valueType" : {
"type" : "string",
- "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CONCAT" ]
+ "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CUSTOM", "CONCAT", "SEVERAL" ]
}
}
},
@@ -54345,6 +55504,9 @@
"type" : "string"
}
},
+ "tenant" : {
+ "type" : "string"
+ },
"topologyTemplate" : {
"type" : "boolean"
},
@@ -54766,6 +55928,9 @@
"type" : "string"
}
},
+ "tenant" : {
+ "type" : "string"
+ },
"topologyTemplate" : {
"type" : "boolean"
},
@@ -55024,7 +56189,7 @@
},
"type" : {
"type" : "string",
- "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
},
"value" : {
"type" : "string"
@@ -55060,9 +56225,15 @@
"sourceUniqueId" : {
"type" : "string"
},
+ "toscaIndexList" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ },
"type" : {
"type" : "string",
- "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
}
}
},
@@ -55084,6 +56255,9 @@
"constraintOperator" : {
"type" : "string"
},
+ "originalType" : {
+ "type" : "string"
+ },
"servicePropertyName" : {
"type" : "string"
},
diff --git a/docs/openapi/openapi-sdce-2-sdce-5.yaml b/docs/openapi/openapi-sdce-2-sdce-5.yaml
index 84427af..216fc62 100644
--- a/docs/openapi/openapi-sdce-2-sdce-5.yaml
+++ b/docs/openapi/openapi-sdce-2-sdce-5.yaml
@@ -210,6 +210,11 @@
name: USER_ID
schema:
type: string
+ - in: query
+ name: excludePrimitives
+ schema:
+ type: string
+ default: "false"
responses:
"200":
description: allDataTypes
@@ -1064,6 +1069,294 @@
summary: Returns capability types
tags:
- SDCE-2 APIs
+ /v1/catalog/customToscaFunctions/{type}:
+ get:
+ description: Retrieve default custom tosca functions values from the configuration
+ file based on type
+ operationId: getDefaultCustomToscaFunctionValues
+ parameters:
+ - in: header
+ name: USER_ID
+ schema:
+ type: string
+ - in: path
+ name: type
+ required: true
+ schema:
+ type: string
+ enum:
+ - ALL
+ - CUSTOM
+ - GET_INPUT
+ responses:
+ "200":
+ description: Returns default custom tosca functions values from configuration
+ file Ok
+ "404":
+ description: Default custom tosca functions not found
+ "500":
+ description: Internal Server Error
+ default:
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/User'
+ summary: Retrieve all custom tosca functions
+ tags:
+ - SDCE-2 APIs
+ /v1/catalog/data-types/{dataTypeId}:
+ delete:
+ operationId: deleteDatatype
+ parameters:
+ - description: The data type id
+ in: path
+ name: dataTypeId
+ required: true
+ schema:
+ type: string
+ responses:
+ default:
+ content:
+ '*/*': {}
+ description: default response
+ servers:
+ - url: /sdc2/rest
+ variables: {}
+ tags:
+ - SDCE-2 APIs
+ /v1/catalog/data-types/{dataTypeId}/{propertyId}:
+ delete:
+ operationId: deleteProperty
+ parameters:
+ - description: The data type id
+ in: path
+ name: dataTypeId
+ required: true
+ schema:
+ type: string
+ - description: The property id to delete
+ in: path
+ name: propertyId
+ required: true
+ schema:
+ type: string
+ responses:
+ default:
+ content:
+ '*/*': {}
+ description: default response
+ servers:
+ - url: /sdc2/rest
+ variables: {}
+ tags:
+ - SDCE-2 APIs
+ /v1/catalog/data-types/{dataTypeName}/models:
+ get:
+ description: Get models for type
+ operationId: getDataTypeModels
+ parameters:
+ - in: path
+ name: dataTypeName
+ required: true
+ schema:
+ type: string
+ responses:
+ "200":
+ description: dataTypeModels
+ "400":
+ description: Invalid content / Missing content
+ "403":
+ description: Restricted operation
+ "404":
+ description: Data type 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 list of models for type
+ tags:
+ - SDCE-2 APIs
/v1/catalog/data-types/{dataTypeUid}:
get:
description: Get data types
@@ -1168,6 +1461,43 @@
summary: Create a property in the given data type
tags:
- SDCE-2 APIs
+ put:
+ description: Update a property in the given data type
+ operationId: updateProperty
+ parameters:
+ - description: The data type id
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PropertyDefinitionDto'
+ description: Property to update
+ required: true
+ responses:
+ "201":
+ description: Property updated in the data type
+ "400":
+ description: Invalid payload
+ "403":
+ description: Restricted operation
+ "404":
+ description: Data type not found
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PropertyDefinitionDto'
+ servers:
+ - url: /sdc2/rest
+ variables: {}
+ summary: Update a property in the given data type
+ tags:
+ - SDCE-2 APIs
/v1/catalog/dataTypes:
get:
description: Get data types
@@ -1403,6 +1733,215 @@
summary: Retrieve all Directives
tags:
- SDCE-2 APIs
+ /v1/catalog/downloadDataType:
+ get:
+ description: Get data types
+ operationId: downloadDataType
+ parameters:
+ - in: header
+ name: USER_ID
+ schema:
+ type: string
+ - description: dataTypeId
+ in: query
+ name: dataTypeId
+ schema:
+ type: string
+ responses:
+ "200":
+ description: allDataTypes
+ "400":
+ description: Invalid content / Missing content
+ "403":
+ description: Restricted operation
+ "404":
+ description: Data 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 all data types from all models
+ tags:
+ - SDCE-2 APIs
/v1/catalog/gab/searchFor:
post:
description: Search json paths inside the yaml
@@ -1836,6 +2375,26 @@
variables: {}
tags:
- SDCE-2 APIs
+ /v1/catalog/interface-types/{interfaceTypeId}:
+ delete:
+ operationId: deleteInterfaceType
+ parameters:
+ - description: The interface type id
+ in: path
+ name: interfaceTypeId
+ required: true
+ schema:
+ type: string
+ responses:
+ default:
+ content:
+ '*/*': {}
+ description: default response
+ servers:
+ - url: /sdc2/rest
+ variables: {}
+ tags:
+ - SDCE-2 APIs
/v1/catalog/interfaceLifecycleTypes:
get:
description: Get interface lifecycle types
@@ -3257,6 +3816,8 @@
description: Resource created
"400":
description: Invalid content / Missing content
+ "401":
+ description: Unauthorized Tenant
"403":
description: Restricted operation
"409":
@@ -9365,6 +9926,8 @@
description: Service created
"400":
description: Invalid content / Missing content
+ "401":
+ description: Unauthorized Tenant
"403":
description: Restricted operation
"409":
@@ -16934,7 +17497,7 @@
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
responses:
"201":
description: Capability Type created
@@ -17346,7 +17909,7 @@
- SDCE-2 APIs
/v1/catalog/uploadType/datatypes:
post:
- description: Create Categories from yaml
+ description: Create Data Types from zip
operationId: uploadDataTypes
parameters:
- in: header
@@ -17368,7 +17931,227 @@
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
+ responses:
+ "201":
+ description: Data types created
+ "400":
+ description: Invalid content / Missing content
+ "403":
+ description: Restricted operation
+ "409":
+ description: Data types 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 data types
+ tags:
+ - SDCE-2 APIs
+ /v1/catalog/uploadType/datatypesyaml:
+ post:
+ description: Create Data Types from yaml
+ operationId: uploadDataTypesYaml
+ parameters:
+ - in: header
+ name: USER_ID
+ schema:
+ type: string
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ dataTypesYaml:
+ type: string
+ format: binary
+ description: FileInputStream
+ includeToModelImport:
+ type: boolean
+ description: includeToModelImport
+ model:
+ type: string
+ description: model name
responses:
"201":
description: Data types created
@@ -17588,7 +18371,7 @@
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
toscaTypeMetadata:
type: string
description: toscaTypeMetadata
@@ -17811,7 +18594,7 @@
description: FileInputStream
model:
type: string
- description: model
+ description: model name
responses:
"201":
description: Interface Lifecycle Type created
@@ -18027,7 +18810,7 @@
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
policyTypesZip:
type: string
format: binary
@@ -18250,7 +19033,7 @@
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
relationshipTypeZip:
type: string
format: binary
@@ -34444,6 +35227,8 @@
type: array
items:
type: string
+ tenant:
+ type: string
uniqueId:
type: string
uuid:
@@ -34464,6 +35249,8 @@
type: string
defaultBaseType:
type: string
+ doNotExtendBaseType:
+ type: boolean
required:
type: boolean
CategoryDefinition:
@@ -34489,6 +35276,10 @@
type: string
normalizedName:
type: string
+ notApplicableMetadataKeys:
+ type: array
+ items:
+ type: string
ownerId:
type: string
ownerIdIfEmpty:
@@ -34887,6 +35678,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -35123,6 +35916,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -35199,6 +35994,10 @@
$ref: '#/components/schemas/CsarFormat'
dataValidatorFilterExcludedUrls:
type: string
+ defaultCustomToscaFunctions:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomToscaFunction'
defaultImports:
type: array
items:
@@ -35523,6 +36322,13 @@
properties:
defaultFormat:
type: string
+ CustomToscaFunction:
+ type: object
+ properties:
+ name:
+ type: string
+ type:
+ type: string
DataTypeDataDefinition:
type: object
properties:
@@ -35542,6 +36348,8 @@
format: int64
name:
type: string
+ normative:
+ type: boolean
ownerId:
type: string
ownerIdIfEmpty:
@@ -35582,6 +36390,8 @@
format: int64
name:
type: string
+ normative:
+ type: boolean
ownerId:
type: string
ownerIdIfEmpty:
@@ -36231,6 +37041,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -36584,6 +37396,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -37702,6 +38516,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -37718,7 +38534,7 @@
constraints:
type: array
items:
- $ref: '#/components/schemas/PropertyConstraint'
+ type: object
defaultValue:
type: object
description:
@@ -37755,6 +38571,8 @@
- LESS_THAN
- PATTERN
- SCHEMA
+ originalType:
+ type: string
propertyName:
type: string
targetType:
@@ -37772,7 +38590,9 @@
- GET_INPUT
- GET_ATTRIBUTE
- YAML
+ - CUSTOM
- CONCAT
+ - SEVERAL
PropertyFilterDataDefinition:
type: object
properties:
@@ -38252,6 +39072,8 @@
type: array
items:
type: string
+ tenant:
+ type: string
topologyTemplate:
type: boolean
toscaArtifacts:
@@ -38549,6 +39371,8 @@
type: array
items:
type: string
+ tenant:
+ type: string
topologyTemplate:
type: boolean
toscaArtifacts:
@@ -38727,6 +39551,7 @@
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING
value:
@@ -38757,6 +39582,10 @@
type: string
sourceUniqueId:
type: string
+ toscaIndexList:
+ type: array
+ items:
+ type: object
type:
type: string
enum:
@@ -38764,6 +39593,7 @@
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING
ToscaValidatorsConfig:
@@ -38779,6 +39609,8 @@
type: string
constraintOperator:
type: string
+ originalType:
+ type: string
servicePropertyName:
type: string
sourceName:
diff --git a/docs/openapi/openapi-sdce-7.json b/docs/openapi/openapi-sdce-7.json
index a24edd2..278c6da 100644
--- a/docs/openapi/openapi-sdce-7.json
+++ b/docs/openapi/openapi-sdce-7.json
@@ -706,33 +706,84 @@
"enum" : [ "resources", "services" ]
}
}, {
- "description" : "The filter key (resourceType only for resources)",
+ "description" : "The category to filter the result set on",
"in" : "query",
"name" : "category",
"schema" : {
"type" : "string"
}
}, {
- "description" : "The filter key (resourceType only for resources)",
+ "description" : "The sub category to filter the result set on. Only applicable when assetType = resources",
"in" : "query",
"name" : "subCategory",
"schema" : {
"type" : "string"
}
}, {
- "description" : "The filter key (resourceType only for resources)",
+ "description" : "The distribution status to filter the result set on",
"in" : "query",
"name" : "distributionStatus",
"schema" : {
"type" : "string"
}
}, {
- "description" : "The filter key (resourceType only for resources)",
+ "description" : "The resource type to filter the result set on. Only applicable when assetType = resources",
"in" : "query",
"name" : "resourceType",
"schema" : {
"type" : "string"
}
+ }, {
+ "description" : "Additional metadata keys to include in the response, not all keys are supported.\nSupported keys: lastUpdateDate, creationDate, description, uniqueId and category specific metadata keys",
+ "in" : "query",
+ "name" : "include",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }, {
+ "description" : "The version(s) to filter the result set on\nSyntax: /services?version=(highestMatchingVersionOnly|lessThan|greaterThan|equals)(:=)(value)",
+ "examples" : {
+ "An example request to get all services with version equal 2.0" : {
+ "description" : "An example request to get all services with version equal 2.0",
+ "value" : "equals:2.0"
+ },
+ "An example request to get all services with version greater than 1.1" : {
+ "description" : "An example request to get all services with version greater than 1.1",
+ "value" : "greaterThan:1.1"
+ },
+ "An example request to get all services with version less than 2.1" : {
+ "description" : "An example request to get all services with version less than 2.1",
+ "value" : "lessThan:2.1"
+ },
+ "An example request to get each service with highest version" : {
+ "description" : "An example request to get each service with highest version",
+ "value" : "highestMatchingVersionOnly:true"
+ }
+ },
+ "in" : "query",
+ "name" : "version",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "description" : "The keys of the metadata to include in the entries in the result set. Only applicable when assetType = services\nOnly category specific metadata keys are supported\nSyntax: /services?metadata=<KEY1>(:=)<VALUE1>&metadata=<KEY2>(:=)<VALUE2> ...",
+ "examples" : {
+ "An example request to get all services matching following Category Specific Metadata condition 'ETSI Version=3.3.1'" : {
+ "description" : "An example request to get all services matching following Category Specific Metadata condition 'ETSI Version=3.3.1'",
+ "value" : "ETSI Version:3.3.1"
+ }
+ },
+ "in" : "query",
+ "name" : "metadata",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
} ],
"responses" : {
"200" : {
@@ -4276,6 +4327,12 @@
"normalizedName" : {
"type" : "string"
},
+ "notApplicableMetadataKeys" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
"ownerId" : {
"type" : "string"
},
@@ -4778,6 +4835,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -5126,6 +5186,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -5228,6 +5291,9 @@
"name" : {
"type" : "string"
},
+ "normative" : {
+ "type" : "boolean"
+ },
"ownerId" : {
"type" : "string"
},
@@ -5974,6 +6040,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -7292,6 +7361,9 @@
"type" : "string",
"enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE" ]
},
+ "toscaSubPath" : {
+ "type" : "string"
+ },
"type" : {
"type" : "string"
},
@@ -7319,6 +7391,9 @@
"type" : "string",
"enum" : [ "EQUAL", "IN_RANGE", "GREATER_THAN", "GREATER_OR_EQUAL", "LESS_OR_EQUAL", "LENGTH", "MIN_LENGTH", "MAX_LENGTH", "VALID_VALUES", "LESS_THAN", "PATTERN", "SCHEMA" ]
},
+ "originalType" : {
+ "type" : "string"
+ },
"propertyName" : {
"type" : "string"
},
@@ -7331,7 +7406,7 @@
},
"valueType" : {
"type" : "string",
- "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CONCAT" ]
+ "enum" : [ "STATIC", "GET_PROPERTY", "GET_INPUT", "GET_ATTRIBUTE", "YAML", "CUSTOM", "CONCAT", "SEVERAL" ]
}
}
},
@@ -7983,6 +8058,9 @@
"type" : "string"
}
},
+ "tenant" : {
+ "type" : "string"
+ },
"topologyTemplate" : {
"type" : "boolean"
},
@@ -8213,7 +8291,7 @@
},
"type" : {
"type" : "string",
- "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
},
"value" : {
"type" : "string"
@@ -8249,9 +8327,15 @@
"sourceUniqueId" : {
"type" : "string"
},
+ "toscaIndexList" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object"
+ }
+ },
"type" : {
"type" : "string",
- "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "YAML", "STRING" ]
+ "enum" : [ "GET_INPUT", "GET_PROPERTY", "GET_ATTRIBUTE", "CONCAT", "CUSTOM", "YAML", "STRING" ]
}
}
}
diff --git a/docs/openapi/openapi-sdce-7.yaml b/docs/openapi/openapi-sdce-7.yaml
index 93681a2..5aa17ea 100644
--- a/docs/openapi/openapi-sdce-7.yaml
+++ b/docs/openapi/openapi-sdce-7.yaml
@@ -534,26 +534,73 @@
enum:
- resources
- services
- - description: The filter key (resourceType only for resources)
+ - description: The category to filter the result set on
in: query
name: category
schema:
type: string
- - description: The filter key (resourceType only for resources)
+ - description: The sub category to filter the result set on. Only applicable
+ when assetType = resources
in: query
name: subCategory
schema:
type: string
- - description: The filter key (resourceType only for resources)
+ - description: The distribution status to filter the result set on
in: query
name: distributionStatus
schema:
type: string
- - description: The filter key (resourceType only for resources)
+ - description: The resource type to filter the result set on. Only applicable
+ when assetType = resources
in: query
name: resourceType
schema:
type: string
+ - description: "Additional metadata keys to include in the response, not all\
+ \ keys are supported.\nSupported keys: lastUpdateDate, creationDate, description,\
+ \ uniqueId and category specific metadata keys"
+ in: query
+ name: include
+ schema:
+ type: array
+ items:
+ type: string
+ - description: "The version(s) to filter the result set on\nSyntax: /services?version=(highestMatchingVersionOnly|lessThan|greaterThan|equals)(:=)(value)"
+ examples:
+ An example request to get all services with version equal 2.0:
+ description: An example request to get all services with version equal
+ 2.0
+ value: equals:2.0
+ An example request to get all services with version greater than 1.1:
+ description: An example request to get all services with version greater
+ than 1.1
+ value: greaterThan:1.1
+ An example request to get all services with version less than 2.1:
+ description: An example request to get all services with version less
+ than 2.1
+ value: lessThan:2.1
+ An example request to get each service with highest version:
+ description: An example request to get each service with highest version
+ value: highestMatchingVersionOnly:true
+ in: query
+ name: version
+ schema:
+ type: string
+ - description: "The keys of the metadata to include in the entries in the result\
+ \ set. Only applicable when assetType = services\nOnly category specific\
+ \ metadata keys are supported\nSyntax: /services?metadata=<KEY1>(:=)<VALUE1>&metadata=<KEY2>(:=)<VALUE2>\
+ \ ..."
+ examples:
+ An example request to get all services matching following Category Specific Metadata condition 'ETSI Version=3.3.1':
+ description: An example request to get all services matching following
+ Category Specific Metadata condition 'ETSI Version=3.3.1'
+ value: ETSI Version:3.3.1
+ in: query
+ name: metadata
+ schema:
+ type: array
+ items:
+ type: string
responses:
"200":
content:
@@ -3193,6 +3240,10 @@
type: string
normalizedName:
type: string
+ notApplicableMetadataKeys:
+ type: array
+ items:
+ type: string
ownerId:
type: string
ownerIdIfEmpty:
@@ -3549,6 +3600,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -3785,6 +3838,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -3854,6 +3909,8 @@
format: int64
name:
type: string
+ normative:
+ type: boolean
ownerId:
type: string
ownerIdIfEmpty:
@@ -4362,6 +4419,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -5257,6 +5316,8 @@
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -5287,6 +5348,8 @@
- LESS_THAN
- PATTERN
- SCHEMA
+ originalType:
+ type: string
propertyName:
type: string
targetType:
@@ -5304,7 +5367,9 @@
- GET_INPUT
- GET_ATTRIBUTE
- YAML
+ - CUSTOM
- CONCAT
+ - SEVERAL
PropertyFilterDataDefinition:
type: object
properties:
@@ -5763,6 +5828,8 @@
type: array
items:
type: string
+ tenant:
+ type: string
topologyTemplate:
type: boolean
toscaArtifacts:
@@ -5921,6 +5988,7 @@
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING
value:
@@ -5951,6 +6019,10 @@
type: string
sourceUniqueId:
type: string
+ toscaIndexList:
+ type: array
+ items:
+ type: object
type:
type: string
enum:
@@ -5958,5 +6030,6 @@
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING