updated endpoints descriptions (087b5a36) · Commits · Miguel Angel Reina Ortega / SOL005

src/SOL005/APIVersion/APIVersion.yaml

+1 −1

Original line number	Diff line number	Diff line
		@@ -16,7 +16,7 @@ info:

		externalDocs:
		description: ETSI GS NFV-SOL 005 V3.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf

		servers:
		- url: http://127.0.0.1/

src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml

+8 −162

Original line number	Diff line number	Diff line
		@@ -17,7 +17,7 @@ info:

		externalDocs:
		description: ETSI GS NFV-SOL 005 V3.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf

		servers:
		- url: http://127.0.0.1/nfvici/v1
		@@ -32,9 +32,8 @@ paths:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Query NFVI capacity information
		description: \|
		The API consumer can use this method to retrieve information about NFVI capacity information.
		The API consumer can use this method to retrieve information about NFVI capacity information. See clause 10.4.2.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
		@@ -71,9 +70,8 @@ paths:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Query NFVI capacity information for a specific VIM
		description: \|
		The API consumer can use this method for reading an individual VIM’s NFVI capacity information.
		The API consumer can use this method for reading an individual VIM's NFVI capacity information. See clause 10.4.3.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		@@ -104,10 +102,8 @@ paths:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Query NFVI capacity thresholds
		description: \|
		This resource represents NFVI capacity thresholds.
		The API consumer can use this resource to create and query NFVI capacity thresholds.
		The API consumer can use this method to query information about NFVI capacity thresholds. See clause 10.4.4.3.2
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		@@ -135,11 +131,8 @@ paths:
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		post:
		summary: Create a NFVI capacity threshold
		description: \|
		The POST method creates a new NFVI capacity threshold.
		As a result of successfully executing this method, a new "Individual capacity threshold" resource as defined
		in clause 10.4.5 shall have been created.
		The POST method creates a new NFVI capacity threshold. See clause 10.4.4.3.1.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
		@@ -175,11 +168,8 @@ paths:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Query Individual NFVI capacity threshold
		description: \|
		The API consumer can use this method for reading information about an NFVI capacity threshold.
		This method shall follow the provisions specified in the tables 10.4.5.3.2-1 and 10.4.5.3.2-2 for URI query
		parameters, request and response data structures, and response codes.
		The API consumer can use this method for reading information about an NFVI capacity threshold. See clause 10.4.5.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		@@ -205,11 +195,8 @@ paths:
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		patch:
		summary: Modify an "Individual capacity threshold" resource
		description: \|
		This method iallows to modify an "Individual capacity threshold" resource.
		This method shall follow the provisions specified in the Tables 10.4.5.3.4-1 and 10.4.5.3.4-2 for URI query
		parameters, request and response data structures, and response codes.
		This method allows to modify an "Individual capacity threshold" resource. See clause 10.4.5.3.4.
		requestBody:
		$ref: '#/components/requestBodies/IndividualNfviCapacityThresholdRequest'
		responses:
		@@ -239,11 +226,8 @@ paths:
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		delete:
		summary: Delete an NFVI capacity threshold
		description: \|
		This method allows to delete an NFVI capacity threshold.
		As a result of successfully executing this method, the "Individual capacity threshold" resource shall not exist
		any longer.
		This method allows to delete an NFVI capacity threshold. See clause 10.4.5.3.5.
		responses:
		"204":
		$ref: '#/components/responses/IndividualCapacityThreshold.Delete'
		@@ -266,144 +250,6 @@ paths:
		"504":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		/subscriptions:
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Query multiple subscriptions.
		description: \|
		The API consumer can use this method to query the list of active subscriptions to NFVI capacity information
		notifications subscribed by the API consumer.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		responses:
		"200":
		$ref: '#/components/responses/NfviCiSubscriptions.Get'
		"400":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/400
		"401":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/401
		"403":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/403
		"404":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/404
		"405":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/405
		"406":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/406
		"500":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/500
		"503":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/503
		"504":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		post:
		summary: Create an NFVI capacity subscription
		description: \|
		The POST method creates a new subscription.
		This method shall follow the provisions specified in the Tables 10.4.6.3.1-1 and 10.4.6.3.1-2 for URI query
		parameters, request and response data structures, and response codes.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
		requestBody:
		$ref: '#/components/requestBodies/NfviCapacitySubscriptionRequest'
		responses:
		"201":
		$ref: '#/components/responses/NfviCiSubscriptions.Post'
		"303":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/303
		"400":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/400
		"401":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/401
		"403":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/403
		"404":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/404
		"405":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/405
		"406":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/406
		"422":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/422
		"500":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/500
		"503":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/503
		"504":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504
		callbacks:
		CapacityShortageNotification:
		$ref: '#/components/callbacks/CapacityShortageNotification'


		/subscriptions/{subscriptionId}:
		parameters:
		- $ref: '#/components/parameters/SubscriptionId'
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		get:
		summary: Read an individual subscription resource
		description: \|
		The API consumer can use this method for reading an individual subscription about NFVI capacity information
		notifications subscribed by the API consumer.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		"200":
		$ref: '#/components/responses/NfviCiSubscription.Get'
		"400":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/400
		"401":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/401
		"403":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/403
		"404":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/404
		"405":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/405
		"406":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/406
		"500":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/500
		"503":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/503
		"504":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		delete:
		summary: Terminate a subscription.
		description: \|
		This method terminates an individual subscription.
		This method shall follow the provisions specified in the Tables 10.4.7.3.5-1 and 10.4.7.3.5-2 for URI query
		parameters, request and response data structures, and response codes.
		responses:
		"204":
		$ref: '#/components/responses/NfviCiSubscription.Delete'
		"400":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/400
		"401":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/401
		"403":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/403
		"404":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/404
		"405":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/405
		"406":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/406
		"500":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/500
		"503":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/503
		"504":
		$ref: ../responses/SOL005_resp.yaml#/components/responses/504

		components:
		parameters:
		VimId:

