Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
438 lines (438 sloc) 19 KB
{
"paths": {
"Services.Management.LCM.Version": {
"operationId": "Services.Management.LCM.Version",
"summary": "Returns the version of the LCM service.",
"tags": [
"Services.Management.LCM"
],
"responses": {
"ARGUMENT_DATA_TYPE_MISMATCH": {
"description": "A call attempt to a valid object and procedure was performed, however an argument value was provided with an unexpected data type, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_DATA_TYPE_MISMATCH\", \"Description\": \"Unable to process the request because the value provided on the \\u2018Enabled\\u2019 field is not a valid Boolean.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_NOT_FOUND": {
"description": "A call to a valid object and procedure was performed, however an unrecognized argument was provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Enabled' is not a valid argument.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_REQUIRED_MISSING": {
"description": "A call to a valid object and procedure was performed, however a required argument was not provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_REQUIRED_MISSING\", \"Description\": \"Unable to process the request because the 'Enabled' field was not provided.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"ARGUMENT_VALUE_NOT_SUPPORTED": {
"description": "A call attempt to a valid object and procedure was performed, however a non-supported argument value was provided, therefore it was not possible to process the request.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"ARGUMENT_VALUE_NOT_SUPPORTED\", \"Description\": \"Unable to process the request because \\u2018Red\\u2019 is not a value supported by the \\u2018Colour\\u2019 field.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"METHOD_NOT_FOUND": {
"description": "A call to a valid object but non-existing procedure was performed, therefore it was not possible to process the request.",
"raised_by": "IPC Bus",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"METHOD_NOT_FOUND\", \"Description\": \"Unable to process the request because 'Set' is not a valid method\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OBJECT_NOT_FOUND": {
"description": "A call to a non-existing object was performed, therefore it was not possible to process the request.",
"raised_by": "IPC Bus",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OBJECT_NOT_FOUND\", \"Description\": \"Unable to process the request because 'prpl.Dummy' is not a valid object.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OK": {
"description": "A well-formed request to an authorized resource was performed, and the receiver was able to compute the response within the allowed time-window.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OK\"}, \"Body\": {\"API\": \"1.0.0\"}}",
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/Response"
},
{
"properties": {
"Body": {
"properties": {
"API": {
"type": "String",
"description": "LCM prpl HL-API specification version.",
"format": "X.Y.Z (X = Major version number, Y = Minor version numberRelease, Z = Patch)",
"default_value": "-",
"possible_values": "-",
"readOnly": true
}
},
"required": []
}
}
}
]
}
}
}
},
"OPERATION_ALREADY_IN_PROGRESS": {
"description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as the required resource was temporarily locked by a different request in progress.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ALREADY_IN_PROGRESS\", \"Description\": \"Unable to process the request because there is a duplicate operation currently in progress.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_ERROR": {
"description": "A well-formed request was performed however, it was not possible to process the request due to an unknown internal error.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ERROR\", \"Description\": \"Unable to process the request because there is a configuration error.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_ILLEGAL": {
"description": "A well-formed request to an authorized resource was performed, however the operation could not be completed, as it was invoked in the incorrect system state or order.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_ILLEGAL\", \"Description\": \"Unable to process the request because the 'Stop' procedure can only be invoked after the 'Start' method has been called.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_PERMISSION_DENIED": {
"description": "A well-formed request was performed however, the client did not meet the security conditions required to access the protected resource, therefore it is not possible to process the request.",
"raised_by": "IPC Bus / Remote Protocol Adapter",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_PERMISSION_DENIED\", \"Description\": \"Unable to process the request because user \\u2018Admin\\u2019 does not have access privileges to invoke the \\u2018Set\\u2019 procedure on object \\u2018prpl.Dummy\\u2019.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"OPERATION_TIMEOUT": {
"description": "A well-formed request was performed however, it was not possible to process the response within the allowed time-frame.",
"raised_by": "Micro-Service",
"content": {
"application/json": {
"example": "{\"Header\": {\"Name\": \"OPERATION_TIMEOUT\", \"Description\": \"The operation has been aborted because the service did not respond within the expected 5 seconds time-frame.\"}}",
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {},
"required": []
},
"example": ""
}
}
}
}
},
"components": {
"schemas": {
"ListRequest": {
"properties": {
"Limit": {
"description": "How many items to return at one time (max 200)",
"required": false,
"type": "integer",
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"example": {
"Limit": 10
}
}
},
"Offset": {
"description": "Which object index to start with",
"required": false,
"type": "integer",
"schema": {
"type": "integer",
"format": "int32",
"default": 0,
"example": {
"Offset": 45
}
}
}
}
},
"Response": {
"type": "object",
"description": "schema for a responses to object methods",
"oneOf": [
{
"properties": {
"Header": {
"type": "object",
"description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
"properties": {
"Name": {
"type": "string",
"description": "name of the response type",
"enum": [
"OK"
]
}
},
"required": [
"Name"
],
"additionalProperties": false
},
"Body": {
"type": "object"
}
},
"additionalProperties": false
},
{
"properties": {
"Header": {
"type": "object",
"description": "Header object specifying the name of the response type and providing a detailed description in case of an error",
"properties": {
"Name": {
"type": "string",
"description": "name of the response type",
"enum": [
"OK",
"OPERATION_ALREADY_IN_PROGRESS",
"ARGUMENT_NOT_FOUND",
"ARGUMENT_DATA_TYPE_MISMATCH",
"OPERATION_TIMEOUT",
"METHOD_NOT_FOUND",
"OPERATION_ILLEGAL",
"OBJECT_NOT_FOUND",
"ARGUMENT_REQUIRED_MISSING",
"OPERATION_ERROR",
"ARGUMENT_VALUE_NOT_SUPPORTED",
"OPERATION_PERMISSION_DENIED"
]
},
"Description": {
"type": "string",
"description": "A more detailed error message. NOTE: only filled in when the operation returns an error."
}
},
"required": [
"Name",
"Description"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
]
},
"Services.Management.LCM": {
"description": "Services.Management.LCM Object",
"id": "Services.Management.LCM",
"type": "object",
"required": [],
"properties": {
"API": {
"type": "String",
"description": "LCM prpl HL-API specification version.",
"format": "X.Y.Z (X = Major version number, Y = Minor version numberRelease, Z = Patch)",
"default_value": "-",
"possible_values": "-",
"readOnly": true
}
},
"events": {
"SERVICES_MANAGEMENT_LCM_EXECUTION_ENVIRONMENT_ADDED": {
"content": {
"application/json": {
"example": "{\"ExecutionEnvironmentId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}\"}"
}
},
"description": "Raised when a new LCM execution environment is added.",
"code": 1
},
"SERVICES_MANAGEMENT_LCM_EXECUTION_ENVIRONMENT_DELETED": {
"content": {
"application/json": {
"example": "{\"ExecutionEnvironmentId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}\"}"
}
},
"description": "Raised when an existing LCM execution environment is deleted.",
"code": 2
},
"SERVICES_MANAGEMENT_LCM_EXECUTION_ENVIRONMENT_MODIFIED": {
"content": {
"application/json": {
"example": "{\"ExecutionEnvironmentId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}\"}"
}
},
"description": "Raised when an existing LCM execution environment configuration is modified. Updating the administrative state should also result in the event being triggered.",
"code": 3
},
"SERVICES_MANAGEMENT_LCM_EXECUTION_ENVIRONMENT_ENABLED": {
"content": {
"application/json": {
"example": "{\"ExecutionEnvironmentId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}\"}"
}
},
"description": "Raised when an existing LCM execution environment is enabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally active.",
"code": 4
},
"SERVICES_MANAGEMENT_LCM_EXECUTION_ENVIRONMENT_DISABLED": {
"content": {
"application/json": {
"example": "{\"ExecutionEnvironmentId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}\"}"
}
},
"description": "Raised when an existing LCM execution environment is disabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally inactive or fails to start.",
"code": 5
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_DOWNLOAD_COMPLETE": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package download is completed.",
"code": 6
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_DOWNLOAD_FAILED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package download has failed.",
"code": 7
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_INSTALL_COMPLETE": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package installation is completed.",
"code": 8
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_INSTALL_FAILED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package installation fails.",
"code": 9
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_ENABLED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package is enabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally active.",
"code": 10
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_DISABLED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package is disabled. This does not necessarily result from a configuration change of the administrative state field, but rather when it becomes operationally inactive or fails to start.",
"code": 11
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_MODIFIED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package configuration is modified. Updating the administrative state should also result in the event being triggered.",
"code": 12
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_DELETE_COMPLETE": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package removal is completed.",
"code": 13
},
"SERVICES_MANAGEMENT_LCM_PACKAGE_DELETE_FAILED": {
"content": {
"application/json": {
"example": "{\"PackageId\": \"Services.Management.LCM.ExecutionEnvironments.{ExecutionEnvironmentId}.Packages.{PackageId}\"}"
}
},
"description": "Raised when a LCM package removal fails.",
"code": 14
}
},
"example": {},
"layer": 2
}
}
}
}
You can’t perform that action at this time.