updated PeerEntity and PeerEntities data types (2d568834) · Commits · NFV - Network Functions Virtualisation / api-tests

SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntities.schema.json

+164 −210

Original line number	Diff line number	Diff line
		@@ -3,13 +3,7 @@
		"items": {
		"description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n",
		"type": "object",
		"required": [
		"id",
		"peerEntityId",
		"name",
		"type",
		"peerEntityState"
		],
		"required": ["id", "peerEntityId", "name", "type", "peerEntityState"],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		@@ -24,17 +18,9 @@
		"type": "string"
		},
		"type": {
		"description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n",
		"description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - CISM The peer functional entity is a CISM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n",
		"type": "string",
		"enum": [
		"NFVO",
		"VNFM",
		"VIM",
		"WIM",
		"EM",
		"OSS",
		"WIM"
		]
		"enum": ["NFVO", "VNFM", "VIM", "WIM", "CISM", "EM", "OSS"]
		},
		"description": {
		"description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n",
		@@ -46,14 +32,7 @@
		"additionalProperties": {
		"description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n",
		"type": "object",
		"required": [
		"id",
		"name",
		"type",
		"standardVersion",
		"apiVersion",
		"apiEndpoint"
		],
		"required": ["id", "name", "type", "standardVersion", "apiVersion", "apiEndpoint"],
		"properties": {
		"name": {
		"description": "Human-readable name of the NFV-MANO interface.\n",
		@@ -92,27 +71,19 @@
		"type": "string"
		}
		},
		"required": [
		"apiUri"
		]
		"required": ["apiUri"]
		},
		"securityInfo": {
		"description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n",
		"type": "object",
		"required": [
		"authType",
		"oauthServerInfo"
		],
		"required": ["authType", "oauthServerInfo"],
		"properties": {
		"authType": {
		"description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749.\n",
		"type": "array",
		"items": {
		"type": "string",
		"enum": [
		"TLS_TUNNEL",
		"OAUTH2"
		]
		"enum": ["TLS_TUNNEL", "OAUTH2"]
		},
		"minItems": 1
		},
		@@ -123,9 +94,7 @@
		"dynamicDiscovery": {
		"description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n",
		"type": "object",
		"required": [
		"webFingerHost"
		],
		"required": ["webFingerHost"],
		"properties": {
		"webFingerHost": {
		"description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n",
		@@ -137,9 +106,7 @@
		"providedConfiguration": {
		"description": "Configuration data used to setup the authorization server identifier. See note.\n",
		"type": "object",
		"required": [
		"authServerId"
		],
		"required": ["authServerId"],
		"properties": {
		"authServerId": {
		"description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n",
		@@ -184,28 +151,15 @@
		"operationalState": {
		"description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n",
		"type": "string",
		"enum": [
		"STARTED",
		"STOPPED",
		"STOPPING",
		"STARTING",
		"RESTARTING"
		]
		"enum": ["STARTED", "STOPPED", "STOPPING", "STARTING", "RESTARTING"]
		},
		"administrativeState": {
		"description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n",
		"type": "string",
		"enum": [
		"LOCKED",
		"UNLOCKED",
		"LOCKING"
		]
		"enum": ["LOCKED", "UNLOCKED", "LOCKING"]
		}
		},
		"required": [
		"operationalState",
		"administrativeState"
		]
		"required": ["operationalState", "administrativeState"]
		}
		}
		}

SOL009/NFVManoConfigurationAndInformationManagement-API/schemas/PeerEntity.schema.json

+161 −207

Original line number	Diff line number	Diff line
		{
		"description": "This type represents an individual peer entity. * NOTE 1:\tThe value of the \"peerEntityId\" attribute is the same as the value of the \"id\" attribute in the\n \"ManoEntity\" of the corresponding NFV-MANO functional entity that acts as peer entity, and shall\n follow the uniqueness requirements set out in clause 5.6.2.2 for the \"id\" attribute.\n* NOTE 2:\tETSI GS NFV-IFA 031 [1] defines an additional attribute named \"apiDiscoveryEndpoint\" in the\n PeerManoEntity. The modelling of this attribute is not specified in the present document version.\n",
		"type": "object",
		"required": [
		"id",
		"peerEntityId",
		"name",
		"type",
		"peerEntityState"
		],
		"required": ["id", "peerEntityId", "name", "type", "peerEntityState"],
		"properties": {
		"id": {
		"description": "An identifier with the intention of being globally unique.\n",
		@@ -22,17 +16,9 @@
		"type": "string"
		},
		"type": {
		"description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS. - WIM The peer functional is a WIM.\n",
		"description": "The enumeration PeerEntityEnumType defines the permitted values to represent peer functional entities. it shall complains with the provisions : - NFVO\tThe peer functional entity is an NFVO. - VNFM\tThe peer functional entity is a VNFM. - VIM\t The peer functional entity is a VIM. - WIM\t The peer functional entity is a WIM. - CISM The peer functional entity is a CISM. - EM\t The peer functional entity is an EM. - OSS\t The peer functional entity is an OSS/BSS.\n",
		"type": "string",
		"enum": [
		"NFVO",
		"VNFM",
		"VIM",
		"WIM",
		"EM",
		"OSS",
		"WIM"
		]
		"enum": ["NFVO", "VNFM", "VIM", "WIM", "CISM", "EM", "OSS"]
		},
		"description": {
		"description": "Human-readable description of the peer functional entity.\nThis attribute can be modified with the PATCH method.\n",
		@@ -44,14 +30,7 @@
		"additionalProperties": {
		"description": "This type represents an interface consumed by the producer NFV MANO functional entity from another peer functional entity. * NOTE 1:\tThe information to be provided in this attribute shall relate to the specification and its version.\n For instance, \"ETSI GS NFV-SOL 003 (V2.4.1)\".\n* NOTE 2:\tDue to the security sensitive information associated to the attribute, based on access control\n policies, the API consumer might have read only, write only, read/write, or no access at all to\n the attribute's value. In case the API consumer is not allowed to read the value of the security\n sensitive attribute, the attribute shall be omitted when the information is to be provided in a\n response message, and shall be provided otherwise. In case the API consumer is not allowed to\n modify the value of the security sensitive attribute, and the modification request includes new\n attribute values, the whole modification request shall be rejected, and proper error information returned.\n",
		"type": "object",
		"required": [
		"id",
		"name",
		"type",
		"standardVersion",
		"apiVersion",
		"apiEndpoint"
		],
		"required": ["id", "name", "type", "standardVersion", "apiVersion", "apiEndpoint"],
		"properties": {
		"name": {
		"description": "Human-readable name of the NFV-MANO interface.\n",
		@@ -90,27 +69,19 @@
		"type": "string"
		}
		},
		"required": [
		"apiUri"
		]
		"required": ["apiUri"]
		},
		"securityInfo": {
		"description": "This type represents security related information for accessing an NFV-MANO service interface produced by an NFV-MANO functional entity. * NOTE:\tProvided configuration of the OAuth 2.0 authorization server information and configuration\n shall be supported, and dynamic configuration may be supported.\n",
		"type": "object",
		"required": [
		"authType",
		"oauthServerInfo"
		],
		"required": ["authType", "oauthServerInfo"],
		"properties": {
		"authType": {
		"description": "Type of API request authorization to be used by the API consumer accessing the API.\nThe support of authorization methods for the API consumer is specified in clause 8.3.6 of ETSI GS NFV-SOL 013.\nPermitted values: - TLS_TUNNEL: Using TLS tunnel, as defined by TLS 1.2 in IETF RFC 5246. - OAUTH2: Using access token, as defined by the OAuth 2.0 specification in IETF RFC 6749.\n",
		"type": "array",
		"items": {
		"type": "string",
		"enum": [
		"TLS_TUNNEL",
		"OAUTH2"
		]
		"enum": ["TLS_TUNNEL", "OAUTH2"]
		},
		"minItems": 1
		},
		@@ -121,9 +92,7 @@
		"dynamicDiscovery": {
		"description": "Configuration data used when performing dynamic discovery of the authorization server identifier. See note.\n",
		"type": "object",
		"required": [
		"webFingerHost"
		],
		"required": ["webFingerHost"],
		"properties": {
		"webFingerHost": {
		"description": "Server where the WebFinger service is hosted. When used, the request to the WebFinger resource shall conform as specified in clause 5.1.3 of ETSI GS NFV-SEC 022.\n",
		@@ -135,9 +104,7 @@
		"providedConfiguration": {
		"description": "Configuration data used to setup the authorization server identifier. See note.\n",
		"type": "object",
		"required": [
		"authServerId"
		],
		"required": ["authServerId"],
		"properties": {
		"authServerId": {
		"description": "Authorization server identifier as defined in ETSI GS NFV-SEC 022.\n",
		@@ -182,28 +149,15 @@
		"operationalState": {
		"description": "The enumeration OperationalStateEnumType defines values representing the operational state of an NFV-MANO functional application type of managed entity. The OperationalStateEnumType shall comply with the provisions:\n - STARTED\tThe managed entity is operational.\n - STOPPED\tThe managed entity is not operational.\n - STOPPING\tThe managed entity is in the transition to stop.\n - STARTING\tThe managed entity is in the transition to start and become operational.\n - RESTARTING\tThe managed entity is in the transition to stop and start again.\n",
		"type": "string",
		"enum": [
		"STARTED",
		"STOPPED",
		"STOPPING",
		"STARTING",
		"RESTARTING"
		]
		"enum": ["STARTED", "STOPPED", "STOPPING", "STARTING", "RESTARTING"]
		},
		"administrativeState": {
		"description": "The enumeration AdministrativeStateEnumType defines values representing the administrative state of a managed entity. The AdministrativeStateEnumType shall comply with the provisions:\n - LOCKED\tThe managed entity is administratively prohibited to be used.\n - UNLOCKED\tThe managed entity is administratively allowed to be used.\n - LOCKING\tThe managed entity is in the transition to be locked.\n",
		"type": "string",
		"enum": [
		"LOCKED",
		"UNLOCKED",
		"LOCKING"
		]
		"enum": ["LOCKED", "UNLOCKED", "LOCKING"]
		}
		},
		"required": [
		"operationalState",
		"administrativeState"
		]
		"required": ["operationalState", "administrativeState"]
		}
		}
		}
		No newline at end of file