src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml

+0 −73

Original line number	Diff line number	Diff line
		@@ -176,79 +176,6 @@ components:
		This attribute shall only be present if the subscriber requires authorization of notifications.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication

		CapacityShortageNotification:
		type: object
		description: \|
		This notification informs the receiver that the available NFVI capacity has crossed below a threshold value or
		has re-covered from a capacity shortage. It shall comply with the provisions defined in Table 10.5.2.10-1.
		required:
		- id
		- notificationType
		- thresholdId
		- timeStamp
		- direction
		- capacityInformation
		- objectInstanceId
		properties:
		id:
		description: \|
		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: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		notificationType:
		description: \|
		Discriminator for the different notification types.
		Shall be set to "CapacityShortageNotification" for this notification type.
		type: string
		thresholdId:
		description: \|
		Identifier of the threshold which has been crossed
		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		timeStamp:
		description: \|
		Date and time of the generation of the notification.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime
		objectInstanceId:
		description: \|
		Identifies the VIM’s NFVI capacity information instance (measured object instance) in which the available
		NFVI capacity has crossed a threshold value.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		subObjectInstanceId:
		description: \|
		Identifier of the sub-object of the measured object to which the measurement applies.
		Refer to the definition of the "CapacityThreshold" in clause 10.5.2.7.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim
		direction:
		description: \|
		Specifies if the threshold has been crossed in UP or DOWN direction.
		type: string
		enum:
		- UP
		- DOWN
		capacityInformation:
		description: \|
		Information about the available, reserved, allocated/used, and total capacity of the NFVI.
		If the threshold creation process does specify a resource zone and/or vimId, the information is provided
		for the resource zone/vimId where the NFVI capacity has crossed the thresholdas indicated by the
		"subObjectInstanceId" and "objectInstanceId" attributes.
		$ref: "#/components/schemas/NfviCapacityMeasurement"
		_links:
		description: \|
		Links to resources related to this notification.
		type: object
		required:
		- threshold
		properties:
		objectInstance:
		description: \|
		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: ../../definitions/SOL005_def.yaml#/definitions/NotificationLink
		threshold:
		description: \|
		Link to the resource that represents the threshold that was crossed.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/NotificationLink

		NfviCapacityInfoNotificationsFilter:
		type: object
		description: \|

src/SOL005/NFVICapacityInformationNotification/NFVICapacityInformationNotification.yaml

0 → 100644

