Loading src/SOL005/NSDManagement/NSDManagement.yaml +11 −5 Original line number Original line Diff line number Diff line Loading @@ -412,16 +412,22 @@ paths: • If the "Accept" header contains both "text/plain" and "application/zip", it is up • If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned. a ZIP file shall be returned. The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007 The default format of the ZIP file shall comply with the CSAR format as specified in ETSI GS NFV-SOL 007 where only the YAML files representing the NSD, and information necessary to navigate where only the YAML files representing the NSD, and information necessary to navigate the ZIP file and to identify the file that is the entry point for parsing the NSD and the ZIP file and to identify the file that is the entry point for parsing the NSD and (if requested) further security information are included. This means that the content (if requested) further security information are included and other artifacts referenced from the YAML files are excluded. This means that the content of the ZIP archive shall contain the following files from the NSD archive: of the ZIP archive shall contain the following files from the NSD archive: • TOSCA.meta (if available in the NSD archive); • TOSCA.meta (if available in the NSD archive); • the main service template (either as referenced from TOSCA.meta or available as a • The main TOSCA definitions YAML file (either as referenced by the Entry-Definitions keyword from TOSCA.meta or available as a file with the extension ".yml" or ".yaml" from the root of the archive); file with the extension ".yml" or ".yaml" from the root of the archive); • every component of the NSD referenced (recursively) from the main service template; • Other TOSCA YAML files, if any, as referenced by the Other-Definitions keyword from TOSCA.meta; • the related security information, if the "include_signatures" URI parameter is provided, as follows: • Every component of the NSD referenced (recursively) from the theYAML files as mentioned above; NOTE 1: For a NSD based on TOSCA, it includes all the imported type definition files as indicated in the top level the main service template and in any of the lower level service template if it has any as described in ETSI GS NFV-SOL 001. NOTE 2: For a NSD based on YANG, it includes the file as indicated by the "yang_definitions" keyname in the metadata section of the main yaml file as described in ETSI GS NFV-SOL 007. • The related security information, if the "include_signatures" URI parameter is provided, as follows: - the manifest file; - the manifest file; - the singleton certificate file in the root of the NSD archive (if available in the NSD archive); - the singleton certificate file in the root of the NSD archive (if available in the NSD archive); - the signing certificates of the individual files included in the ZIP archive - the signing certificates of the individual files included in the ZIP archive Loading src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +2 −2 Original line number Original line Diff line number Diff line Loading @@ -22,7 +22,7 @@ definitions: description: > description: > Modifications of the userDefinedData attribute in NsdInfo Modifications of the userDefinedData attribute in NsdInfo data type. See note. If present, these modifications shall be applied data type. See note. If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]). according to the rules of JSON Merge Patch (see IETF RFC 7396). NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. type: array type: array items: items: Loading Loading @@ -273,7 +273,7 @@ definitions: userDefinedData: userDefinedData: description: > description: > User defined data for the individual PNF descriptor resource. User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method. This attribute can be modified with the Patch method. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" _links: _links: required: required: Loading src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +8 −0 Original line number Original line Diff line number Diff line Loading @@ -70,6 +70,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/405" $ref: "../responses/SOL005_resp.yaml#/components/responses/405" 406: 406: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -170,6 +172,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 412: 412: $ref: "../responses/SOL005_resp.yaml#/components/responses/412" $ref: "../responses/SOL005_resp.yaml#/components/responses/412" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -284,6 +288,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/405" $ref: "../responses/SOL005_resp.yaml#/components/responses/405" 406: 406: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -384,6 +390,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 412: 412: $ref: "../responses/SOL005_resp.yaml#/components/responses/412" $ref: "../responses/SOL005_resp.yaml#/components/responses/412" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml +22 −16 Original line number Original line Diff line number Diff line Loading @@ -435,7 +435,7 @@ definitions: description: > description: > New value of the "authentication" attribute, or "null" to remove the attribute. 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 If present in a request body, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). the rules of JSON Merge Patch (see IETF RFC 7396). This attribute shall not be present in response bodies. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" Loading @@ -460,7 +460,7 @@ definitions: description: > description: > New value of the "authentication" attribute, or "null" to remove the attribute. 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 If present in a request body, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). the rules of JSON Merge Patch (see IETF RFC 7396). This attribute shall not be present in response bodies. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" Loading Loading @@ -520,7 +520,7 @@ definitions: description: > description: > Group of performance metrics. Group of performance metrics. A metric group is a pre-defined list of metrics, A metric group is a pre-defined list of metrics, known to the producer that it can decompose to known to the API producer that it can decompose to individual metrics. Valid values are specified as individual metrics. Valid values are specified as "Measurement Group" values in clause 7.3 of ETSI "Measurement Group" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes GS NFV-IFA 027. At least one of the two attributes Loading @@ -530,29 +530,35 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/String" $ref: "../../definitions/SOL005_def.yaml#/definitions/String" collectionPeriod: collectionPeriod: description: > description: > Specifies the periodicity at which the producer Specifies the periodicity at which the API producer will collect performance information. The unit will collect performance information. The unit shall be seconds. shall be seconds. At the end of each reportingPeriod, the producer will inform the consumer about availability of the performance At the end of each reportingPeriod, the API producer will inform data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be the API consumer about availability of the performance data collected equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be In particular when choosing short collection and reporting periods, supported depends on the capability of the producing entity. the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer type: integer minimum: 0 minimum: 0 default: 0 default: 0 reportingPeriod: reportingPeriod: description: > description: > Specifies the periodicity at which the producer Specifies the periodicity at which the API producer will report to the consumer. will report to the API consumer. about performance information. The unit shall be seconds. about performance information. The unit shall be seconds. At the end of each reportingPeriod, the producer will inform the consumer about availability of the performance At the end of each reportingPeriod, the API producer will inform the data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be API consumer about availability of the performance data collected for equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be In particular when choosing short collection and reporting periods, supported depends on the capability of the producing entity. the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer type: integer minimum: 0 minimum: 0 default: 0 default: 0 Loading src/SOL005/NSPerformanceManagementNotification/definitions/SOL005NSPerformanceManagementNotification_def.yaml +5 −0 Original line number Original line Diff line number Diff line Loading @@ -14,6 +14,7 @@ definitions: - id - id - notificationType - notificationType - timeStamp - timeStamp - pmJobId - objectType - objectType - objectInstanceId - objectInstanceId - _links - _links Loading @@ -36,6 +37,10 @@ definitions: description: > description: > Date and time of the generation of the notification. Date and time of the generation of the notification. $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" pmJobId: description: > Identifier of the PM job for which performance information is available. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" objectType: objectType: description: > description: > Type of the measured object. Type of the measured object. Loading Loading
src/SOL005/NSDManagement/NSDManagement.yaml +11 −5 Original line number Original line Diff line number Diff line Loading @@ -412,16 +412,22 @@ paths: • If the "Accept" header contains both "text/plain" and "application/zip", it is up • If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned. a ZIP file shall be returned. The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007 The default format of the ZIP file shall comply with the CSAR format as specified in ETSI GS NFV-SOL 007 where only the YAML files representing the NSD, and information necessary to navigate where only the YAML files representing the NSD, and information necessary to navigate the ZIP file and to identify the file that is the entry point for parsing the NSD and the ZIP file and to identify the file that is the entry point for parsing the NSD and (if requested) further security information are included. This means that the content (if requested) further security information are included and other artifacts referenced from the YAML files are excluded. This means that the content of the ZIP archive shall contain the following files from the NSD archive: of the ZIP archive shall contain the following files from the NSD archive: • TOSCA.meta (if available in the NSD archive); • TOSCA.meta (if available in the NSD archive); • the main service template (either as referenced from TOSCA.meta or available as a • The main TOSCA definitions YAML file (either as referenced by the Entry-Definitions keyword from TOSCA.meta or available as a file with the extension ".yml" or ".yaml" from the root of the archive); file with the extension ".yml" or ".yaml" from the root of the archive); • every component of the NSD referenced (recursively) from the main service template; • Other TOSCA YAML files, if any, as referenced by the Other-Definitions keyword from TOSCA.meta; • the related security information, if the "include_signatures" URI parameter is provided, as follows: • Every component of the NSD referenced (recursively) from the theYAML files as mentioned above; NOTE 1: For a NSD based on TOSCA, it includes all the imported type definition files as indicated in the top level the main service template and in any of the lower level service template if it has any as described in ETSI GS NFV-SOL 001. NOTE 2: For a NSD based on YANG, it includes the file as indicated by the "yang_definitions" keyname in the metadata section of the main yaml file as described in ETSI GS NFV-SOL 007. • The related security information, if the "include_signatures" URI parameter is provided, as follows: - the manifest file; - the manifest file; - the singleton certificate file in the root of the NSD archive (if available in the NSD archive); - the singleton certificate file in the root of the NSD archive (if available in the NSD archive); - the signing certificates of the individual files included in the ZIP archive - the signing certificates of the individual files included in the ZIP archive Loading
src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +2 −2 Original line number Original line Diff line number Diff line Loading @@ -22,7 +22,7 @@ definitions: description: > description: > Modifications of the userDefinedData attribute in NsdInfo Modifications of the userDefinedData attribute in NsdInfo data type. See note. If present, these modifications shall be applied data type. See note. If present, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]). according to the rules of JSON Merge Patch (see IETF RFC 7396). NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present. type: array type: array items: items: Loading Loading @@ -273,7 +273,7 @@ definitions: userDefinedData: userDefinedData: description: > description: > User defined data for the individual PNF descriptor resource. User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method. This attribute can be modified with the Patch method. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" _links: _links: required: required: Loading
src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +8 −0 Original line number Original line Diff line number Diff line Loading @@ -70,6 +70,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/405" $ref: "../responses/SOL005_resp.yaml#/components/responses/405" 406: 406: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -170,6 +172,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 412: 412: $ref: "../responses/SOL005_resp.yaml#/components/responses/412" $ref: "../responses/SOL005_resp.yaml#/components/responses/412" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -284,6 +288,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/405" $ref: "../responses/SOL005_resp.yaml#/components/responses/405" 406: 406: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading Loading @@ -384,6 +390,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/components/responses/406" $ref: "../responses/SOL005_resp.yaml#/components/responses/406" 412: 412: $ref: "../responses/SOL005_resp.yaml#/components/responses/412" $ref: "../responses/SOL005_resp.yaml#/components/responses/412" 422: $ref: "../responses/SOL005_resp.yaml#/components/responses/422" 500: 500: $ref: "../responses/SOL005_resp.yaml#/components/responses/500" $ref: "../responses/SOL005_resp.yaml#/components/responses/500" 503: 503: Loading
src/SOL005/NSPerformanceManagement/definitions/SOL005NSPerformanceManagement_def.yaml +22 −16 Original line number Original line Diff line number Diff line Loading @@ -435,7 +435,7 @@ definitions: description: > description: > New value of the "authentication" attribute, or "null" to remove the attribute. 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 If present in a request body, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). the rules of JSON Merge Patch (see IETF RFC 7396). This attribute shall not be present in response bodies. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" Loading @@ -460,7 +460,7 @@ definitions: description: > description: > New value of the "authentication" attribute, or "null" to remove the attribute. 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 If present in a request body, these modifications shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). the rules of JSON Merge Patch (see IETF RFC 7396). This attribute shall not be present in response bodies. This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" Loading Loading @@ -520,7 +520,7 @@ definitions: description: > description: > Group of performance metrics. Group of performance metrics. A metric group is a pre-defined list of metrics, A metric group is a pre-defined list of metrics, known to the producer that it can decompose to known to the API producer that it can decompose to individual metrics. Valid values are specified as individual metrics. Valid values are specified as "Measurement Group" values in clause 7.3 of ETSI "Measurement Group" values in clause 7.3 of ETSI GS NFV-IFA 027. At least one of the two attributes GS NFV-IFA 027. At least one of the two attributes Loading @@ -530,29 +530,35 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/String" $ref: "../../definitions/SOL005_def.yaml#/definitions/String" collectionPeriod: collectionPeriod: description: > description: > Specifies the periodicity at which the producer Specifies the periodicity at which the API producer will collect performance information. The unit will collect performance information. The unit shall be seconds. shall be seconds. At the end of each reportingPeriod, the producer will inform the consumer about availability of the performance At the end of each reportingPeriod, the API producer will inform data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be the API consumer about availability of the performance data collected equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be In particular when choosing short collection and reporting periods, supported depends on the capability of the producing entity. the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer type: integer minimum: 0 minimum: 0 default: 0 default: 0 reportingPeriod: reportingPeriod: description: > description: > Specifies the periodicity at which the producer Specifies the periodicity at which the API producer will report to the consumer. will report to the API consumer. about performance information. The unit shall be seconds. about performance information. The unit shall be seconds. At the end of each reportingPeriod, the producer will inform the consumer about availability of the performance At the end of each reportingPeriod, the API producer will inform the data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be API consumer about availability of the performance data collected for equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the collection periods within one reporting period are reported together. within one reporting period are reported together. In particular when choosing short collection and reporting periods, the number of PM jobs that can be In particular when choosing short collection and reporting periods, supported depends on the capability of the producing entity. the number of PM jobs that can be supported depends on the capability of the producing entity. type: integer type: integer minimum: 0 minimum: 0 default: 0 default: 0 Loading
src/SOL005/NSPerformanceManagementNotification/definitions/SOL005NSPerformanceManagementNotification_def.yaml +5 −0 Original line number Original line Diff line number Diff line Loading @@ -14,6 +14,7 @@ definitions: - id - id - notificationType - notificationType - timeStamp - timeStamp - pmJobId - objectType - objectType - objectInstanceId - objectInstanceId - _links - _links Loading @@ -36,6 +37,10 @@ definitions: description: > description: > Date and time of the generation of the notification. Date and time of the generation of the notification. $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" pmJobId: description: > Identifier of the PM job for which performance information is available. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" objectType: objectType: description: > description: > Type of the measured object. Type of the measured object. Loading