Commit 23af7f1f authored by Francesca Moscatelli's avatar Francesca Moscatelli
Browse files

SOL005 Issue#21: parameters descriptions fixed

parent 17e4e896
Pipeline #10497 passed with stage
in 0 seconds
......@@ -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:
......
......@@ -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: |
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
NsdInfoModifications:
type: object
......
......@@ -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:
......
......@@ -38,11 +38,37 @@ paths:
description: |
The GET method queries information about multiple NS instances. See clause 6.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.
All attribute names that appear in the NsInstance 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 NsInstance structure in the response
body if this parameter is provided, or none of the parameters "all_fields", "fields",
"exclude_fields", "exclude_default" are provided:
- vnfInstances
- pnfInfo
- virtualLinkInfo
- vnffgInfo
- sapInfo
- nsScaleStatus
- additionalAffinityOrAntiAffinityRules
- wanConnectionInfo
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
......@@ -374,15 +400,25 @@ paths:
The API consumer can use this method to query status information about multiple NS lifecycle management
operation occurrences. See clause 6.4.9.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 NsLcmOpOcc 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/fields
- $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
- 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 [16] for details. The NFVO shall support this parameter.
The following attributes shall be excluded from the NsLcmOpOcc structure in the response body if this parameter is provided:
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 NsLcmOpOcc structure in the response
body if this parameter is provided:
- operationParams
- changedVnfInfo
- error
......@@ -643,7 +679,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 6.4.16.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 LccnSubscription 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:
......@@ -768,11 +813,31 @@ paths:
description: |
The GET method queries information about multiple VNF snapshots. See clause 6.4.19.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 VnfSnapshotInfo 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 VnfSnapshot structure in the response
body if this parameter is provided, or none of the parameters "all_fields", "fields",
"exclude_fields", "exclude_default" are provided:
- vnfInstance
- vnfcSnapshots
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
- $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
responses:
......@@ -861,6 +926,40 @@ 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 parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the NsInstance 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 NsInstance structure in the response
body if this parameter is provided, or none of the parameters "all_fields", "fields",
"exclude_fields", "exclude_default" are provided:
- vnfInstances
- pnfInfo
- virtualLinkInfo
- vnffgInfo
- sapInfo
- nsScaleStatus
- additionalAffinityOrAntiAffinityRules
- wanConnectionInfo
required: false
schema:
type: string
NsInstanceId:
name: nsInstanceId
in: path
......
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
HealNsRequest:
description: >
This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
......
......@@ -75,11 +75,30 @@ paths:
description: |
The API consumer can use this method to retrieve information about PM jobs. See clause 7.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.
All attribute names that appear in the PmJob 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 PmJob structure in the response body if
this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields",
"exclude_default" are provided:
- Reports
schema:
type: string
- $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
responses:
200:
......@@ -271,7 +290,16 @@ paths:
description: |
The API consumer can use this method to query information about thresholds. See clause 7.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 parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the Thresholds 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/nextpage_opaque_marker
responses:
200:
......
......@@ -38,11 +38,34 @@ paths:
description: |
The GET method queries the information of the VNF packages matching the filter. See clause 9.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.
All attribute names that appear in the VnfPkgInfo 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
VnfPkgInfo structure in the response body if this parameter is provided, or none of the parameters
"all_fields", "fields", "exclude_fields", "exclude_default" are provided:
- softwareImages
- additionalArtifacts
- userDefinedData