updated SOL003 VNF Snapshot Management schemas to v3.5.1 (26a56970) · Commits · NFV - Network Functions Virtualisation / api-tests

SOL003/VNFSnapshotPackageManagement-API/schemas/VnfSnapshotPkgInfo.schema.json

+24 −101

Original line number	Original line	Diff line number	Diff line
	{		{
	"description": "This type represents the information of a VNF snapshot package.\n",		"description": "This type represents the information of a VNF snapshot package. It shall comply with the provisions defined in table 12.5.2.2-1.\nNOTE:\tThe attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this \n attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["id", "name", "isFullSnapshot", "state", "isCancelPending", "_links"],
	"id",
	"name",
	"isFullSnapshot",
	"state",
	"isCancelPending",
	"_links"
	],
	"properties": {		"properties": {
	"id": {		"id": {
	"description": "An identifier with the intention of being globally unique.\n",		"description": "An identifier with the intention of being globally unique.\n",
	@@ -36,7 +29,7 @@
	"type": "string"		"type": "string"
	},		},
	"vnfcSnapshotInfoIds": {		"vnfcSnapshotInfoIds": {
	"description": "Identifiers of information held by the VNFM about specific VNFC snapshots part of the VNF snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM during the VNF snapshot creation.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",		"description": "Identifiers of information held by the VNFM about specific VNFC snapshots part of the VNF snapshot and contained in the VNF snapshot package. This identifier is allocated by the VNFM during the VNF snapshot creation.\nSee note.\n",
	"type": "object",		"type": "object",
	"items": {		"items": {
	"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",		"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
	@@ -50,12 +43,7 @@
	"vnfdInfo": {		"vnfdInfo": {
	"description": "This type represents the VNFD which is contained in a VNF snapshot package.\n",		"description": "This type represents the VNFD which is contained in a VNF snapshot package.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["avnfdId", "vnfdPath", "checksum", "isEncrypted"],
	"avnfdId",
	"vnfdPath",
	"checksum",
	"isEncrypted"
	],
	"properties": {		"properties": {
	"avnfdId": {		"avnfdId": {
	"description": "An identifier with the intention of being globally unique.\n",		"description": "An identifier with the intention of being globally unique.\n",
	@@ -78,11 +66,7 @@
	"vnfsr": {		"vnfsr": {
	"description": "This type represents the VNF snapshot record which is contained in a VNF snapshot package.\n",		"description": "This type represents the VNF snapshot record which is contained in a VNF snapshot package.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["recordPath", "checksum", "isEncrypted"],
	"recordPath",
	"checksum",
	"isEncrypted"
	],
	"properties": {		"properties": {
	"recordPath": {		"recordPath": {
	"description": "A string defined in IETF RFC 8259.\n",		"description": "A string defined in IETF RFC 8259.\n",
	@@ -99,24 +83,12 @@
	}		}
	},		},
	"vnfcSnapshotImages": {		"vnfcSnapshotImages": {
	"description": "Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and external snapshot image shall be included. No other artifacts shall be included.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",		"description": "Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and external snapshot image shall be included. No other artifacts shall be included.\nSee note.\n",
	"type": "object",		"type": "object",
	"items": {		"items": {
	"description": "This type represents an artifact contained in a VNF snapshot package which represents a snapshot image.\n",		"description": "This type represents an artifact contained in a VNF snapshot package which represents a snapshot image. It shall comply with the provisions defined in table 12.5.3.2-1.\nNOTE 1:\tThe list of permitted values was taken from \"Container formats\" in OpenStack® documentation: \"Disk and container formats for images\"\n (Available at https://docs.openstack.org/glance/pike/user/formats.html).\nNOTE 2:\tThe list of permitted values was adapted from \"Disk formats\" in OpenStack® documentation: \"Disk and container formats for images\"\n (Available at https://docs.openstack.org/glance/pike/user/formats.html).\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["id", "name", "checksum", "isEncrypted", "vnfcInstanceId", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size"],
	"id",
	"name",
	"checksum",
	"isEncrypted",
	"vnfcInstanceId",
	"containerFormat",
	"diskFormat",
	"createdAt",
	"minDisk",
	"minRam",
	"size"
	],
	"properties": {		"properties": {
	"id": {		"id": {
	"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",		"description": "An identifier that is unique within a limited local scope other than above listed identifiers, such as within a complex data structure or within a request-response pair. Representation: string of variable length.\n",
	@@ -139,33 +111,14 @@
	"type": "string"		"type": "string"
	},		},
	"containerFormat": {		"containerFormat": {
	"description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format\nNOTE: The list of permitted values was taken from \"Container formats\" in [i.5] (OpenStack® documentation: \"Disk and container formats for images\").\n",		"description": "Container format indicates whether the snapshot image is in a file format that also contains metadata about the actual snapshot.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format\nSee note 1.\n",
	"type": "string",		"type": "string",
	"enum": [		"enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
	"AKI",
	"AMI",
	"ARI",
	"BARE",
	"DOCKER",
	"OVA",
	"OVF"
	]
	},		},
	"diskFormat": {		"diskFormat": {
	"description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format\nNOTE: The list of permitted values was adapted from \"Disk formats\" in [i.5] (OpenStack® documentation: \"Disk and container formats for images\").\n",		"description": "Disk format of a snapshot image is the format of the underlying disk image.\nPermitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM - QCOW2: a common disk image format, which can expand dynamically and supports copy on write - RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format\nSee note 2.\n",
	"type": "string",		"type": "string",
	"enum": [		"enum": ["AKI", "AMI", "ARI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
	"AKI",
	"AMI",
	"ARI",
	"ISO",
	"QCOW2",
	"RAW",
	"VDI",
	"VHD",
	"VHDX",
	"VMDK"
	]
	},		},
	"createdAt": {		"createdAt": {
	"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",		"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
	@@ -203,15 +156,12 @@
	}		}
	},		},
	"additionalArtifacts": {		"additionalArtifacts": {
	"description": "Information about VNF snapshot artifacts that are not VNFC snapshot images.\nNOTE: The attribute shall not be present before the VNF snapshot package content has been uploaded or built. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",		"description": "Information about VNF snapshot artifacts that are not VNFC snapshot images.\nSee note.\n",
	"type": "object",		"type": "object",
	"items": {		"items": {
	"description": "This type represents an artifact other than a software image which is contained in a VNF snapshot package.\n",		"description": "This type represents an artifact other than a software image which is contained in a VNF snapshot package.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["checksum", "isEncrypted"],
	"checksum",
	"isEncrypted"
	],
	"properties": {		"properties": {
	"artifactPath": {		"artifactPath": {
	"description": "A string defined in IETF RFC 8259.\n",		"description": "A string defined in IETF RFC 8259.\n",
	@@ -237,17 +187,9 @@
	}		}
	},		},
	"state": {		"state": {
	"description": "State of the VNF snapshot package. Permitted values: - CREATED: the VNF snapshot package information has been created. - BUILDING: the VNF snapshot package is being built. - UPLOADING: the VNF snapshot package is being uploaded. - EXTRACTING: the VNF snapshot packages content is being extracted. - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). - ERROR: failure during the VNF snapshot package building, uploading or processing. - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task.\n",		"description": "State of the VNF snapshot package. Permitted values: - CREATED: the VNF snapshot package information has been created. - BUILDING: the VNF snapshot package is being built. - UPLOADING: the VNF snapshot package is being uploaded. - EXTRACTING: the VNF snapshot packages content is being extracted. - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). - PROCESSING: the VNF snapshot is being processed. - ERROR: failure during the VNF snapshot package building, uploading or processing. - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task.\n",
	"type": "string",		"type": "string",
	"enum": [		"enum": ["CREATED", "BUILDING", "UPLOADING", "EXTRACTING", "AVAILABLE", "PROCESSING", "ERROR", "ERROR_EXTRACTING"]
	"CREATED",
	"BUILDING",
	"UPLOADING",
	"EXTRACTING",
	"AVAILABLE",
	"ERROR",
	"ERROR_EXTRACTING"
	]
	},		},
	"isCancelPending": {		"isCancelPending": {
	"description": "The Boolean is a data type having two values (true and false).\n",		"description": "The Boolean is a data type having two values (true and false).\n",
	@@ -256,32 +198,20 @@
	"failureDetails": {		"failureDetails": {
	"description": "Failure details associated to current error state of the VNF snapshot package state. If \"state\" is \"ERROR\" or \"ERROR_EXTRACTING\", this attribute shall be present unless it has been requested to be excluded via an attribute selector.\n",		"description": "Failure details associated to current error state of the VNF snapshot package state. If \"state\" is \"ERROR\" or \"ERROR_EXTRACTING\", this attribute shall be present unless it has been requested to be excluded via an attribute selector.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["errorType", "details"],
	"errorType",
	"details"
	],
	"properties": {		"properties": {
	"errorType": {		"errorType": {
	"description": "Type of error, when the failure happened (building, upload, processing, extracting).\nPermitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n",		"description": "Type of error, when the failure happened (building, upload, processing, extracting).\nPermitted values: - BUILD_ERROR - UPLOAD_ERROR - PROCESS_ERROR - CANCELLED - EXTRACTION_ERROR\n",
	"type": "string",		"type": "string",
	"enum": [		"enum": ["BUILD_ERROR", "UPLOAD_ERROR", "PROCESS_ERROR", "CANCELLED", "EXTRACTION_ERROR"]
	"BUILD_ERROR",
	"UPLOAD_ERROR",
	"PROCESS_ERROR",
	"CANCELLED",
	"EXTRACTION_ERROR"
	]
	},		},
	"details": {		"details": {
	"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",		"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807, the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["status", "detail"],
	"status",
	"detail"
	],
	"properties": {		"properties": {
	"type": {		"type": {
	"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",		"description": "A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
	"type": "string",		"type": "string",
	"format": "URI"		"format": "URI"
	},		},
	@@ -313,17 +243,12 @@
	"_links": {		"_links": {
	"description": "Links to resources related to this resource.\n",		"description": "Links to resources related to this resource.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["self", "packageContent"],
	"self",
	"packageContent"
	],
	"properties": {		"properties": {
	"self": {		"self": {
	"description": "This type represents a link to a resource using an absolute URI.\n",		"description": "This type represents a link to a resource using an absolute URI.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["href"],
	"href"
	],
	"properties": {		"properties": {
	"href": {		"href": {
	"description": "String formatted according to IETF RFC 3986.\n",		"description": "String formatted according to IETF RFC 3986.\n",
	@@ -334,9 +259,7 @@
	"packageContent": {		"packageContent": {
	"description": "This type represents a link to a resource using an absolute URI.\n",		"description": "This type represents a link to a resource using an absolute URI.\n",
	"type": "object",		"type": "object",
	"required": [		"required": ["href"],
	"href"
	],
	"properties": {		"properties": {
	"href": {		"href": {
	"description": "String formatted according to IETF RFC 3986.\n",		"description": "String formatted according to IETF RFC 3986.\n",

SOL003/VNFSnapshotPackageManagement-API/schemas/VnfSnapshotPkgInfos.schema.json

+217 −295

File changed.

Preview size limit exceeded, changes collapsed.

Admin message