SOL005 Issue#21: parameters descriptions fixed (23af7f1f) · Commits · Miguel Angel Reina Ortega / SOL005

src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml

+58 −4

Original line number	Diff line number	Diff line
		@@ -38,11 +38,40 @@ paths:
		description: \|
		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
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter. If the OSS/BSS does not supply a filter value
		for the "timeInterval" attribute in the NfviCapacityInfo, a query of the current NFVI
		capacity information available by the NFVO is requested.
		The following attribute names in the NfviCapacityInfo shall be supported by the NFVO
		in the filter expression:
		- resourceZoneId
		- vimId
		- timeInterval
		- resourceType
		- capacityMeasurementName
		- capacity values: {totalCapacity, allocatedCapacity, reservedCapacity, availableCapacity}
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
		- in: query
		name: exclude_default
		description: >
		Indicates to exclude the following complex attributes from the response. See clause 5.3 of
		ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
		The following attributes shall be excluded from the NfviCapacityInfo structure in the response
		body if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",
		"exclude_default" are provided:
		- capacityInfoPerZone
		- totalCapacityInfo
		- timeInterval
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		@@ -76,7 +105,23 @@ paths:
		description: \|
		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
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter. If the OSS/BSS does not supply a filter value
		for the timeInterval attribute in the NfviCapacityInfo, a query of the current NFVI
		capacity information available by the NFVO is requested.
		The following attribute names in the NfviCapacityInfo shall be supported by the NFVO
		in the filter expression:
		- resourceZoneId
		- timeInterval
		- resourceType
		- capacityMeasurementName
		- capacity values: {totalCapacity, allocatedCapacity, reservedCapacity, availableCapacity}
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		"200":
		@@ -108,7 +153,16 @@ paths:
		description: \|
		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
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the CapacityThreshold data type and in data types
		referenced from it shall be supported by the NFVO in the filter expression.
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		responses:

src/SOL005/NSDManagement/NSDManagement.yaml

+132 −14

Original line number	Diff line number	Diff line
		@@ -76,11 +76,31 @@ paths:
		description: \|
		The GET method queries information about multiple NS descriptor resources. See clause 5.4.2.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this filtering parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the NsdInfo and in data types referenced from it shall
		be supported by the NFVO in the filter expression.
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
		- in: query
		name: exclude_default
		description: >
		Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS
		NFV-SOL 013 for details. The NFVO shall support this parameter.
		The following attributes shall be excluded from the NsdInfo structure in the response body if this
		parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",
		"exclude_default" are provided:
		- userDefinedData
		- onboardingFailureDetails
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		responses:
		200:
		@@ -328,7 +348,19 @@ paths:
		The GET method reads the content of the manifest file within an NSD archive. See clasue 5.4.4b.3.2.
		parameters:
		- $ref: '#/components/parameters/AcceptTextOrZip'
		- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
		- in: query
		name: include_signatures
		description: >
		If this parameter is provided, the NFVO shall return the manifest and related security information
		(signature and certificate) either in a single text file if the signature and certificate are included
		in the manifest file, or in a zip file containing the manifest and the certificate file, if this is
		provided as a separate file in the NSD archive.
		If this parameter is not given, the NFVO shall provide only a copy of the manifest file, as onboarded.
		If the security information is included in the onboarded manifest, it shall also be included in the
		returned copy.
		This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
		schema:
		type: string
		responses:
		200:
		$ref: '#/components/responses/NsdArchiveManifest.Get.200'
		@@ -366,7 +398,15 @@ paths:
		The GET method fetches the content of an individual artifact within an NSD archive. See clause 5.4.4c.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
		- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
		- in: query
		name: include_signatures
		description: >
		If this parameter is provided, the NFVO shall return the artifact and related security information
		(such as signature and optional certificate) in a ZIP archive.
		If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
		This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
		schema:
		type: string
		responses:
		200:
		$ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.200'
		@@ -438,11 +478,31 @@ paths:
		description: \|
		The GET method queries information about multiple PNF descriptor resources. See clause 5.4.5.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
		The NFVO shall support receiving this filtering parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the PnfdInfo and in data types referenced from it shall
		be supported by the NFVO in the filter expression.
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
		- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
		- in: query
		name: exclude_default
		description: >
		Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS
		NFV-SOL 013for details. The NFVO shall support this parameter.
		The following attributes shall be excluded from the PnfdInfo structure in the response body if this
		parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",
		"exclude_default" are provided:
		- userDefinedData
		- onboardingFailureDetails
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		responses:
		200:
		@@ -690,7 +750,19 @@ paths:
		The GET method reads the content of the manifest file within a PNFD archive. See clause 5.4.7b.3.2.
		parameters:
		- $ref: '#/components/parameters/AcceptTextOrZip'
		- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
		- in: query
		name: include_signatures
		description: >
		If this parameter is provided, the NFVO shall return the manifest and related security information
		(signature and certificate) either in a single text file if the signature and certificate are included
		in the manifest file, or in a zip file containing the manifest and the certificate file, if this is
		provided as a separate file in the PNFD archive.
		If this parameter is not given, the NFVO shall provide only a copy of the manifest file, as onboarded.
		If the security information is included in the onboarded manifest, it shall also be included in the
		returned copy. This URI query parameter is a flag, i.e. it shall have no value.
		The NFVO shall support this parameter.
		schema:
		type: string
		responses:
		200:
		$ref: '#/components/responses/PnfdArchiveManifest.Get.200'
		@@ -731,7 +803,15 @@ paths:
		The GET method fetches the content of an individual artifact within a PNFD archive. See clause 5.4.7c.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Range
		- $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
		- in: query
		name: include_signatures
		description: >
		If this parameter is provided, the NFVO shall return the artifact and related security information
		(such as signature and optional certificate) in a ZIP archive.
		If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
		This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
		schema:
		type: string
		responses:
		200:
		$ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.200'
		@@ -806,7 +886,16 @@ paths:
		The GET method queries the list of active subscriptions of the functional block that invokes the method.
		It can be used e.g. for resynchronization after error situations. See clause 5.4.8.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- in: query
		name: filter
		description: >
		Attribute filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the NsdmSubscription and in data types referenced
		from it shall be supported by the NFVO in the filter expression.
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		@@ -896,6 +985,34 @@ paths:

		components:
		parameters:
		filter:
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this filtering parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the NsdInfo and in data types referenced from it shall
		be supported by the NFVO in the filter expression.
		in: query
		required: false
		schema:
		type: string

		exclude_default:
		name: exclude_default
		in: query
		description: >-
		Indicates to exclude the following complex attributes from the response.
		See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
		The following attributes shall be excluded from the NsdInfo structure in the response body
		if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",
		"exclude_default" are provided:
		- userDefinedData
		- onboardingFailureDetails
		required: false
		schema:
		type: string

		AcceptTextOrZip:
		name: Accept
		description: >
		@@ -907,6 +1024,7 @@ components:
		enum:
		- text/plain
		- application/zip

		AcceptText:
		name: Accept
		description: >
		@@ -917,6 +1035,7 @@ components:
		type: string
		enum:
		- text/plain

		ContentTypeZip:
		name: Content-Type
		description: \|
		@@ -1862,7 +1981,6 @@ components:
		Typically, this is due to the fact that "nsdOnboardingState" has a value different from "ONBOARDED".
		The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
		more information about the error.

		headers:
		Content-Type:
		description: \|

src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml

+0 −1

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

		definitions:
		NsdInfoModifications:
		type: object

src/SOL005/NSFaultManagement/NSFaultManagement.yaml

+28 −2

Original line number	Diff line number	Diff line
		@@ -38,7 +38,24 @@ paths:
		description: \|
		The API consumer can use this method to retrieve information about the alarm list. See clause 8.4.2.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		The following attribute names shall be supported by the NFVO in the filter expression:
		- id
		- nsInstanceId
		- rootCauseFaultyComponent.faultyNestedNsInstanceId
		- rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId
		- rootCauseFaultyComponent.faultyVnfInstanceId
		- rootCauseFaultyResource.faultyResourceType
		- eventType
		- perceivedSeverity
		- probableCause
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:
		@@ -145,7 +162,16 @@ paths:
		NS subscribed by the API consumer. It can be used e.g. for resynchronization after error situations.
		See clause 8.4.4.3.2.
		parameters:
		- $ref: ../components/SOL005_params.yaml#/components/parameters/filter
		- in: query
		name: filter
		description: >
		Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
		The NFVO shall support receiving this parameter as part of the URI query string.
		The OSS/BSS may supply this parameter.
		All attribute names that appear in the FmSubscription and in data types referenced from
		it shall be supported by the NFVO in the filter expression.
		schema:
		type: string
		- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
		- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
		responses:

src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml

+114 −15

File changed.

Preview size limit exceeded, changes collapsed.