+144 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.2

		info:
		title: SOL005 - NFVI Capacity Information Notification Interface
		description: \|
		SOL005 - NFVI Capacity Information Notification Interface
		IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it
		refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification
		takes precedence.
		Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
		contact:
		name: NFV-SOL WG
		license:
		name: ETSI Forge copyright notice
		url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
		version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

		externalDocs:
		description: ETSI GS NFV-SOL 005 V3.5.1
		url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf

		servers:
		- url: http://127.0.0.1/callback/v2
		- url: https://127.0.0.1/callback/v2

		paths:
		###############################################################################
		# Notification endpoint NsdOnBoardingNotification #
		###############################################################################
		/URI_is_provided_by_the_client_when_creating_the_subscription-CapacityShortageNotification:
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Version
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept

		post:
		description: \|
		The POST method delivers a notification regarding an NFVI capacity information event from the API producer to
		an API consumer. The API consumer shall have previously created an "Individual capacity threshold" resource.
		See clause 10.4.6.3.1.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
		requestBody:
		$ref: '#/components/requestBodies/CapacityShortageNotification'
		responses:
		204:
		$ref: '#/components/responses/CapacityShortageNotification.Post.204'
		400:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
		401:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
		403:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
		404:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
		405:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
		406:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
		500:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
		503:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/503"

		get:
		description: \|
		The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
		e.g. during creation of the capacity threshold resource. See clause 10.4.6.3.2.
		responses:
		204:
		$ref: '#/components/responses/CapacityShortageNotification.Get.204'
		400:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
		401:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
		403:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
		404:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
		405:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
		406:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
		500:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
		503:
		$ref: "../responses/SOL005_resp.yaml#/components/responses/503"

		components:
		requestBodies:
		CapacityShortageNotification:
		description: \|
		A notification about the successful on-boarding of an NSD.
		content:
		application/json:
		schema:
		$ref: "definitions/SOL005NFVICapacityInformationNotification_def.yaml#/components/schemas/CapacityShortageNotification"
		required: true

		responses:
		CapacityShortageNotification.Post.204:
		description: \|
		204 NO CONTENT

		Shall be returned when the notification has been delivered successfully.
		headers:
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: \|
		Version of the API used in the response.
		style: simple
		explode: false
		schema:
		type: string

		CapacityShortageNotification.Get.204:
		description: \|
		204 NO CONTENT

		Shall be returned when the notification endpoint has been tested successfully.
		The response body shall be empty.
		headers:
		WWW-Authenticate:
		description: \|
		Challenge if the corresponding HTTP request has not provided authorization, or error details if the
		corresponding HTTP request has provided an invalid authorization token.
		style: simple
		explode: false
		schema:
		type: string
		Version:
		description: \|
		Version of the API used in the response.
		style: simple
		explode: false
		schema:
		type: string

src/SOL005/NFVICapacityInformationNotification/definitions/SOL005NFVICapacityInformationNotification_def.yaml

0 → 100644

+76 −0

Original line number	Diff line number	Diff line
		# Copyright (c) ETSI 2017.
		# https://forge.etsi.org/etsi-forge-copyright-notice.txt
		components:
		schemas:
		CapacityShortageNotification:
		type: object
		description: \|
		This notification informs the receiver that the available NFVI capacity has crossed below a threshold value or
		has re-covered from a capacity shortage. It shall comply with the provisions defined in Table 10.5.2.10-1.
		required:
		- id
		- notificationType
		- thresholdId
		- timeStamp
		- direction
		- capacityInformation
		- objectInstanceId
		properties:
		id:
		description: \|
		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: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		notificationType:
		description: \|
		Discriminator for the different notification types.
		Shall be set to "CapacityShortageNotification" for this notification type.
		type: string
		thresholdId:
		description: \|
		Identifier of the threshold which has been crossed
		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		timeStamp:
		description: \|
		Date and time of the generation of the notification.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/DateTime
		objectInstanceId:
		description: \|
		Identifies the VIM’s NFVI capacity information instance (measured object instance) in which the available
		NFVI capacity has crossed a threshold value.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/Identifier
		subObjectInstanceId:
		description: \|
		Identifier of the sub-object of the measured object to which the measurement applies.
		Refer to the definition of the "CapacityThreshold" in clause 10.5.2.7.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim
		direction:
		description: \|
		Specifies if the threshold has been crossed in UP or DOWN direction.
		type: string
		enum:
		- UP
		- DOWN
		capacityInformation:
		description: \|
		Information about the available, reserved, allocated/used, and total capacity of the NFVI.
		If the threshold creation process does specify a resource zone and/or vimId, the information is provided
		for the resource zone/vimId where the NFVI capacity has crossed the thresholdas indicated by the
		"subObjectInstanceId" and "objectInstanceId" attributes.
		$ref: ../../NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml#/components/schemas/NfviCapacityMeasurement
		_links:
		description: \|
		Links to resources related to this notification.
		type: object
		required:
		- threshold
		properties:
		objectInstance:
		description: \|
		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: ../../definitions/SOL005_def.yaml#/definitions/NotificationLink
		threshold:
		description: \|
		Link to the resource that represents the threshold that was crossed.
		$ref: ../../definitions/SOL005_def.yaml#/definitions/NotificationLink
		No newline at end of file