summaryrefslogtreecommitdiffstats
path: root/docs/openapi/openapi-sdce-2-sdce-5.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/openapi/openapi-sdce-2-sdce-5.yaml')
-rw-r--r--docs/openapi/openapi-sdce-2-sdce-5.yaml848
1 files changed, 840 insertions, 8 deletions
diff --git a/docs/openapi/openapi-sdce-2-sdce-5.yaml b/docs/openapi/openapi-sdce-2-sdce-5.yaml
index 84427af781..216fc62945 100644
--- a/docs/openapi/openapi-sdce-2-sdce-5.yaml
+++ b/docs/openapi/openapi-sdce-2-sdce-5.yaml
@@ -210,6 +210,11 @@ paths:
name: USER_ID
schema:
type: string
+ - in: query
+ name: excludePrimitives
+ schema:
+ type: string
+ default: "false"
responses:
"200":
description: allDataTypes
@@ -1064,6 +1069,294 @@ paths:
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 @@ paths:
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 @@ paths:
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 @@ paths:
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 @@ paths:
description: Resource created
"400":
description: Invalid content / Missing content
+ "401":
+ description: Unauthorized Tenant
"403":
description: Restricted operation
"409":
@@ -9365,6 +9926,8 @@ paths:
description: Service created
"400":
description: Invalid content / Missing content
+ "401":
+ description: Unauthorized Tenant
"403":
description: Restricted operation
"409":
@@ -16934,7 +17497,7 @@ paths:
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
responses:
"201":
description: Capability Type created
@@ -17346,7 +17909,7 @@ paths:
- 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 @@ paths:
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 @@ paths:
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
toscaTypeMetadata:
type: string
description: toscaTypeMetadata
@@ -17811,7 +18594,7 @@ paths:
description: FileInputStream
model:
type: string
- description: model
+ description: model name
responses:
"201":
description: Interface Lifecycle Type created
@@ -18027,7 +18810,7 @@ paths:
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
policyTypesZip:
type: string
format: binary
@@ -18250,7 +19033,7 @@ paths:
description: includeToModelImport
model:
type: string
- description: model
+ description: model name
relationshipTypeZip:
type: string
format: binary
@@ -34444,6 +35227,8 @@ components:
type: array
items:
type: string
+ tenant:
+ type: string
uniqueId:
type: string
uuid:
@@ -34464,6 +35249,8 @@ components:
type: string
defaultBaseType:
type: string
+ doNotExtendBaseType:
+ type: boolean
required:
type: boolean
CategoryDefinition:
@@ -34489,6 +35276,10 @@ components:
type: string
normalizedName:
type: string
+ notApplicableMetadataKeys:
+ type: array
+ items:
+ type: string
ownerId:
type: string
ownerIdIfEmpty:
@@ -34887,6 +35678,8 @@ components:
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -35123,6 +35916,8 @@ components:
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -35199,6 +35994,10 @@ components:
$ref: '#/components/schemas/CsarFormat'
dataValidatorFilterExcludedUrls:
type: string
+ defaultCustomToscaFunctions:
+ type: array
+ items:
+ $ref: '#/components/schemas/CustomToscaFunction'
defaultImports:
type: array
items:
@@ -35523,6 +36322,13 @@ components:
properties:
defaultFormat:
type: string
+ CustomToscaFunction:
+ type: object
+ properties:
+ name:
+ type: string
+ type:
+ type: string
DataTypeDataDefinition:
type: object
properties:
@@ -35542,6 +36348,8 @@ components:
format: int64
name:
type: string
+ normative:
+ type: boolean
ownerId:
type: string
ownerIdIfEmpty:
@@ -35582,6 +36390,8 @@ components:
format: int64
name:
type: string
+ normative:
+ type: boolean
ownerId:
type: string
ownerIdIfEmpty:
@@ -36231,6 +37041,8 @@ components:
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -36584,6 +37396,8 @@ components:
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -37702,6 +38516,8 @@ components:
- GET_INPUT
- GET_PROPERTY
- GET_ATTRIBUTE
+ toscaSubPath:
+ type: string
type:
type: string
uniqueId:
@@ -37718,7 +38534,7 @@ components:
constraints:
type: array
items:
- $ref: '#/components/schemas/PropertyConstraint'
+ type: object
defaultValue:
type: object
description:
@@ -37755,6 +38571,8 @@ components:
- LESS_THAN
- PATTERN
- SCHEMA
+ originalType:
+ type: string
propertyName:
type: string
targetType:
@@ -37772,7 +38590,9 @@ components:
- GET_INPUT
- GET_ATTRIBUTE
- YAML
+ - CUSTOM
- CONCAT
+ - SEVERAL
PropertyFilterDataDefinition:
type: object
properties:
@@ -38252,6 +39072,8 @@ components:
type: array
items:
type: string
+ tenant:
+ type: string
topologyTemplate:
type: boolean
toscaArtifacts:
@@ -38549,6 +39371,8 @@ components:
type: array
items:
type: string
+ tenant:
+ type: string
topologyTemplate:
type: boolean
toscaArtifacts:
@@ -38727,6 +39551,7 @@ components:
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING
value:
@@ -38757,6 +39582,10 @@ components:
type: string
sourceUniqueId:
type: string
+ toscaIndexList:
+ type: array
+ items:
+ type: object
type:
type: string
enum:
@@ -38764,6 +39593,7 @@ components:
- GET_PROPERTY
- GET_ATTRIBUTE
- CONCAT
+ - CUSTOM
- YAML
- STRING
ToscaValidatorsConfig:
@@ -38779,6 +39609,8 @@ components:
type: string
constraintOperator:
type: string
+ originalType:
+ type: string
servicePropertyName:
type: string
sourceName: