Remove and separate common SOL002 SOL003 VNF Performance Mgmt API definitions (e3c7795e) · Commits · NFV - Network Functions Virtualisation / SOL002-SOL003

src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+13 −13

Original line number	Diff line number	Diff line
		@@ -532,7 +532,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest
		required: true

		PmJobModificationRequest:
		@@ -540,7 +540,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications
		required: true

		ThresholdCreationRequest:
		@@ -549,7 +549,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest
		required: true

		ThresholdModificationRequest:
		@@ -557,7 +557,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
		required: true

		responses:
		@@ -605,7 +605,7 @@ components:
		schema:
		type: array
		items:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PmJob

		PmJobs.Post.201:
		description: \|
		@@ -644,7 +644,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PmJob

		IndividualPmJob.Get.200:
		description: \|
		@@ -690,7 +690,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PmJob

		IndividualPmJob.Delete.204:
		description: \|
		@@ -763,7 +763,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications

		IndividualPmJobReport.Get.200:
		description: \|
		@@ -794,7 +794,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport

		Thresholds.Get.200:
		description: \|
		@@ -839,7 +839,7 @@ components:
		schema:
		type: array
		items:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/Threshold

		Thresholds.Post.201:
		description: \|
		@@ -878,7 +878,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/Threshold

		IndividualThreshold.Get.200:
		description: \|
		@@ -924,7 +924,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/Threshold

		IndividualThreshold.Delete.204:
		description: \|
		@@ -991,4 +991,4 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
		No newline at end of file
		$ref: definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications
		No newline at end of file

src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml→src/SOL002/VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml

