from flask_restx import fields
from o2ims.views.api_ns import api_ims_inventory as api_ims_inventory_v1
+from o2common.views.flask_restx_fields import Json2Dict
class OcloudDTO:
ocloud = api_ims_inventory_v1.model(
"OcloudDto",
{
- 'oCloudId': fields.String(required=True),
- 'globalcloudId': fields.String(attribute='globalCloudId'),
- 'name': fields.String,
- 'description': fields.String,
- 'serviceUri': fields.String(attribute='serviceUri'),
+ 'oCloudId': fields.String(
+ required=True,
+ example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+ description='Identifier for the containing O-Cloud.'),
+ 'globalCloudId': fields.String(
+ example='10a07219-4201-4b3e-a52d-81ab6a755d8a',
+ description='Identifier of the O-Cloud instance. ' +
+ 'Globally unique across O-Cloud instances.'),
+ 'globalcloudId': fields.String(
+ attribute='globalCloudId',
+ example='10a07219-4201-4b3e-a52d-81ab6a755d8a',
+ description='Identifier of the O-Cloud instance. ' +
+ 'Globally unique across O-Cloud instances.(Specification)'),
+ 'name': fields.String(
+ example='95b818b8-b315-4d9f-af37-b82c492101f1',
+ description='Human readable name of the O-Cloud.'),
+ 'description': fields.String(
+ example='An ocloud',
+ description='Human readable description of the O-Cloud.'),
+ 'serviceUri': fields.String(
+ attribute='serviceUri',
+ example='https://128.224.115.51:30205',
+ description='The fully qualified URI root to all ' +
+ 'services provided by the O2ims interface'),
# 'infrastructureManagementServiceEndpoint': fields.String(
# attribute='serviceUri'),
# 'infrastructureMangementServiceEndPoint': fields.String(
# 'resourcePools': fields.String,
# 'deploymentManagers': fields.String,
# 'smoRegistrationService': fields.String
- 'extensions': fields.String
- }
+ 'extensions': fields.String(
+ example='',
+ description='These are unspecified (not standardized) ' +\
+ 'properties (keys) which are tailored by the vendor ' +\
+ 'to extend the information provided about the O-Cloud.'),
+ },
+ mask='{oCloudId,globalCloudId,globalcloudId,name,description,' +\
+ 'serviceUri}'
)
class ResourceTypeDTO:
+ alarm_definition = api_ims_inventory_v1.model(
+ "AlarmDefinitionDto",
+ {
+ 'alarmDefinitionId': fields.String,
+ 'alarmName': fields.String,
+ 'alarmLastChange': fields.String,
+ 'alarmChangeType': fields.String,
+ 'alarmDescription': fields.String,
+ 'proposedRepairActions': fields.String,
+ 'clearingType': fields.String,
+ 'managementInterfaceId': fields.String,
+ 'pkNotificationField': fields.String,
+ 'alarmAdditionalFields': fields.String,
+ }
+
+ )
alarm_dictionary = api_ims_inventory_v1.model(
"AlarmDictionaryDto",
{
'id': fields.String,
'alarmDictionaryVersion': fields.String,
- 'alarmDictionarySchemVersion': fields.String,
+ 'alarmDictionarySchemaVersion': fields.String,
'entityType': fields.String,
'vendor': fields.String,
'managementInterfaceId': fields.String,
'pkNotificationField': fields.String,
- 'alarmDefinition': fields.String,
+ # 'alarmDefinition': fields.String,
+ 'alarmDefinition': fields.List(fields.Nested(alarm_definition),
+ attribute='alarmDefinition'),
}
)
# 'resourceKind': fields.String,
# 'resourceClass': fields.String,
'extensions': fields.String
- }
+ },
+ mask='{resourceTypeId,name,description,model,vendor,version}'
)
resource_pool_get = api_ims_inventory_v1.model(
"ResourcePoolGetDto",
{
- 'resourcePoolId': fields.String(required=True,
- description='Resource pool ID'),
- 'globalLocationId': fields.String,
- 'name': fields.String,
- 'description': fields.String,
- 'oCloudId': fields.String,
- 'location': fields.String,
+ 'resourcePoolId': fields.String(
+ required=True,
+ example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+ description='Identifier for the Resource Pool in the ' +
+ 'O-Cloud instance.'),
+ 'globalLocationId': fields.String(
+ example='',
+ description='This identifier is copied from the O-Cloud ' +
+ 'Id assigned by the SMO during the O-Cloud deployment.'),
+ 'name': fields.String(
+ example='RegionOne',
+ description='Human readable name of the resource pool.'),
+ 'description': fields.String(
+ example='A Resource Pool',
+ description='Human readable description of the ' +
+ 'resource pool.'),
+ 'oCloudId': fields.String(
+ example='f078a1d3-56df-46c2-88a2-dd659aa3f6bd',
+ description='Identifier for the containing O-Cloud.'),
+ 'location': fields.String(
+ example='',
+ description='Information about the geographical ' +
+ 'location of the resource pool as detected by the O-Cloud.'),
# 'resources': fields.String,
- 'extensions': fields.String
- }
+ 'extensions': fields.String(
+ example='',
+ description='List of metadata key-value pairs ' +\
+ 'used to associate meaningful metadata to ' +\
+ 'the related resource pool.')
+ },
+ mask='{resourcePoolId,oCloudId,globalLocationId,name,description}'
)
'parentId': fields.String,
'description': fields.String,
# 'elements': fields.String,
- 'extensions': fields.String
- }
+ # 'extensions': fields.String
+ 'extensions': Json2Dict(attribute='extensions')
+ # 'extensions': fields.Raw(attribute='extensions')
+ },
+ mask='{resourceId,resourcePoolId,resourceTypeId,description,parentId}'
)
def recursive_resource_mapping(iteration_number=2):
'parentId': fields.String,
'description': fields.String,
# 'elements': fields.String,
- 'extensions': fields.String
+ # 'extensions': fields.String
+ 'extensions': Json2Dict(attribute='extensions')
+ # 'extensions': fields.Raw(attribute='extensions')
}
if iteration_number:
resource_json_mapping['elements'] = fields.List(
fields.Nested(ResourceDTO.recursive_resource_mapping(
iteration_number-1)), attribute='children')
return api_ims_inventory_v1.model(
- 'ResourceGetDto' + str(iteration_number), resource_json_mapping)
+ 'ResourceGetDto' + str(iteration_number), resource_json_mapping,
+ mask='{resourceId,resourcePoolId,resourceTypeId,description,' +
+ 'parentId}')
class DeploymentManagerDTO:
description='Profile support list, use default for the return \
endpoint'),
'extensions': fields.String
- }
+ },
+ mask='{deploymentManagerId,name,description,oCloudId,serviceUri,' + \
+ 'profileSupportList}'
)
profile = api_ims_inventory_v1.model("DeploymentManagerGetDtoProfile", {
'helmcli_kubeconfig': fields.String(attribute='helmcli_kubeconfig'),
})
+ extensions = api_ims_inventory_v1.model("DeploymentManagerExtensions", {
+ 'profileName': fields.String,
+ 'profileData': fields.Nested(profile, False, True),
+ })
+
deployment_manager_get = api_ims_inventory_v1.model(
"DeploymentManagerGetDto",
{
# 'supportedLocations': fields.String,
# 'capabilities': fields.String,
# 'capacity': fields.String,
- 'profileName': fields.String,
- 'profileData': fields.Nested(profile, False, True),
- 'extensions': fields.String
- }
+ 'extensions': fields.Nested(extensions, True, True)
+ },
+ mask='{deploymentManagerId,name,description,oCloudId,serviceUri,' +\
+ 'extensions/profileName,extensions/profileData}'
)
'callback': fields.String,
'consumerSubscriptionId': fields.String,
'filter': fields.String,
- }
+ },
+ mask='{subscriptionId,callback}'
)
- subscription = api_ims_inventory_v1.model(
+ subscription_create = api_ims_inventory_v1.model(
"SubscriptionCreateDto",
{
'callback': fields.String(
'filter': fields.String,
}
)
-
- subscription_post_resp = api_ims_inventory_v1.model(
- "SubscriptionCreatedRespDto",
- {
- 'subscriptionId': fields.String(required=True,
- description='Subscription ID'),
- }
- )
Code Review / pti / o2.git / blobdiff