+50 −54

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt

		definitions:
		CreateThresholdRequest:
		description: >
		@@ -21,7 +18,7 @@ definitions:
		objectInstanceId:
		description: >
		Identifier of the VNF instance associated with this threshold.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceIds:
		description: >
		Identifiers of the sub-object instances of the measured
		@@ -34,7 +31,7 @@ definitions:
		the measured object instance.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		criteria:
		description: >
		Criteria that define this threshold.
		@@ -42,7 +39,7 @@ definitions:
		callbackUri:
		description: >
		The URI of the endpoint to send the notification to.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		authentication:
		description: >
		Authentication parameters to configure the use of Authorization
		@@ -50,7 +47,7 @@ definitions:
		as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
		This attribute shall only be present if the API consumer requires
		authorization of notifications.
		$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

		CreatePmJobRequest:
		description: >
		@@ -65,8 +62,7 @@ definitions:
		objectType:
		description: >
		Type of the measured object.
		The applicable measured object type for a measurement
		is defined in clause 7.2 of ETSI GS NFV-IFA 027.
		The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027.
		type: string
		objectInstanceIds:
		description: >
		@@ -74,7 +70,7 @@ definitions:
		which performance information is requested to be collected.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceIds:
		description: >
		Identifiers of the sub-object instances of the measured
		@@ -88,7 +84,7 @@ definitions:
		will be taken for all sub-object instances of the measured object instance.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		criteria:
		description: >
		Criteria of the collection of performance information.
		@@ -96,7 +92,7 @@ definitions:
		callbackUri:
		description: >
		The URI of the endpoint to send the notification to.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		authentication:
		description: >
		Authentication parameters to configure the use of Authorization
		@@ -104,7 +100,7 @@ definitions:
		in clause 8.3.4 of ETSI GS NFV-SOL 013.
		This attribute shall only be present if the API consumer
		requires authorization of notifications.
		$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

		CrossingDirectionType:
		type: string
		@@ -135,7 +131,7 @@ definitions:
		Identifier of this notification. If a notification is sent multiple
		times due to multiple subscriptions, the "id" attribute of all these
		notifications shall have the same value.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		notificationType:
		description: >
		Discriminator for the different notification types. Shall be set to
		@@ -147,11 +143,11 @@ definitions:
		timeStamp:
		description: >
		Date and time of the generation of the notification.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		pmJobId:
		description: >
		Identifier of the PM job for which performance information is available.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		objectType:
		description: >
		Type of the measured object.
		@@ -161,7 +157,7 @@ definitions:
		objectInstanceId:
		description: >
		Identifier of the measured object instance. as per clause 6.2 of ETSI GS NFV-IFA 027.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceIds:
		description: >
		Identifiers of the sub-object instances of the measured
		@@ -173,7 +169,7 @@ definitions:
		Shall be absent otherwise.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		_links:
		description: >
		Links to resources related to this notification.
		@@ -187,18 +183,18 @@ definitions:
		Link to the resource representing the measured object instance to which the
		notification applies. Shall be present if the measured object instance
		information is accessible as a resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
		pmJob:
		description: >
		Link to the resource that represents the PM job for which
		performance information is available.
		$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
		performanceReport:
		description: >
		Link from which the available performance information of data
		type "PerformanceReport" can be obtained. This link should point
		to an "Individual performance report" resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"

		PerformanceReport:
		description: >
		@@ -240,13 +236,13 @@ definitions:
		objectInstanceId:
		description: >
		Identifier of the measured object instance for which the performance metric is reported
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceId:
		description: >
		Identifier of the sub-object instance of the measured object instance for which the performance
		metric is reported. Shall be present if this is required in clause 6.2 of ETSI GS NFV-IFA 027
		for the related measured object type. See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		performanceMetric:
		description: >
		Name of the metric collected. This attribute shall contain the related "Measurement Name"
		@@ -265,7 +261,7 @@ definitions:
		timeStamp:
		description: >
		Time stamp indicating when the data has been collected.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		value:
		description: >
		Value of the metric collected.
		@@ -277,7 +273,7 @@ definitions:
		Measurement context information related to the measured value.
		The set of applicable keys is defined per measurement in the
		related "Measurement Context" in clause 7.2 of ETSI GS NFV-IFA 027.
		$ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

		PmJob:
		description: >
		@@ -294,7 +290,7 @@ definitions:
		id:
		description: >
		Identifier of this PM job.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		objectType:
		description: >
		Type of the measured object.
		@@ -307,7 +303,7 @@ definitions:
		is collected.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceIds:
		description: >
		Identifiers of the sub-object instances of the measured object
		@@ -321,7 +317,7 @@ definitions:
		be taken for all sub-object instances of the measured object instance.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		criteria:
		description: >
		Criteria of the collection of performance information.
		@@ -329,7 +325,7 @@ definitions:
		callbackUri:
		description: >
		The URI of the endpoint to send the notification to.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		reports:
		description: >
		Information about available reports collected by this PM job.
		@@ -346,11 +342,11 @@ definitions:
		readyTime:
		description: >
		The time when the report was made available.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		expiryTime:
		description: >
		The time when the report will expire.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		fileSize:
		description: >
		The size of the report file in bytes, if known.
		@@ -369,7 +365,7 @@ definitions:
		self:
		description: >
		URI of this resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/Link"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		objects:
		description: >
		Links to resources representing the measure
		@@ -379,7 +375,7 @@ definitions:
		accessible as a resource.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/Link"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

		PmJobModifications:
		description: >
		@@ -396,7 +392,7 @@ definitions:
		callbackUri:
		description: >
		New value of the "callbackUri" attribute. The value "null" is not permitted. See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		authentication:
		description: >
		New value of the "authentication" attribute, or "null" to remove the attribute. If present
		@@ -404,7 +400,7 @@ definitions:
		Patch (see IETF RFC 7396).

		This attribute shall not be present in response bodies. See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

		PmJobCriteria:
		description: >
		@@ -463,7 +459,7 @@ definitions:
		Identifies a time boundary after which the reporting will stop.
		The boundary shall allow a single reporting as well as periodic
		reporting up to the boundary.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"

		Threshold:
		description: >
		@@ -480,7 +476,7 @@ definitions:
		id:
		description: >
		Identifier of this threshold resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		objectType:
		description: >
		Type of the measured object.
		@@ -490,7 +486,7 @@ definitions:
		objectInstanceId:
		description: >
		Identifier of the VNF instance associated with the threshold.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceIds:
		description: >
		Identifiers of the sub-object instances of the measured object
		@@ -503,7 +499,7 @@ definitions:
		measured object instance.
		type: array
		items:
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		criteria:
		description: >
		Criteria that define this threshold.
		@@ -511,7 +507,7 @@ definitions:
		callbackUri:
		description: >
		The URI of the endpoint to send the notification to.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		_links:
		description: >
		Links for this resource.
		@@ -522,13 +518,13 @@ definitions:
		self:
		description: >
		URI of this resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/Link"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
		object:
		description: >
		Link to a resource representing the measured object instance for which
		performance information is collected. Shall be present if the
		measured object instance information is accessible as a resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/Link"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

		ThresholdModifications:
		description: >
		@@ -545,14 +541,14 @@ definitions:
		callbackUri:
		description: >
		New value of the "callbackUri" attribute. The value "null" is not permitted. See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/Uri"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
		authentication:
		description: >
		New value of the "authentication" attribute, or "null" to remove the attribute. If present
		in a request body, these modifications shall be applied according to the rules of JSON Merge
		Patch (see IETF RFC 7396).
		This attribute shall not be present in response bodies. See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

		ThresholdCriteria:
		description: >
		@@ -645,7 +641,7 @@ definitions:
		Identifier of this notification. If a notification is sent multiple
		times due to multiple subscriptions, the "id" attribute of all these
		notifications shall have the same value.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		notificationType:
		description: >
		Discriminator for the different notification types. Shall be set to
		@@ -656,11 +652,11 @@ definitions:
		timeStamp:
		description: >
		Date and time of the generation of the notification.
		$ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
		thresholdId:
		description: >
		Identifier of the threshold which has been crossed.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		crossingDirection:
		description: >
		An indication of whether the threshold was crossed in upward or
		@@ -674,14 +670,14 @@ definitions:
		objectInstanceId:
		description: >
		Identifier that identifies a VNF instance.
		$ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
		subObjectInstanceId:
		description: >
		Identifier of the sub-object of the measured object to which the measurement applies.
		Shall be present if this is required in clause 6.2 of ETSI GS NFV-IFA 027 for the related
		measured object type.
		See note.
		$ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
		performanceMetric:
		description: >
		Performance metric associated with the threshold.
		@@ -699,7 +695,7 @@ definitions:
		Measurement context information related to the measured value.
		The set of applicable keys is defined per measurement in the
		related "Measurement Context" in clause 7.2 of ETSI GS NFV-IFA 027.
		$ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
		_links:
		description: >
		Links to resources related to this notification.
		@@ -712,9 +708,9 @@ definitions:
		Link to the resource representing the measured object instance to which the
		notified change applies. Shall be present if the measured object instance
		information is accessible as a resource.
		$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
		threshold:
		description: >
		Link to the resource that represents the threshold that was
		crossed.
		$ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
		No newline at end of file
		$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink"
		No newline at end of file

src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml

+2 −2

Original line number	Diff line number	Diff line
		@@ -139,7 +139,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification
		$ref: "../VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification"
		required: true

		ThresholdCrossedNotification:
		@@ -148,7 +148,7 @@ components:
		content:
		application/json:
		schema:
		$ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification
		$ref: "../VNFPerformanceManagement/definitions/SOL002VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification"
		required: true

		responses:

src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml

+11 −11

File changed.

Preview size limit exceeded, changes collapsed.

src/SOL003/VNFPerformanceManagement/definitions/SOL003VNFPerformanceManagement_def.yaml

0 → 100644

+716 −0

File added.

Preview size limit exceeded, changes collapsed.