From cd558f0730c0b612df4a45842c85d07db2fe16bd Mon Sep 17 00:00:00 2001 From: moscatelli Date: Tue, 7 May 2019 18:12:17 +0200 Subject: [PATCH] SOL002 overall data types consolidation --- .../VNFConfiguration/VNFConfiguration.yaml | 2 +- ...f.yaml => SOL002VNFConfiguration_def.yaml} | 102 +++++----- .../responses/VNFConfiguration_resp.yaml | 21 --- .../VNFFaultManagement.yaml | 36 ++-- ...yaml => SOL002VNFFaultManagement_def.yaml} | 48 ++--- .../responses/VNFFaultManagement_resp.yaml | 36 ---- .../VNFFaultManagementNotification.yaml | 32 ++-- .../VnfIndicatorNotificationsFilter_def.yaml | 2 +- .../VnfIndicatorSubscriptionRequest_def.yaml | 2 +- .../VnfIndicatorSubscription_def.yaml | 4 +- .../definitions/VnfIndicator_def.yaml | 4 +- .../VnfInstanceSubscriptionFilter_def.yaml | 6 +- .../VNFIndicatorNotification.yaml | 146 +++++++-------- ...fIndicatorValueChangeNotification_def.yaml | 2 +- .../VNFLifecycleManagement.yaml | 76 ++++---- .../VNFLifecycleManagement_def.yaml | 42 ++--- .../VNFLifecycleManagementNotification.yaml | 20 +- ...NFLifecycleManagementNotification_def.yaml | 2 +- .../VNFPerformanceManagement.yaml | 40 ++-- .../VNFPerformanceManagementNotification.yaml | 22 +-- .../VNFFaultManagement.yaml | 52 +++--- .../VNFFaultManagementNotification.yaml | 34 ++-- src/SOL003/VNFIndicator/VNFIndicator.yaml | 68 +++---- .../VNFIndicatorNotification.yaml | 14 +- .../VNFLifecycleManagement.yaml | 176 +++++++++--------- .../VNFLifecycleManagement_def.yaml | 10 +- .../VNFLifecycleManagement_resp.yaml | 4 +- .../VNFLifecycleManagementNotification.yaml | 28 +-- ...NFLifecycleManagementNotification_def.yaml | 2 +- .../VNFLifecycleOperationGranting.yaml | 20 +- .../VNFLifecycleOperationGranting_def.yaml | 80 ++++---- .../VNFPackageManagement.yaml | 68 +++---- .../definitions/VNFPackageManagement_def.yaml | 54 +++--- .../VNFPackageManagementNotification.yaml | 24 +-- .../VNFPackageManagementNotification_def.yaml | 12 +- .../VNFPerformanceManagement.yaml | 80 ++++---- .../VNFPerformanceManagementNotification.yaml | 24 +-- ...edResourcesQuotaAvailableNotification.yaml | 16 +- ...sourcesQuotaAvailableNotification_def.yaml | 4 +- ...uotaAvailableNotificationNotification.yaml | 14 +- ...AvailableNotificationNotification_def.yaml | 14 +- src/SOL003/definitions/SOL003_def.yaml | 22 +-- .../SOL002SOL003VNFFaultManagement_def.yaml | 172 +++++++++-------- .../SOL002SOL003VNFIndicator_def.yaml | 34 ++-- ...OL002SOL003VNFLifecycleManagement_def.yaml | 44 ++--- ...L003VNFLifecycleOperationGranting_def.yaml | 9 - ...002SOL003VNFPerformanceManagement_def.yaml | 64 +++---- 47 files changed, 858 insertions(+), 930 deletions(-) rename src/SOL002/VNFConfiguration/definitions/{VnfConfiguration_def.yaml => SOL002VNFConfiguration_def.yaml} (72%) delete mode 100644 src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml rename src/SOL002/VNFFaultManagement/definitions/{VNFFaultManagement_def.yaml => SOL002VNFFaultManagement_def.yaml} (76%) delete mode 100644 src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml delete mode 100644 src/definitions/SOL002SOL003VNFLifecycleOperationGranting_def.yaml diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index 927155d6..77b2b10b 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -68,7 +68,7 @@ paths: Configuration information about a VNF instance was read successfully. The response body shall contain a representation of the configuration resource. schema: - $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfiguration' + $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration' headers: Content-Type: description: The MIME type of the body of the response. diff --git a/src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml b/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml similarity index 72% rename from src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml rename to src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml index 998c4b1e..36c24796 100644 --- a/src/SOL002/VNFConfiguration/definitions/VnfConfiguration_def.yaml +++ b/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml @@ -1,24 +1,7 @@ -definitions: - - VnfConfiguration: - description: > - This type represents configuration parameters of a VNF instance and its VNFC instances. - type: object - required: - - vnfConfigurationData - properties: - vnfConfigurationData: - description: > - Configuration parameters of the VNF instance. - $ref: '#/definitions/VnfConfigurationData' - vnfcConfigurationData: - description: > - Configuration parameters of the VNFC instances. - type: array - items: - $ref: '#/definitions/VnfcConfigurationData' - +# Copyright (c) ETSI 2017. +# https://forge.etsi.org/etsi-forge-copyright-notice.txt +definitions: VnfConfigModifications: description: > This type represents request parameters for the "Set Configuration" operation. @@ -33,29 +16,29 @@ definitions: Modifications to configuration data for the VNF instance. See NOTE 1. If present, the modifications of the "vnfConfigurationData" attribute shall be applied according to the rules of JSON Merge PATCH (see IETF RFC 7396). - $ref: '#/definitions/VnfConfigurationData' + $ref: '#/definitions/VnfConfigurationData' vnfcConfigurationData: description: > Modifications to configuration data for certain VNFC instances. See NOTE 1 and NOTE 2. - If present, the modifications of the "vnfcConfigurationData" attribute shall follow these + If present, the modifications of the "vnfcConfigurationData" attribute shall follow these provisions: Modifying an attribute that is an array of objects of type "VnfcConfigurationData". Assumptions: - 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList" - is the "VnfcConfigurationData" array that contains the changes. - 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList". - 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that - has the same content of the "vnfcInstanceId" attribute as the "newEntry"; - a "newEntry" has no corresponding entry if no such "oldEntry" exists. - 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId" - is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId"). + 1) "oldList" is the "VnfcConfigurationData" array to be modified and "newList" + is the "VnfcConfigurationData" array that contains the changes. + 2) "oldEntry" is an entry in "oldList" and "newEntry" is an entry in "newList". + 3) A "newEntry" has a "corresponding entry" if there exists an "oldEntry" that + has the same content of the "vnfcInstanceId" attribute as the "newEntry"; + a "newEntry" has no corresponding entry if no such "oldEntry" exists. + 4) In any array of "VnfcConfigurationData" structures, the content of "vnfcInstanceId" + is unique (i.e. there shall be no two entries with the same content of "vnfcInstanceId"). Provisions: - 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList", - the "oldList" array shall be modified by adding that "newEntry". + 1) For each "newEntry" in "newList" that has no corresponding entry in "oldList", + the "oldList" array shall be modified by adding that "newEntry". - 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList", - the value of "oldEntry" shall be updated with the value of "newEntry" according to - the rules of JSON Merge PATCH (see IETF RFC 7396 ). + 2) For each "newEntry" in "newList" that has a corresponding "oldEntry" in "oldList", + the value of "oldEntry" shall be updated with the value of "newEntry" according to + the rules of JSON Merge PATCH (see IETF RFC 7396 ). type: array items: $ref: '#/definitions/VnfcConfigurationData' @@ -67,6 +50,23 @@ definitions: items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + VnfConfiguration: + description: > + This type represents configuration parameters of a VNF instance and its VNFC instances. + type: object + required: + - vnfConfigurationData + properties: + vnfConfigurationData: + description: > + Configuration parameters of the VNF instance. + $ref: '#/definitions/VnfConfigurationData' + vnfcConfigurationData: + description: > + Configuration parameters of the VNFC instances. + type: array + items: + $ref: '#/definitions/VnfcConfigurationData' VnfConfigurationData: description: > @@ -76,18 +76,17 @@ definitions: extCpConfig: description: > Configuration parameters for the external CPs of the VNF instance. - $ref: '#/definitions/CpConfiguration' + $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfSpecificData: description: > Additional configurable properties of the VNF instance declared in the VNFD as "VnfConfigurableProperties". - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' - + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' VnfcConfigurationData: description: > @@ -99,22 +98,21 @@ definitions: vnfcInstanceId: description: > Identifier of a VNFC instance to which this set of configuration data applies. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' extCpConfig: description: > Configuration parameters for the external CPs of the VNFC instance. - $ref: '#/definitions/CpConfiguration' + $ref: '#/definitions/CpConfiguration' dhcpServer: description: > IP address of the DHCP server that the VNF instance can use to obtain IP addresses to be assigned to its external CPs. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' vnfcSpecificData: description: > Additional configurable properties of the VNFC instance declared in the VNFD as "VnfcConfigurableProperties". - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' - + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs' CpConfiguration: description: > @@ -128,17 +126,17 @@ definitions: cpId: description: > Identifier of a CP instance within the namespace of a specific VNF instance or a VNFC instance. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' cpdId: description: > Identifier of the CPD in the VNFD. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' addresses: description: > Network address and port assigned to the CP. type: array items: - $ref: '#/definitions/CpAddress' + $ref: '#/definitions/CpAddress' CpAddress: description: > @@ -155,11 +153,11 @@ definitions: macAddress: description: > Mac address. See NOTE 2. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/MacAddress' ipAddress: description: > IP address. See NOTE 2. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IpAddress' useDynamicAddress: description: > Set to true if an address shall be assigned dynamically. Otherwise set to false. @@ -168,8 +166,4 @@ definitions: port: description: > The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.). - type: integer - - - - + type: integer \ No newline at end of file diff --git a/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml b/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml deleted file mode 100644 index 5f625c85..00000000 --- a/src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml +++ /dev/null @@ -1,21 +0,0 @@ -responses: - 409: - description: > - Conflict - - Another request is in progress that prohibits the fulfilment of - the current request, or the current resource state is inconsistent - with the request. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" diff --git a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml index b5d1890f..e1cfe5a4 100644 --- a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml @@ -1,6 +1,6 @@ swagger: "2.0" -info: +info: version: "1.2.0" title: SOL002 - VNF Fault Management interface description: > @@ -22,14 +22,14 @@ externalDocs: basePath: /vnffm/v1 -schemes: +schemes: - http - https -consumes: +consumes: - application/json -produces: +produces: - application/json paths: @@ -43,7 +43,7 @@ paths: # Alarms # ############################################################################### '/alarms': - #SOL003 location: 7.4.2 + #SOL003 location: 7.4.2 parameters: - name: Version description: > @@ -122,7 +122,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about zero or more alarms was queried successfully. @@ -156,7 +156,7 @@ paths: maximum: 1 minimum: 0 schema: - $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm" + $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -186,7 +186,7 @@ paths: # Individual alarm # ############################################################################### '/alarms/{alarmId}': - #SOL003 location: 7.4.3 + #SOL003 location: 7.4.3 parameters: - name: alarmId description: > @@ -232,7 +232,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about an individual alarm was read successfully. @@ -258,7 +258,7 @@ paths: maximum: 1 minimum: 0 schema: - $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm" + $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -309,7 +309,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The request was accepted and completed. The response body shall @@ -413,7 +413,7 @@ paths: description: The proposed "escalated perceived severity" value in: body schema: - $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest" + $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest" responses: 200: description: > @@ -456,7 +456,7 @@ paths: # Subscriptions # ############################################################################### '/subscriptions': - #SOL003 location: 7.4.4 + #SOL003 location: 7.4.4 parameters: - name: Version description: > @@ -497,7 +497,7 @@ paths: type: string responses: 201: - description: > + description: > 201 CREATED The subscription was created successfully. The response body shall @@ -627,7 +627,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The list of subscriptions was queried successfully. The response @@ -692,7 +692,7 @@ paths: # Individual subscription # ############################################################################### '/subscriptions/{subscriptionId}': - #SOL003 location: 7.4.5 + #SOL003 location: 7.4.5 parameters: - name: subscriptionId description: > @@ -738,7 +738,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The operation has completed successfully. @@ -794,7 +794,7 @@ paths: This method terminates an individual subscription. responses: 204: - description: > + description: > 204 NO CONTENT The subscription resource was deleted successfully. diff --git a/src/SOL002/VNFFaultManagement/definitions/VNFFaultManagement_def.yaml b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml similarity index 76% rename from src/SOL002/VNFFaultManagement/definitions/VNFFaultManagement_def.yaml rename to src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml index 41d093ae..d01180ed 100644 --- a/src/SOL002/VNFFaultManagement/definitions/VNFFaultManagement_def.yaml +++ b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml @@ -9,6 +9,7 @@ definitions: required: - id - managedObjectId + - vnfcInstanceIds - rootCauseFaultyResource - alarmRaisedTime - ackState @@ -19,7 +20,7 @@ definitions: - isRootCause - _links properties: - id: + id: description: > Identifier of this Alarm information element. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" @@ -27,6 +28,12 @@ definitions: description: > Identifier of the affected VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcInstanceIds: + description: > + Identifiers of the affected VNFC instances. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" rootCauseFaultyResource: description: > The virtualised resources that are causing the VNF fault. @@ -53,23 +60,21 @@ definitions: * UNACKNOWLEDGED * ACKNOWLEDGED. type: string - enum: + enum: - UNACKNOWLEDGED - ACKNOWLEDGED perceivedSeverity: - #description: > - # Perceived severity of the managed object failure. - # $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" - type: string - eventTime: + description: > + Perceived severity of the managed object failure. + $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" + eventTime: description: > Time stamp indicating when the fault was observed. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" eventType: - #description: > - # Type of event. - # todo: Fix - #$ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" + description: > + Type of event. + $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" type: string faultType: description: > @@ -84,12 +89,12 @@ definitions: Attribute indicating if this fault is the root for other correlated alarms. If TRUE, then the alarms listed in the attribute CorrelatedAlarmId are caused by this fault. - type: boolean + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" correlatedAlarmIds: description: > List of identifiers of other alarms correlated to this fault. type: array - items: + items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" faultDetails: description: > @@ -105,15 +110,12 @@ definitions: - self properties: self: - #description: > - # URI of this resource. + description: > + URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" objectInstance: - #description: > - # Link to the resource representing the VNF instance to which the - # notified alarm is correlated. Shall be present if the VNF - # instance information is accessible as a resource. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - - PerceivedSeverityRequest: - type: string \ No newline at end of file + description: > + Link to the resource representing the VNF instance to which the + notified alarm is correlated. Shall be present if the VNF + instance information is accessible as a resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" \ No newline at end of file diff --git a/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml b/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml deleted file mode 100644 index 8439306f..00000000 --- a/src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt - -responses: - 409-alarm-state-conflict: - description: > - Conflict - - The operation cannot be executed currently, due to a conflict with the - state of the "Individual alarm" resource. - Typically, this is due to the fact that the alarm is already in the - state that is requested to be set (such as trying to acknowledge an - already-acknowledged alarm). - The response body shall contain a ProblemDetails structure, in which the - "detail" attribute should convey more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - 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. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" diff --git a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 9d643eb7..3331c235 100644 --- a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -33,9 +33,9 @@ produces: - application/json paths: -############################################################################### -# Notification endpoint AlarmNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification': post: description: > @@ -75,7 +75,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -129,7 +129,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -163,9 +163,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint AlarmClearedNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmClearedNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification': post: description: > @@ -205,7 +205,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -259,7 +259,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -293,15 +293,15 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint AlarmListRebuiltNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmListRebuiltNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification': post: description: > Notify - + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: @@ -335,7 +335,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -389,7 +389,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml b/src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml index 6a8b9a43..af90510c 100644 --- a/src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/VnfIndicatorNotificationsFilter_def.yaml @@ -13,7 +13,7 @@ definitions: description: > Filter criteria to select VNF instances about which to notify. This attribute shall not be included when the VNFM sends a subscription request to a particular VNF instance. - $ref: 'VnfInstanceSubscriptionFilter_def.yaml#/definitions/VnfInstanceSubscriptionFilter' + $ref: 'VnfInstanceSubscriptionFilter_def.yaml#/definitions/VnfInstanceSubscriptionFilter' indicatorIds: description: > Match particular VNF indicator identifiers. diff --git a/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscriptionRequest_def.yaml b/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscriptionRequest_def.yaml index fc7b2b15..09e8c6d6 100644 --- a/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscriptionRequest_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscriptionRequest_def.yaml @@ -12,7 +12,7 @@ definitions: Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter' + $ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter' callbackUri: description: > The URI of the endpoint to send the notification to. diff --git a/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscription_def.yaml b/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscription_def.yaml index b22ef1fc..406680a1 100644 --- a/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscription_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/VnfIndicatorSubscription_def.yaml @@ -12,13 +12,13 @@ definitions: id: description: > Identifier of this subscription resource. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular notification is sent to the subscriber if the filter matches, or if there is no filter. - $ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter' + $ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter' callbackUri: description: > The URI of the endpoint to send the notification to. diff --git a/src/SOL002/VNFIndicator/definitions/VnfIndicator_def.yaml b/src/SOL002/VNFIndicator/definitions/VnfIndicator_def.yaml index 3348fab1..70523565 100644 --- a/src/SOL002/VNFIndicator/definitions/VnfIndicator_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/VnfIndicator_def.yaml @@ -1,6 +1,6 @@ definitions: - VnfIndicator: + VnfIndicator: type: object required: - id @@ -11,7 +11,7 @@ definitions: id: $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd' name: - type: string + type: string value: type: object vnfInstanceId: diff --git a/src/SOL002/VNFIndicator/definitions/VnfInstanceSubscriptionFilter_def.yaml b/src/SOL002/VNFIndicator/definitions/VnfInstanceSubscriptionFilter_def.yaml index 19981aaf..ea226bf6 100644 --- a/src/SOL002/VNFIndicator/definitions/VnfInstanceSubscriptionFilter_def.yaml +++ b/src/SOL002/VNFIndicator/definitions/VnfInstanceSubscriptionFilter_def.yaml @@ -18,7 +18,7 @@ definitions: If present, match VNF instances that were created based on a VNFD identified by one of the vnfdId values listed in this attribute. See NOTE 1. type: array - items: + items: $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' vnfProductsFromProviders: description: > @@ -47,7 +47,7 @@ definitions: description: > Name of the VNF product to match. type: string - versions: + versions: description: > If present, match VNF instances that belong to VNF products with certain versions and a certain product name, from one particular provider. @@ -72,7 +72,7 @@ definitions: description: > If present, match VNF instances with an instance identifier listed in this attribute. See NOTE 2. type: array - items: + items: $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' vnfInstanceNames: description: > diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 8ee53b08..5ab829db 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -1,6 +1,6 @@ swagger: "2.0" -info: +info: version: "1.2.0" title: SOL002 - VNF Indicator Notification Endpoint interface description: > @@ -24,87 +24,87 @@ schemes: - http - https -consumes: +consumes: - application/json -produces: +produces: - application/json paths: - /notificationendpoint: + /notificationendpoint: + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string + post: + summary: Notification endpoint + description: > + The API producer can use this resource to send notifications related to VNF indicator + value changes to a subscribed API consumer, which has provided the URI of this resource + during the subscription process. + The POST method delivers a notification from the server to the client. parameters: - - name: Version + - name: vnfIndicatorValueChangeNotification + in: body description: > - Version of the API requested to use when responding to this request. - in: header + A notification about VNF indicator value changes. required: true - type: string - post: - summary: Notification endpoint - description: > - The API producer can use this resource to send notifications related to VNF indicator - value changes to a subscribed API consumer, which has provided the URI of this resource - during the subscription process. - The POST method delivers a notification from the server to the client. - parameters: - - name: vnfIndicatorValueChangeNotification - in: body - description: > - A notification about VNF indicator value changes. - required: true - schema: - $ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' - responses: - 204: - description: > - No Content + schema: + $ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' + responses: + 204: + description: > + No Content - The notification was delivered successfully. The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 + The notification was delivered successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } - 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } - 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } - 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } - 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } - 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - get: - summary: Test notification endpoint. - description: > - Service Unavailable + 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } + 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } + 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } + 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } + 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } + 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } + 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } + 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } + 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } + get: + summary: Test notification endpoint. + description: > + Service Unavailable - The GET method allows the server to test the notification endpoint that is provided - by the client, e.g. during subscription. - responses: - 204: - description: > - No Content + The GET method allows the server to test the notification endpoint that is provided + by the client, e.g. during subscription. + responses: + 204: + description: > + No Content - The notification endpoint was tested successfully. The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } - 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } - 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } - 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } - 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } - 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } - 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } - 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } \ No newline at end of file + The notification endpoint was tested successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } + 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } + 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } + 404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } + 405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' } + 416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } + 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } + 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } + 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml b/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml index d4ab65d0..517979e3 100644 --- a/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml +++ b/src/SOL002/VNFIndicatorNotification/definitions/VnfIndicatorValueChangeNotification_def.yaml @@ -19,7 +19,7 @@ definitions: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' notificationType: description: > Discriminator for the different notification types. diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index fceed42a..91cbff64 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -1,6 +1,6 @@ swagger: "2.0" -info: +info: version: "1.2.0" title: SOL002 - VNF Lifecycle Management interface description: > @@ -22,14 +22,14 @@ externalDocs: basePath: /vnflcm/v1 -schemes: +schemes: - http - https -consumes: +consumes: - application/json -produces: +produces: - application/json paths: @@ -226,7 +226,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about zero or more VNF instances was queried @@ -314,7 +314,7 @@ paths: Information about an individual VNF instance was queried successfully. responses: 200: - description: > + description: > 200 OK Information about zero or more VNF instances was queried @@ -442,13 +442,13 @@ paths: attribute should convey more information about the error. $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" 412: -# description: > -# 412 PRECONDITION FAILED -# -# Error: A precondition given in an HTTP request header is not fulfilled. -# Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. -# The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey -# more information about the error. + # description: > + # 412 PRECONDITION FAILED + # + # Error: A precondition given in an HTTP request header is not fulfilled. + # Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. + # The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey + # more information about the error. $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" 416: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" @@ -468,7 +468,7 @@ paths: This method deletes an individual VNF instance resource. responses: 204: - description: > + description: > 204 NO CONTENT The VNF instance resource and the associated VNF identifier were @@ -551,7 +551,7 @@ paths: in: header required: false type: string - post: + post: #SOL003 location: 5.4.4.3.1 description: > The POST method instantiates a VNF instance. @@ -564,7 +564,7 @@ paths: $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" responses: 202: - description: > + description: > 202 ACCEPTED The request was accepted for processing, but the processing has not been completed. @@ -663,7 +663,7 @@ paths: in: header required: false type: string - post: + post: #SOL003 location: 5.4.5.3.1 description: > The POST method requests to scale a VNF instance resource @@ -777,7 +777,7 @@ paths: in: header required: false type: string - post: + post: #SOL003 location: 5.4.6.3.1 description: > The POST method requests to scale a VNF instance resource to a target @@ -892,7 +892,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method changes the deployment flavour of a VNF instance. parameters: @@ -1004,7 +1004,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method terminates a VNF instance. parameters: @@ -1116,7 +1116,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method requests to heal a VNF instance resource. parameters: @@ -1228,7 +1228,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method changes the operational state of a VNF instance resource. parameters: @@ -1341,12 +1341,12 @@ paths: in: header required: false type: string - post: + post: description: > The POST method changes the external connectivity of a VNF instance. parameters: - name: ChangeExtVnfConnectivityRequest - description: > + description: > Parameters for the Change external VNF connectivity operation. in: body required: true @@ -1443,7 +1443,7 @@ paths: in: header required: false type: string - get: + get: description: > The client can use this method to query status information about multiple VNF lifecycle management operation occurrences. @@ -1619,7 +1619,7 @@ paths: in: header required: false type: string - get: + get: description: > The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an individual @@ -1710,7 +1710,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related @@ -1803,7 +1803,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related @@ -1896,14 +1896,14 @@ paths: in: header required: false type: string - post: + post: description: > The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation occurrence is in "FAILED_TEMP" state. responses: 200: - description: > + description: > 200 OK The state of the VNF lifecycle management operation occurrence was @@ -1997,7 +1997,7 @@ paths: in: header required: false type: string - post: + post: description: > The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled back, i.e. the related @@ -2080,12 +2080,12 @@ paths: in: header required: false type: string - post: + post: description: > The POST method creates a new subscription. parameters: - name: LccnSubscriptionRequest - description: > + description: > Details of the subscription to be created. in: body required: true @@ -2093,7 +2093,7 @@ paths: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest" responses: 201: - description: > + description: > 201 CREATED The subscription was created successfully. The response body shall @@ -2159,7 +2159,7 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" 504: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - get: + get: description: > The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for @@ -2199,7 +2199,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The list of subscriptions was queried successfully. @@ -2287,7 +2287,7 @@ paths: an individual subscription resource. responses: 200: - description: > + description: > 200 OK The operation has completed successfully. @@ -2343,7 +2343,7 @@ paths: The DELETE method terminates an individual subscription. responses: 204: - description: > + description: > 204 NO CONTENT The subscription resource was deleted successfully. diff --git a/src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml b/src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml index 1a25ac26..83211e8a 100644 --- a/src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml +++ b/src/SOL002/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml @@ -44,7 +44,7 @@ definitions: (for new and modified resources) or has been (for removed resources) available from the VIM. $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" - + AffectedVnfc: description: > This type provides information about added, deleted, modified and @@ -99,14 +99,14 @@ definitions: This type represents a parameter to select the mode of cancelling an ongoing VNF LCM operation occurrence. type: object - required: + required: - cancelMode properties: cancelMode: description: > Cancellation mode to apply. $ref: "#/definitions/CancelModeType" - + CancelModeType: description: > Cancellation mode. @@ -371,7 +371,7 @@ definitions: $ref: "#/definitions/VirtualStorageResourceInfo" vnfcInfo: description: "TBD" - type: string + type: string metadata: description: > Additional VNF-specific metadata describing the VNF instance. @@ -457,10 +457,10 @@ definitions: This type represents the links to resources that a notification can contain. type: object - required: + required: - vnfInstance - subscription - properties: + properties: vnfInstance: description: > Link to the resource representing the VNF instance to which the @@ -522,7 +522,7 @@ definitions: required: - callbackUri properties: - filter: + filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular @@ -574,12 +574,12 @@ definitions: description: > Assigned MAC address. type: string - #TODO: Can we describe the syntax of this (Table 4.4.2.2-1)? + #TODO: Can we describe the syntax of this (Table 4.4.2.2-1)? ipAddress: description: > IP address. Present if an IP address was assigned. type: string - #TODO: Can we describe the syntax of this (Table 4.4.2.2-1)? + #TODO: Can we describe the syntax of this (Table 4.4.2.2-1)? subnetIpRanges: description: > IP address ranges defining the subnet in which the IP address was @@ -661,7 +661,7 @@ definitions: * SCALE_IN: removing VNFC instances from the VNF in order to release unused capacity. type: string - enum: + enum: - SCALE_OUT - SCALE_IN aspectId: @@ -681,7 +681,7 @@ definitions: process, specific to the VNF being scaled, as declared in the VNFD as part of "ScaleVnfOpConfig". $ref: "#/definitions/KeyValuePairs" - + ScaleVnfToLevelRequest: description: > This type represents request parameters for the "Scale VNF to Level" @@ -689,7 +689,7 @@ definitions: type: object properties: instantiationLevelId: - description: > + description: > Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute @@ -718,7 +718,7 @@ definitions: type: string enum: - FORCEFUL - + TerminateVnfRequest: type: object required: @@ -772,15 +772,15 @@ definitions: Metadata about this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - + VnfExtCpData: # Ref TBD description: > This type represents an external CP. type: object - required: + required: - cpdId - properties: + properties: cpdId: description: > The identifier of the CPD in the VNFD. @@ -807,7 +807,7 @@ definitions: informs the receiver of the deletion of a new VNF instance resource and the associated VNF instance identifier. type: object - required: + required: - id - notificationType - timeStamp @@ -926,9 +926,9 @@ definitions: They should not be used both in the same filter instance, but one alternative should be chosen. type: array - items: + items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - + vnfInstanceNames: description: > If present, match VNF instances with a VNF Instance Name listed in @@ -938,9 +938,9 @@ definitions: They should not be used both in the same filter instance, but one alternative should be chosen. type: array - items: + items: type: string - + VnfLcmOpOcc: description: > This type represents a VNF lifecycle management operation occurrence. diff --git a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index d04a1f84..e33b99b3 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -72,7 +72,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -107,9 +107,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint VnfIdentifierCreationNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfIdentifierCreationNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification': post: description: > @@ -148,7 +148,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -183,15 +183,15 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint VnfIdentifierDeletionNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfIdentifierDeletionNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification': post: description: > Notify - + The POST method delivers a notification from the server to the client. parameters: - name: VnfIdentifierDeletionNotification @@ -224,7 +224,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. diff --git a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml b/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml index c056eb58..8b148c66 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml @@ -78,7 +78,7 @@ definitions: * RESULT: Informs about the final or intermediate result of the VNF LCM operation occurrence. type: string - enum: + enum: - START - RESULT operationState: diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 920f709d..c3d3f338 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -1,6 +1,6 @@ swagger: "2.0" -info: +info: version: "1.2.0" title: SOL002 - VNF Perfomance Management interface description: > @@ -22,14 +22,14 @@ externalDocs: basePath: /vnfpm/v1 -schemes: +schemes: - http - https -consumes: +consumes: - application/json -produces: +produces: - application/json paths: @@ -84,7 +84,7 @@ paths: type: string responses: 201: - description: > + description: > 201 CREATED The PM job was created successfully. The response body shall @@ -232,7 +232,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about zero or more PM jobs was queried successfully. @@ -336,7 +336,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about an individual PM job was queried successfully. @@ -392,7 +392,7 @@ paths: This method terminates an individual PM job. responses: 204: - description: > + description: > 204 NO CONTENT The PM job was deleted successfully. @@ -486,7 +486,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information of an individual performance report was read @@ -585,7 +585,7 @@ paths: type: string responses: 201: - description: > + description: > 201 CREATED A threshold was created successfully. The response body shall @@ -694,7 +694,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about zero or more thresholds was queried @@ -730,7 +730,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -762,7 +762,7 @@ paths: ############################################################################### '/thresholds/{thresholdId}': #SOL003 location: 6.4.6 - parameters: + parameters: - name: thresholdId description: > Identifier of the threshold. @@ -799,7 +799,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK Information about an individual threshold was queried @@ -863,7 +863,7 @@ paths: type: string responses: 204: - description: > + description: > 204 NO CONTENT The threshold was deleted successfully. @@ -953,7 +953,7 @@ paths: type: string responses: 201: - description: > + description: > 201 CREATED The subscription was created successfully. A representation of the @@ -1075,7 +1075,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The list of subscriptions was queried successfully. @@ -1111,7 +1111,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -1180,7 +1180,7 @@ paths: type: string responses: 200: - description: > + description: > 200 OK The subscription was read successfully. The response body shall @@ -1243,7 +1243,7 @@ paths: type: string responses: 204: - description: > + description: > 204 NO CONTENT The subscription resource was deleted successfully. diff --git a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index c8995a2c..41cfd395 100644 --- a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -33,9 +33,9 @@ produces: - application/json paths: -############################################################################### -# Notification endpoint PerformanceInformationAvailableNotification # -############################################################################### + ############################################################################### + # Notification endpoint PerformanceInformationAvailableNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification': post: description: > @@ -74,7 +74,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -127,7 +127,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -160,15 +160,15 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint ThresholdCrossedNotification # -############################################################################### + ############################################################################### + # Notification endpoint ThresholdCrossedNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification': post: description: > Notify - + The POST method delivers a notification regarding a performance management event from the server to the client. parameters: @@ -201,7 +201,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -254,7 +254,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml index c8cf416c..aa0d40ea 100644 --- a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml @@ -1,5 +1,5 @@ swagger: "2.0" - + info: version: "1.2.0" title: SOL003 - VNF Fault Management interface @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,11 +45,11 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# Alarms # -############################################################################### + ############################################################################### + # Alarms # + ############################################################################### '/alarms': - #SOL003 location: 7.4.2 + #SOL003 location: 7.4.2 get: description: > Get Alarm List @@ -100,7 +100,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more alarms was queried successfully. @@ -145,11 +145,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual alarm # -############################################################################### + ############################################################################### + # Individual alarm # + ############################################################################### '/alarms/{alarmId}': - #SOL003 location: 7.4.3 + #SOL003 location: 7.4.3 parameters: - name: alarmId description: > @@ -195,7 +195,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about an individual alarm was read successfully. @@ -269,7 +269,7 @@ paths: type: string responses: 200: - description: > + description: > OK The request was accepted and completed. The response body shall @@ -311,11 +311,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': - #SOL003 location: 7.4.4 + #SOL003 location: 7.4.4 post: description: > Subscribe @@ -368,7 +368,7 @@ paths: type: string responses: 201: - description: > + description: > Created The subscription was created successfully. The response body shall @@ -471,7 +471,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. The response @@ -528,11 +528,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + ############################################################################### + # Individual subscription # + ############################################################################### '/subscriptions/{subscriptionId}': - #SOL003 location: 7.4.5 + #SOL003 location: 7.4.5 parameters: - name: subscriptionId description: > @@ -581,7 +581,7 @@ paths: type: string responses: 200: - description: > + description: > OK The operation has completed successfully. @@ -629,7 +629,7 @@ paths: description: > Terminate Subscription - + This method terminates an individual subscription. parameters: - name: Authorization @@ -647,7 +647,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. diff --git a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 1c21cf0a..3bf4e0bb 100644 --- a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,9 +39,9 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint AlarmNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification': #SOL003 location: 7.4.6 post: @@ -82,7 +82,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -136,7 +136,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -170,9 +170,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint AlarmClearedNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmClearedNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification': #SOL003 location: 7.4.6 post: @@ -213,7 +213,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -267,7 +267,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -301,16 +301,16 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint AlarmListRebuiltNotification # -############################################################################### + ############################################################################### + # Notification endpoint AlarmListRebuiltNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification': #SOL003 location: 7.4.6 post: description: > Notify - + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: @@ -344,7 +344,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -398,7 +398,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VNFIndicator/VNFIndicator.yaml b/src/SOL003/VNFIndicator/VNFIndicator.yaml index 060e356a..facd756b 100644 --- a/src/SOL003/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL003/VNFIndicator/VNFIndicator.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -44,11 +44,11 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# VNF indicators # -############################################################################### + ############################################################################### + # VNF indicators # + ############################################################################### '/indicators': - #SOL003 location: 8.4.2 + #SOL003 location: 8.4.2 get: description: > Get Indicator Value @@ -97,7 +97,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more VNF indicators was queried @@ -139,7 +139,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -155,11 +155,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# VNF indicators related to a VNF instance # -############################################################################### + ############################################################################### + # VNF indicators related to a VNF instance # + ############################################################################### '/indicators/{vnfInstanceId}': - #SOL003 location: 8.4.3 + #SOL003 location: 8.4.3 parameters: - name: vnfInstanceId description: > @@ -227,7 +227,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more VNF indicators was queried @@ -269,7 +269,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -285,11 +285,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual VNF indicator # -############################################################################### + ############################################################################### + # Individual VNF indicator # + ############################################################################### '/indicators/{vnfInstanceId}/{indicatorId}': - #SOL003 location: 8.4.4 + #SOL003 location: 8.4.4 parameters: - name: indicatorId description: > @@ -346,7 +346,7 @@ paths: type: string responses: 200: - description: > + description: > OK The VNF indicator was read successfully. @@ -374,7 +374,7 @@ paths: type: string maximum: 1 minimum: 1 - schema: + schema: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -390,9 +390,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': post: description: > @@ -446,7 +446,7 @@ paths: type: string responses: 201: - description: > + description: > Created The subscription was created successfully. @@ -482,7 +482,7 @@ paths: minimum: 1 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" 303: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" @@ -557,7 +557,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. @@ -603,7 +603,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -619,11 +619,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + ############################################################################### + # Individual subscription # + ############################################################################### '/indicators/subscriptions/{subscriptionId}': - #SOL003 location: 8.4.6 + #SOL003 location: 8.4.6 parameters: - name: subscriptionId description: > @@ -671,7 +671,7 @@ paths: type: string responses: 200: - description: > + description: > OK The operation has completed successfully. @@ -699,7 +699,7 @@ paths: type: string maximum: 1 minimum: 1 - schema: + schema: $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -719,7 +719,7 @@ paths: description: > Terminate Subscription - + The DELETE method terminates an individual subscription. parameters: - name: Authorization @@ -744,7 +744,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. diff --git a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 10179344..89d50460 100644 --- a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,16 +39,16 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint VnfIndicatorValueChangeNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfIndicatorValueChangeNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification': #SOL003 location: 8.4.7 post: description: > Notify - + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: @@ -74,7 +74,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -128,7 +128,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index e9bdf478..2f73410e 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,9 +45,9 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# VNF instances # -############################################################################### + ############################################################################### + # VNF instances # + ############################################################################### '/vnf_instances': #SOL003 location: 5.4.2 post: @@ -226,7 +226,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more VNF instances was queried @@ -287,9 +287,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual VNF instance # -############################################################################### + ############################################################################### + # Individual VNF instance # + ############################################################################### '/vnf_instances/{vnfInstanceId}': #SOL003 location: 5.4.3.2 parameters: @@ -340,7 +340,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more VNF instances was queried @@ -402,7 +402,7 @@ paths: resource parameters: - name: VnfInfoModificationRequest - description: > + description: > Input parameters for VNF info modification. required: true in: body @@ -475,7 +475,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The VNF instance resource and the associated VNF identifier were @@ -516,9 +516,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Instantiate VNF task # -############################################################################### + ############################################################################### + # Instantiate VNF task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/instantiate': #SOL003 location: 5.4.4.2 parameters: @@ -532,7 +532,7 @@ paths: in: path type: string required: true - post: + post: #SOL003 location: 5.4.4.3.1 description: > Instantiate VNF @@ -575,7 +575,7 @@ paths: type: string responses: 202: - description: > + description: > Accepted The request was accepted for processing, but the processing has @@ -623,9 +623,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Scale VNF task # -############################################################################### + ############################################################################### + # Scale VNF task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/scale': #SOL003 location: 5.4.5.2 parameters: @@ -639,7 +639,7 @@ paths: in: path type: string required: true - post: + post: #SOL003 location: 5.4.5.3.1 description: > Scale VNF @@ -702,9 +702,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Scale VNF to Level task # -############################################################################### + ############################################################################### + # Scale VNF to Level task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/scale_to_level': #SOL003 location: 5.4.6.2 parameters: @@ -718,12 +718,12 @@ paths: in: path type: string required: true - post: + post: #SOL003 location: 5.4.6.3.1 description: > Scale VNF to Level - + The POST method requests to scale a VNF instance resource to a target level. parameters: @@ -781,9 +781,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Change VNF Flavour task # -############################################################################### + ############################################################################### + # Change VNF Flavour task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/change_flavour': #SOL003 location: 5.4.7.2 parameters: @@ -798,7 +798,7 @@ paths: in: path type: string required: true - post: + post: description: > Change VNF Flavour @@ -859,9 +859,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Terminate VNF task # -############################################################################### + ############################################################################### + # Terminate VNF task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/terminate': #SOL003 location: 5.4.8.2 parameters: @@ -875,7 +875,7 @@ paths: in: path type: string required: true - post: + post: description: > Terminate VNF @@ -936,9 +936,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Heal VNF task # -############################################################################### + ############################################################################### + # Heal VNF task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/heal': #SOL003 location: 5.4.9.2 parameters: @@ -952,7 +952,7 @@ paths: in: path type: string required: true - post: + post: description: > Heal VNF @@ -1013,9 +1013,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Operate VNF task # -############################################################################### + ############################################################################### + # Operate VNF task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/operate': #SOL003 location: 5.4.9.2 parameters: @@ -1029,7 +1029,7 @@ paths: in: path type: string required: true - post: + post: description: > Operate VNF @@ -1090,9 +1090,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Change external VNF connectivity task # -############################################################################### + ############################################################################### + # Change external VNF connectivity task # + ############################################################################### '/vnf_instances/{vnfInstanceId}/change_ext_conn': #SOL003 location: 5.4.9.2 parameters: @@ -1107,7 +1107,7 @@ paths: in: path type: string required: true - post: + post: description: > Change External VNF Connectivity @@ -1115,7 +1115,7 @@ paths: The POST method changes the external connectivity of a VNF instance. parameters: - name: ChangeExtVnfConnectivityRequest - description: > + description: > Parameters for the Change external VNF connectivity operation. in: body required: true @@ -1169,12 +1169,12 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# VNF LCM operation occurrences # -############################################################################### + ############################################################################### + # VNF LCM operation occurrences # + ############################################################################### '/vnf_lcm_op_occs': #SOL003 location: 5.4.12 - get: + get: description: > Get Operation Status @@ -1316,9 +1316,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual VNF LCM operation occurrence # -############################################################################### + ############################################################################### + # Individual VNF LCM operation occurrence # + ############################################################################### '/vnf_lcm_op_occs/{vnfLcmOpOccId}': #SOL003 location: 5.4.13 parameters: @@ -1333,7 +1333,7 @@ paths: in: path required: true type: string - get: + get: description: > Get Operation Status @@ -1411,9 +1411,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Retry operation task # -############################################################################### + ############################################################################### + # Retry operation task # + ############################################################################### '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry': #SOL003 location: 5.4.14 parameters: @@ -1428,7 +1428,7 @@ paths: in: path required: true type: string - post: + post: description: > The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related @@ -1486,9 +1486,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Rollback operation task # -############################################################################### + ############################################################################### + # Rollback operation task # + ############################################################################### '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback': #SOL003 location: 5.4.15 parameters: @@ -1503,7 +1503,7 @@ paths: in: path required: true type: string - post: + post: description: > The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related @@ -1561,9 +1561,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Fail operation task # -############################################################################### + ############################################################################### + # Fail operation task # + ############################################################################### '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail': #SOL003 location: 5.4.16 parameters: @@ -1578,7 +1578,7 @@ paths: in: path required: true type: string - post: + post: description: > The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation occurrence is in "FAILED_TEMP" @@ -1606,7 +1606,7 @@ paths: type: string responses: 200: - description: > + description: > OK The state of the VNF lifecycle management operation occurrence was @@ -1652,9 +1652,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Cancel operation task # -############################################################################### + ############################################################################### + # Cancel operation task # + ############################################################################### '/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel': #SOL003 location: 5.4.17 parameters: @@ -1669,7 +1669,7 @@ paths: in: path required: true type: string - post: + post: description: > The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled back, i.e. the related @@ -1723,7 +1723,7 @@ paths: 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" 409: - description: > + description: > Conflict The operation cannot be executed currently, due to a conflict with @@ -1753,12 +1753,12 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': #SOL003 location: 5.4.18 - post: + post: description: > Subscribe @@ -1776,7 +1776,7 @@ paths: resource with the same filter and callbackUri). parameters: - name: LccnSubscriptionRequest - description: > + description: > Details of the subscription to be created. in: body required: true @@ -1811,7 +1811,7 @@ paths: type: string responses: 201: - description: > + description: > Created The subscription was created successfully. The response body shall @@ -1845,7 +1845,7 @@ paths: schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 303: - description: > + description: > See Other A subscription with the same callbackURI and the same filter already @@ -1889,7 +1889,7 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - get: + get: description: > Query Subscription Information @@ -1939,7 +1939,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. The response @@ -1980,7 +1980,7 @@ paths: schema: $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" 400: - description: > + description: > Bad Request Invalid attribute-based filtering parameters. @@ -2017,9 +2017,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + ############################################################################### + # Individual subscription # + ############################################################################### '/subscriptions/{subscriptionId}': #SOL003 location: 5.4.19 parameters: @@ -2063,7 +2063,7 @@ paths: type: string responses: 200: - description: > + description: > OK The operation has completed successfully. @@ -2111,7 +2111,7 @@ paths: description: > Terminate Subscription - + The DELETE method terminates an individual subscription. parameters: - name: Authorization @@ -2129,7 +2129,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. diff --git a/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml b/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml index 9fa09213..5e4c1274 100644 --- a/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml +++ b/src/SOL003/VNFLifecycleManagement/definitions/VNFLifecycleManagement_def.yaml @@ -7,14 +7,14 @@ definitions: This type represents a parameter to select the mode of cancelling an ongoing VNF LCM operation occurrence. type: object - required: + required: - cancelMode properties: cancelMode: description: > Cancellation mode to apply. $ref: "#/definitions/CancelModeType" - + CancelModeType: description: > Cancellation mode. @@ -232,7 +232,7 @@ definitions: the “changeStateTo” attribute is equal to “STOPPED” and the “stopType” attribute is absent. $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/StopType" - gracefulStopTimeout: + gracefulStopTimeout: description: > The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, before stopping the VNF. @@ -261,7 +261,7 @@ definitions: type: object properties: instantiationLevelId: - description: > + description: > Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute @@ -295,7 +295,7 @@ definitions: enum: - FORCEFUL - GRACEFUL - + TerminateVnfRequest: type: object required: diff --git a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml b/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml index c1866e3b..9b5cfdfa 100644 --- a/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml +++ b/src/SOL003/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml @@ -3,7 +3,7 @@ responses: 202-with-Location: - description: > + description: > Accepted The request was accepted for processing, but the processing has not @@ -32,7 +32,7 @@ responses: schema: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" 202-with-Location-empty: - description: > + description: > Accepted The request was accepted for processing, but the processing has not diff --git a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index 55e8d101..bef532d4 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,9 +39,9 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint VnfLcmOperationOccurrenceNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfLcmOperationOccurrenceNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification': post: description: > @@ -78,7 +78,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -113,9 +113,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint VnfIdentifierCreationNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfIdentifierCreationNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification': post: description: > @@ -154,7 +154,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -189,15 +189,15 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint VnfIdentifierDeletionNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfIdentifierDeletionNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification': post: description: > Notify - + The POST method delivers a notification from the server to the client. parameters: - name: VnfIdentifierDeletionNotification @@ -230,7 +230,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. diff --git a/src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml b/src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml index c056eb58..8b148c66 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml @@ -78,7 +78,7 @@ definitions: * RESULT: Informs about the final or intermediate result of the VNF LCM operation occurrence. type: string - enum: + enum: - START - RESULT operationState: diff --git a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml index 5fae16b4..34bf33f8 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,11 +45,11 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# Resource: Grants # -############################################################################### + ############################################################################### + # Resource: Grants # + ############################################################################### '/grants': - #SOL003 location: 9.4.2 + #SOL003 location: 9.4.2 post: description: > Grant Lifecycle Operation @@ -192,11 +192,11 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Resource: Individual grant # -############################################################################### + ############################################################################### + # Resource: Individual grant # + ############################################################################### '/grants/{grantId}': - #SOL003 location: 9.4.3 + #SOL003 location: 9.4.3 parameters: - name: grantId description: > @@ -212,7 +212,7 @@ paths: description: > Grant Lifecycle Operation - + The GET method retrieves information about a specific grant by reading an individual grant resource. parameters: diff --git a/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml b/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml index d59e8571..e7a33626 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml @@ -1,6 +1,6 @@ definitions: ConstraintResourceRef: - description: > + description: > This type references a resource either by its VIM-level identifier for existing resources, or by the identifier of a "ResourceDefinition" structure in the "GrantRequest" structure for new resources. @@ -10,7 +10,7 @@ definitions: - resourceId properties: idType: - description: > + description: > The type of the identifier. Permitted values: * RES_MGMT: Resource-management-level identifier; this identifier is @@ -19,17 +19,17 @@ definitions: * GRANT: Reference to the identifier of a "ResourceDefinition" structure in the "GrantRequest" structure. type: string - enum: + enum: - RES_MGMT - GRANT resourceId: - description: > + description: > An actual resource-management-level identifier (idType=RES_MGMT), or an identifier that references a "ResourceDefinition" structure in the related "GrantRequest" structure (idType=GRANT). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" vimConnectionId: - description: > + description: > Identifier of the VIM connection for managing the resource. It shall only be present when idType = RES_MGMT. The applicable "VimConnectionInfo" structure, which is referenced by @@ -39,7 +39,7 @@ definitions: management in direct mode is applicable. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" resourceProviderId: - description: > + description: > Identifier of the resource provider. It shall only be present when idType = RES_MGMT. This attribute shall only be supported when VNF-related resource @@ -48,30 +48,30 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" Grant: - description: > + description: > This type represents a grant. type: object - required: + required: - id - vnfInstanceId - vnfLcmOpOccId - _links - properties: + properties: id: - description: > + description: > Identifier of the grant. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfInstanceId: - description: > + description: > Identifier of the related VNF instance. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfLcmOpOccId: - description: > + description: > Identifier of the related VNF lifecycle management operation occurrence. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vimConnections: - description: > + description: > Provides information regarding VIM connections that are approved to be used by the VNFM to allocate resources, and provides parameters of these VIM connections. @@ -98,7 +98,7 @@ definitions: Identifies resource zones where the resources are approved to be allocated by the VNFM. type: array - items: + items: $ref: "#/definitions/ZoneInfo" zoneGroups: description: > @@ -109,7 +109,7 @@ definitions: constraints that were passed as part of "placementConstraints" in the GrantRequest. type: array - items: + items: $ref: "#/definitions/ZoneGroupInfo" computeReservationId: description: > @@ -184,14 +184,14 @@ definitions: Mappings between virtual compute descriptors defined in the VNFD and compute resource flavours managed in the VIM. type: array - items: + items: $ref: "#/definitions/VimComputeResourceFlavour" softwareImages: description: > Mappings between software images defined in the VNFD and software images managed in the VIM. type: array - items: + items: $ref: "#/definitions/VimSoftwareImage" extVirtualLinks: description: > @@ -204,7 +204,7 @@ definitions: lifecycle management request, if the lifecycle management request has originated from the NFVO itself. type: array - items: + items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > @@ -236,11 +236,11 @@ definitions: description: > Links to resources related to this resource. type: object - required: + required: - self - vnfLcmOpOcc - vnfInstance - properties: + properties: self: description: > URI of this resource. @@ -255,10 +255,10 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" GrantRequest: - description: > + description: > This type represents a grant request. type: object - required: + required: - vnfInstanceId - vnfLcmOpOccId - vnfdId @@ -406,27 +406,27 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" GrantInfo: - description: > + description: > This type contains information about a Compute, storage or network resource whose addition/update/deletion was granted. type: object - required: + required: - resourceDefinitionId - properties: + properties: resourceDefinitionId: - description: > + description: > Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure. $ref: "#/definitions/IdentifierLocal" reservationId: - description: > + description: > The reservation identifier applicable to the VNFC/VirtualLink/VirtualStorage. It shall be present for new resources when policy is GRANT_RESERVE_MULTI and an applicable reservation exists; shall not be present otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vimConnectionId: - description: > + description: > Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. @@ -437,7 +437,7 @@ definitions: Management in direct mode is applicable. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" resourceProviderId: - description: > + description: > Identifies the entity responsible for the management of the virtualised resource. Shall be present for new resources, and shall be absent for resources that have already been allocated. @@ -446,7 +446,7 @@ definitions: is outside the scope of the present document. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" zoneId: - description: > + description: > Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the @@ -454,7 +454,7 @@ definitions: and shall be absent for resources that have already been allocated. $ref: "#/definitions/IdentifierLocal" resourceGroupId: - description: > + description: > Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource. @@ -535,7 +535,7 @@ definitions: This type provides information of an existing or proposed resource used by the VNF. type: object - required: + required: - id - type properties: @@ -589,10 +589,10 @@ definitions: the VNFD and the corresponding compute resource flavour managed by the NFVO in the VIM. type: object - required: + required: - vnfdVirtualComputeDescId - vimFlavourId - properties: + properties: vimConnectionId: description: > Identifier of the VIM connection to access the flavour referenced in @@ -628,10 +628,10 @@ definitions: VNFD and the corresponding software image managed by the NFVO in the VIM which is needed during compute resource instantiation. type: object - required: + required: - vnfdSoftwareImageId - vimSoftwareImageId - properties: + properties: vimConnectionId: description: > Identifier of the VIM connection to access the software image @@ -687,7 +687,7 @@ definitions: connection. type: array minItems: 2 - items: + items: $ref: "#/definitions/ConstraintResourceRef" ZoneGroupInfo: @@ -701,7 +701,7 @@ definitions: resource zone into another, in case a particular deployment supports only non-elastic resource zones. type: object - required: + required: - zoneId properties: zoneId: @@ -710,14 +710,14 @@ definitions: provides information about a resource zone that belongs to this group. type: array - items: + items: $ref: "#/definitions/IdentifierLocal" ZoneInfo: description: > This type provides information regarding a resource zone. type: object - required: + required: - id - zoneId properties: diff --git a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml index bf9ba84b..b7b94a14 100644 --- a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,9 +45,9 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# VNF packages # -############################################################################### + ############################################################################### + # VNF packages # + ############################################################################### '/vnf_packages': #SOL003 location: 10.4.2 get: @@ -133,7 +133,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more VNF packages was queried successfully. @@ -191,9 +191,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual VNF package # -############################################################################### + ############################################################################### + # Individual VNF package # + ############################################################################### '/vnf_packages/{vnfPkgId}': parameters: - name: vnfPkgId @@ -235,7 +235,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information of the selected VNF packages. @@ -279,9 +279,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# VNFD in an individual VNF package # -############################################################################### + ############################################################################### + # VNFD in an individual VNF package # + ############################################################################### '/vnf_packages/{vnfPkgId}/vnfd': parameters: - name: vnfPkgId @@ -350,7 +350,7 @@ paths: type: string responses: 200: - description: > + description: > OK On success, the content of the VNFD is returned. @@ -403,9 +403,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# VNF package content # -############################################################################### + ############################################################################### + # VNF package content # + ############################################################################### '/vnf_packages/{vnfPkgId}/package_content': parameters: - name: vnfPkgId @@ -459,7 +459,7 @@ paths: type: string responses: 200: - description: > + description: > OK On success, a copy of the VNF package file is returned. @@ -488,7 +488,7 @@ paths: maximum: 1 minimum: 1 206: - description: > + description: > Partial Content On success, if the NFVO supports range requests, a single @@ -544,9 +544,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual VNF package artifact # -############################################################################### + ############################################################################### + # Individual VNF package artifact # + ############################################################################### '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}': parameters: - name: artifactPath @@ -609,7 +609,7 @@ paths: type: string responses: 200: - description: > + description: > OK On success, the content of the artifact is returned. @@ -645,7 +645,7 @@ paths: maximum: 1 minimum: 1 206: - description: > + description: > Partial Content On success, if the NFVO supports range requests, a single @@ -701,9 +701,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': post: description: > @@ -760,7 +760,7 @@ paths: type: string responses: 201: - description: > + description: > Created Representation of the created subscription resource. @@ -864,7 +864,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. @@ -923,9 +923,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + ############################################################################### + # Individual subscription # + ############################################################################### '/subscriptions/{subscriptionId}': #SOL003 location: 10.4.8 parameters: @@ -968,7 +968,7 @@ paths: type: string responses: 200: - description: > + description: > OK Representation of the subscription resource. @@ -1016,7 +1016,7 @@ paths: description: > Terminate subscription - + The DELETE method terminates an individual subscription. parameters: - name: Authorization @@ -1034,7 +1034,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. diff --git a/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml b/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml index ee6eb205..12a536c5 100644 --- a/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml +++ b/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml @@ -9,7 +9,7 @@ definitions: required: - algorithm - hash - properties: + properties: algorithm: description: > Name of the algorithm used to generate the checksum, as defined in @@ -29,7 +29,7 @@ definitions: - operationalState - usageState - _links - properties: + properties: id: description: > Identifier of the on-boarded VNF package. This identifier is @@ -97,7 +97,7 @@ definitions: onboardingState: description: > On-boarding state of the VNF package. - $ref: "#/definitions/PackageOnboardingStateType" + $ref: "#/definitions/PackageOnboardingStateType" operationalState: description: > Operational state of the VNF package. @@ -120,10 +120,10 @@ definitions: description: > Links to resources related to this resource. type: object - required: + required: - self - packageContent - properties: + properties: self: description: > URI of this resource. @@ -147,7 +147,7 @@ definitions: ONBOARDED: The associated VNF package content has been successfully on-boarded. type: string - enum: + enum: - CREATED - UPLOADING - PROCESSING @@ -182,7 +182,7 @@ definitions: in the array matches (logical "or" between the values of one filter attribute). type: object - properties: + properties: notificationTypes: description: > Match particular notification types. @@ -207,11 +207,11 @@ definitions: filter. They should not be used both in the same filter instance, but one alternative should be chosen. type: array - items: + items: type: object required: - vnfProvider - properties: + properties: vnfProvider: description: > Name of the VNF provider to match. @@ -223,7 +223,7 @@ definitions: type: array items: type: object - required: + required: - vnfProductName properties: vnfProductName: @@ -236,11 +236,11 @@ definitions: with certain versions and a certain product name, from one particular provider. type: array - items: + items: type: object - required: + required: - vnfSoftwareVersion - properties: + properties: vnfSoftwareVersion: description: > VNF software version to match. @@ -262,7 +262,7 @@ definitions: filter. They should not be used both in the same filter instance, but one alternative should be chosen. type: array - items: + items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfPkgId: description: > @@ -276,7 +276,7 @@ definitions: filter. They should not be used both in the same filter instance, but one alternative should be chosen. type: array - items: + items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" operationalState: description: > @@ -301,7 +301,7 @@ definitions: required: - vnfPackage - subscription - properties: + properties: vnfPackage: description: > Link to the resource representing the VNF package to which the @@ -318,11 +318,11 @@ definitions: This type represents a subscription related to notifications about VNF package management. type: object - required: + required: - id - callbackUri - _links - properties: + properties: id: description: > Identifier of this subscription resource. @@ -342,8 +342,8 @@ definitions: description: > Links to resources related to this resource. type: object - required: - - self + required: + - self properties: self: description: > @@ -355,9 +355,9 @@ definitions: This type represents a subscription request related to VNF package management notifications about VNF package on-boarding or changes. type: object - required: + required: - callbackUri - properties: + properties: filter: description: > Filter settings for this subscription, to define the subset of all @@ -385,7 +385,7 @@ definitions: required: - artifactPath - checksum - properties: + properties: artifactPath: description: > Path in the VNF package, which identifies the artifact and also @@ -419,7 +419,7 @@ definitions: - minRam - size - imagePath - properties: + properties: id: description: > Identifier of the software image. @@ -483,9 +483,9 @@ definitions: The list of permitted values was adapted from "Disk formats" in http://docs.openstack.org/image-guide/image-formats.html type: string - enum: + enum: - AKI - - AMI + - AMI - ISO - QCOW2 - RAW @@ -493,7 +493,7 @@ definitions: - VHD - VHDX - VMDK - createdAt: + createdAt: description: > Time when this software image was created. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" diff --git a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index d22516d6..6c5cb4ab 100644 --- a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,9 +39,9 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint VnfPackageOnboardingNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfPackageOnboardingNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification': #SOL003 location: 10.4.9 post: @@ -79,7 +79,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -132,7 +132,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -166,16 +166,16 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint VnfPackageChangeNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfPackageChangeNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification': #SOL003 location: 10.4.9 post: description: > Notify - + The POST method delivers a notification from the server to the client. parameters: - name: VnfPackageChangeNotification @@ -207,7 +207,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -260,7 +260,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml b/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml index e21dd8e1..b0e98acb 100644 --- a/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml +++ b/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml @@ -7,7 +7,7 @@ definitions: - OP_STATE_CHANGE: The "operationalState" attribute has been changed. - PKG_DELETE: The VNF package has been deleted. type: string - enum: + enum: - OP_STATE_CHANGE - PKG_DELETE @@ -38,7 +38,7 @@ definitions: (i.e. the package has been onboarded previously). * The on-boarded VNF package has been deleted. type: object - required: + required: - id - notificationType - subscriptionId @@ -47,7 +47,7 @@ definitions: - vnfdId - changeType - _links - properties: + properties: id: description: > Identifier of this notification. If a notification is sent multiple @@ -104,7 +104,7 @@ definitions: "onboardingState" attribute of a new VNF package has changed to "ONBOARDED". type: object - required: + required: - id - notificationType - subscriptionId @@ -112,7 +112,7 @@ definitions: - vnfPkgId - vnfdId - _links - properties: + properties: id: description: > Identifier of this notification. If a notification is sent multiple @@ -157,7 +157,7 @@ definitions: This type represents the links to resources that a VNF package management notification can contain. type: object - required: + required: - vnfPackage - subscription properties: diff --git a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml index b5ab401d..087c1b32 100644 --- a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,9 +45,9 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# PM jobs # -############################################################################### + ############################################################################### + # PM jobs # + ############################################################################### '/pm_jobs': #SOL003 location: 6.4.2 post: @@ -92,7 +92,7 @@ paths: type: string responses: 201: - description: > + description: > Created The PM job was created successfully. The response body shall @@ -214,7 +214,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more PM jobs was queried successfully. @@ -270,9 +270,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual PM job # -############################################################################### + ############################################################################### + # Individual PM job # + ############################################################################### '/pm_jobs/{pmJobId}': #SOL003 location: 6.4.3 parameters: @@ -315,7 +315,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about an individual PM job was queried successfully. @@ -381,7 +381,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The PM job was deleted successfully. @@ -415,9 +415,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual performance report # -############################################################################### + ############################################################################### + # Individual performance report # + ############################################################################### '/pm_jobs/{pmJobId}/reports/{reportId}': #SOL003 location: 6.4.4 parameters: @@ -460,7 +460,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information of an individual performance report was read @@ -505,9 +505,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Thresholds # -############################################################################### + ############################################################################### + # Thresholds # + ############################################################################### '/thresholds': #SOL003 location: 6.4.5 post: @@ -553,7 +553,7 @@ paths: type: string responses: 201: - description: > + description: > Created A threshold was created successfully. The response body shall @@ -631,7 +631,7 @@ paths: All attribute names that appear in the Thresholds and in data types referenced from it shall be supported by the VNFM in the filter expression. - + NOTE: There are no attribute selectors defined for this resource as the threshold attributes with cardinality 0..1 or 0..N are not structurally complex in nature. @@ -654,7 +654,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about zero or more thresholds was queried @@ -699,7 +699,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -715,12 +715,12 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual threshold # -############################################################################### + ############################################################################### + # Individual threshold # + ############################################################################### '/thresholds/{thresholdId}': #SOL003 location: 6.4.6 - parameters: + parameters: - name: thresholdId description: > Identifier of the threshold. @@ -760,7 +760,7 @@ paths: type: string responses: 200: - description: > + description: > OK Information about an individual threshold was queried @@ -826,7 +826,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The threshold was deleted successfully. @@ -860,9 +860,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': #SOL003 location: 6.4.7 post: @@ -918,7 +918,7 @@ paths: type: string responses: 201: - description: > + description: > Created The subscription was created successfully. A representation of the @@ -1020,7 +1020,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. @@ -1062,7 +1062,7 @@ paths: minimum: 0 schema: type: array - items: + items: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" @@ -1078,9 +1078,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + ############################################################################### + # Individual subscription # + ############################################################################### '/subscriptions/{subscriptionId}': #SOL003 location: 6.4.8 parameters: @@ -1123,7 +1123,7 @@ paths: type: string responses: 200: - description: > + description: > OK The subscription was read successfully. The response body shall @@ -1170,7 +1170,7 @@ paths: description: > Terminate Subscription - + This method terminates an individual subscription. parameters: - name: Authorization @@ -1188,7 +1188,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. diff --git a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index 054c6951..a6499dd2 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,9 +39,9 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint PerformanceInformationAvailableNotification # -############################################################################### + ############################################################################### + # Notification endpoint PerformanceInformationAvailableNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification': #SOL003 location: 6.4.9 post: @@ -81,7 +81,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -134,7 +134,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. @@ -167,16 +167,16 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Notification endpoint ThresholdCrossedNotification # -############################################################################### + ############################################################################### + # Notification endpoint ThresholdCrossedNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification': #SOL003 location: 6.4.9 post: description: > Notify - + The POST method delivers a notification regarding a performance management event from the server to the client. parameters: @@ -209,7 +209,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -262,7 +262,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml index 89e3f861..9c05a3a4 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -45,9 +45,9 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# Subscriptions # -############################################################################### + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': post: description: > @@ -102,7 +102,7 @@ paths: type: string responses: 201: - description: > + description: > Created Representation of the created subscription resource. @@ -156,7 +156,7 @@ paths: description: > Query Subscription Information - + The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during subscription. parameters: @@ -194,7 +194,7 @@ paths: type: string responses: 200: - description: > + description: > OK The list of subscriptions was queried successfully. @@ -236,7 +236,7 @@ paths: items: $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" 204: - description: > + description: > No Content The notification endpoint was tested successfully. diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml index ebee41f8..86ee0681 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml @@ -12,7 +12,7 @@ definitions: an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). type: object - properties: + properties: vimIds: description: > Match VIMs that were created the quota for a consumer of the @@ -92,7 +92,7 @@ definitions: This type represents a subscription request related to notifications related to the availability of the virtualised resources quotas. type: object - required: + required: - callbackUri properties: filter: diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml index 498ad698..8f6a377a 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml @@ -11,7 +11,7 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - + In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based filtering mechanism is defined. This mechanism is currently not included in the corresponding OpenAPI design for this GS version. Changes @@ -39,15 +39,15 @@ produces: - "application/json" paths: -############################################################################### -# Notification endpoint VnfLcmOperationOccurrenceNotification # -############################################################################### + ############################################################################### + # Notification endpoint VnfLcmOperationOccurrenceNotification # + ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription': post: description: > Notify - + The POST method delivers a notification from the server to the client. parameters: - name: VrQuotaAvailNotification @@ -79,7 +79,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. @@ -119,7 +119,7 @@ paths: type: string responses: 204: - description: > + description: > No Content The notification was delivered successfully. diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/definitions/VirtualisedResourcesQuotaAvailableNotificationNotification_def.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/definitions/VirtualisedResourcesQuotaAvailableNotificationNotification_def.yaml index 2690dc3e..0187577b 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/definitions/VirtualisedResourcesQuotaAvailableNotificationNotification_def.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/definitions/VirtualisedResourcesQuotaAvailableNotificationNotification_def.yaml @@ -12,14 +12,14 @@ definitions: The notification shall be triggered by the NFVO when a virtualised resource quota applicable to the consumer has been set. type: object - required: + required: - id - notificationType - subscriptionId - timeStamp - resourceGroupId - _links - properties: + properties: id: description: > Identifier of this notification. If a notification is sent multiple @@ -31,9 +31,9 @@ definitions: Discriminator for the different notification types. Shall be set to "VrQuotaAvailNotification" for this notification type. type: string - enum: + enum: - VrQuotaAvailNotification - subscriptionId: + subscriptionId: description: > Identifier of the subscription that this notification relates to. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" @@ -66,15 +66,15 @@ definitions: description: > Links to resources related to this notification. $ref: "#/definitions/QuotaAvailLinks" - + QuotaAvailLinks: description: > This type represents the links to resources that a notification of type "VrQuotaAvailNotification" can contain. type: object - required: + required: - subscription - properties: + properties: subscription: description: > Link to the related subscription. diff --git a/src/SOL003/definitions/SOL003_def.yaml b/src/SOL003/definitions/SOL003_def.yaml index 6624995f..099b2f9a 100644 --- a/src/SOL003/definitions/SOL003_def.yaml +++ b/src/SOL003/definitions/SOL003_def.yaml @@ -19,7 +19,7 @@ definitions: - isRootCause - _links properties: - id: + id: description: > Identifier of this Alarm information element. $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" @@ -53,14 +53,14 @@ definitions: * UNACKNOWLEDGED * ACKNOWLEDGED. type: string - enum: + enum: - UNACKNOWLEDGED - ACKNOWLEDGED perceivedSeverity: description: > Perceived severity of the managed object failure. $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" - eventTime: + eventTime: description: > Time stamp indicating when the fault was observed. $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" @@ -86,7 +86,7 @@ definitions: description: > List of identifiers of other alarms correlated to this fault. type: array - items: + items: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" faultDetails: description: > @@ -120,7 +120,7 @@ definitions: * An alarm has been updated, e.g. if the severity of the alarm has changed. type: object - required: + required: - id - notificationType - subscriptionId @@ -139,7 +139,7 @@ definitions: Discriminator for the different notification types. Shall be set to "AlarmNotification" for this notification type. type: string - enum: + enum: - AlarmNotification subscriptionId: description: > @@ -158,14 +158,14 @@ definitions: description: > Links to resources related to this notification. type: object - required: + required: - subscription - properties: - subscription: + properties: + subscription: description: > Link to the related subscription. $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" - + VnfInfoModificationRequest: description: > This type represents attribute modifications for an @@ -211,7 +211,7 @@ definitions: New content of certain entries in the "vimConnectionInfo" attribute array in "VnfInstance", as defined below this table. type: array - items: + items: $ref: "../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" vimConnectionInfoDeleteIds: description: > diff --git a/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml b/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml index 4ff2e571..cbb32454 100644 --- a/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml @@ -2,6 +2,70 @@ # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: + FmSubscriptionRequest: + description: > + This type represents a subscription request related to notifications + about VNF faults. + type: object + required: + - callbackUri + properties: + filter: + description: > + Filter settings for this subscription, to define the subset of all + notifications this subscription relates to. A particular + notification is sent to the subscriber if the filter matches, or if + there is no filter. + $ref: "#/definitions/FmNotificationsFilter" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "SOL002SOL003_def.yaml#/definitions/Uri" + authentication: + description: > + Authentication parameters to configure the use of Authorization when + sending notifications corresponding to this subscription. + This attribute shall only be present if the subscriber requires + authorization of notifications. + $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" + + FmSubscription: + description: > + This type represents a subscription related to notifications about VNF + faults. + type: object + required: + - id + - callbackUri + - _links + properties: + id: + description: > + Identifier of this subscription resource. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + filter: + description: > + Filter settings for this subscription, to define the subset of all + notifications this subscription relates to. A particular + notification is sent to the subscriber if the filter matches, or if + there is no filter. + $ref: "#/definitions/FmNotificationsFilter" + callbackUri: + description: > + The URI of the endpoint to send the notification to. + $ref: "SOL002SOL003_def.yaml#/definitions/Uri" + _links: + description: > + Links for this resource. + type: object + required: + - self + properties: + self: + description: > + URI of this resource. + $ref: "SOL002SOL003_def.yaml#/definitions/Link" + Alarm: description: > The alarm data type encapsulates information about an alarm. @@ -172,7 +236,7 @@ definitions: The notification shall be triggered by the VNFM when an alarm has been cleared. type: object - required: + required: - id - notificationType - subscriptionId @@ -192,7 +256,7 @@ definitions: Discriminator for the different notification types. Shall be set to "AlarmClearedNotification" for this notification type. type: string - enum: + enum: - AlarmClearedNotification subscriptionId: description: > @@ -213,11 +277,11 @@ definitions: description: > Links to resources related to this notification. type: object - required: + required: - subscription - alarm - properties: - subscription: + properties: + subscription: description: > Link to the related subscription. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" @@ -234,7 +298,7 @@ definitions: The notification shall be triggered by the VNFM when the alarm list has been rebuilt. type: object - required: + required: - id - notificationType - subscriptionId @@ -252,7 +316,7 @@ definitions: Discriminator for the different notification types. Shall be set to "AlarmListRebuiltNotification" for this notification type. type: string - enum: + enum: - AlarmListRebuiltNotification subscriptionId: description: > @@ -266,11 +330,11 @@ definitions: description: > Links to resources related to this notification. type: object - required: + required: - subscription - alarms - properties: - subscription: + properties: + subscription: description: > Link to the related subscription. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" @@ -288,7 +352,7 @@ definitions: type: object required: - ackState - properties: + properties: ackState: description: > New value of the "ackState" attribute in "Alarm". @@ -315,7 +379,7 @@ definitions: * EQUIPMENT_ALARM: An alarm of this type is associated with an equipment fault (ITU-T Recommendation X.733). type: string - enum: + enum: - COMMUNICATIONS_ALARM - PROCESSING_ERROR_ALARM - ENVIRONMENTAL_ALARM @@ -327,10 +391,10 @@ definitions: This type represents the faulty virtual resources that have a negative impact on a VNF. type: object - required: + required: - faultyResource - faultyResourceType - properties: + properties: faultyResource: description: > Information that identifies the faulty resource instance and its @@ -346,7 +410,7 @@ definitions: The enumeration FaultyResourceType represents those types of faulty resource. type: string - enum: + enum: - COMPUTE - STORAGE - NETWORK @@ -388,92 +452,26 @@ definitions: Match VNF alarms with a faulty resource type listed in this attribute. type: array - items: + items: $ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceType" perceivedSeverities: description: > Match VNF alarms with a perceived severity listed in this attribute. type: array - items: + items: $ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" eventTypes: description: > Match VNF alarms with an event type listed in this attribute. type: array - items: + items: $ref: "SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" probableCauses: description: > Match VNF alarms with a probable cause listed in this attribute. type: array - items: - type: string - - FmSubscription: - description: > - This type represents a subscription related to notifications about VNF - faults. - type: object - required: - - id - - callbackUri - - _links - properties: - id: - description: > - Identifier of this subscription resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - filter: - description: > - Filter settings for this subscription, to define the subset of all - notifications this subscription relates to. A particular - notification is sent to the subscriber if the filter matches, or if - there is no filter. - $ref: "#/definitions/FmNotificationsFilter" - callbackUri: - description: > - The URI of the endpoint to send the notification to. - type: string - format: url - _links: - description: > - Links for this resource. - type: object - required: - - self - properties: - self: - description: > - URI of this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - - FmSubscriptionRequest: - description: > - This type represents a subscription request related to notifications - about VNF faults. - type: object - required: - - callbackUri - properties: - filter: - description: > - Filter settings for this subscription, to define the subset of all - notifications this subscription relates to. A particular - notification is sent to the subscriber if the filter matches, or if - there is no filter. - $ref: "#/definitions/FmNotificationsFilter" - callbackUri: - description: > - The URI of the endpoint to send the notification to. - type: string - format: url - authentication: - description: > - Authentication parameters to configure the use of Authorization when - sending notifications corresponding to this subscription. - This attribute shall only be present if the subscriber requires - authorization of notifications. - $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" + items: + type: string PerceivedSeverityType: description: > @@ -507,7 +505,7 @@ definitions: managed object that have the same Alarm type, Probable cause and Specific problems (if given) (ITU-T Recommendation X.733). type: string - enum: + enum: - CRITICAL - MAJOR - MINOR diff --git a/src/definitions/SOL002SOL003VNFIndicator_def.yaml b/src/definitions/SOL002SOL003VNFIndicator_def.yaml index 1eaff102..e7e64956 100644 --- a/src/definitions/SOL002SOL003VNFIndicator_def.yaml +++ b/src/definitions/SOL002SOL003VNFIndicator_def.yaml @@ -3,15 +3,15 @@ definitions: VnfIndicator: - description: > + description: > This type represents a VNF indicator value. type: object - required: + required: - id - value - vnfInstanceId - _links - properties: + properties: id: description: > Identifier of this VNF indicator. @@ -21,7 +21,7 @@ definitions: Human readable name of the indicator. Shall be present if defined in the VNFD. type: string - value: + value: description: > Provides the value of the indicator. The value format is defined in the VNFD. @@ -36,10 +36,10 @@ definitions: description: > Links for this resource. type: object - required: + required: - self - vnfInstance - properties: + properties: self: description: > URI of this resource. @@ -59,7 +59,7 @@ definitions: an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). type: object - properties: + properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. @@ -68,7 +68,7 @@ definitions: description: > Match particular VNF indicator identifiers. type: array - items: + items: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" VnfIndicatorSubscription: @@ -76,11 +76,11 @@ definitions: This type represents a subscription related to notifications about VNF indicator value changes. type: object - required: + required: - id - callbackUri - _links - properties: + properties: id: description: > Identifier of this subscription resource. @@ -114,9 +114,9 @@ definitions: This type represents a subscription request related to VNF indicator value change notifications. type: object - required: + required: - callbackUri - properties: + properties: filter: description: > Filter settings for this subscription, to define the subset of all @@ -143,7 +143,7 @@ definitions: The notification shall be triggered by the VNFM when the value of an indicator has changed. type: object - required: + required: - id - notificationType - subscriptionId @@ -152,8 +152,8 @@ definitions: - value - vnfInstanceId - _links - properties: - id: + properties: + id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these @@ -164,7 +164,7 @@ definitions: Discriminator for the different notification types. Shall be set to "VnfIndicatorValueChangeNotification" for this notification type. type: string - enum: + enum: - VnfIndicatorValueChangeNotification subscriptionId: description: > @@ -198,7 +198,7 @@ definitions: description: > Links for this resource. type: object - required: + required: - subscription properties: vnfInstance: diff --git a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml index 2c590dd9..c12f969f 100644 --- a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml @@ -13,7 +13,7 @@ definitions: - changeType - networkResource properties: - id: + id: description: > Identifier of the virtual link instance, identifying the applicable "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. @@ -106,9 +106,9 @@ definitions: description: > This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. - required: + required: - layerProtocol - properties: + properties: layerProtocol: description: > The identifier of layer(s) and protocol(s) associated to the network @@ -119,7 +119,7 @@ definitions: backwards-compatible way. In the current version of the present document, only IP over Ethernet is supported. type: string - enum: + enum: - IP_OVER_ETHERNET ipOverEthernet: description: > @@ -231,7 +231,7 @@ definitions: This type represents information about a network address that has been assigned. type: object - properties: + properties: macAddress: description: > MAC address, if assigned. @@ -243,17 +243,17 @@ definitions: addresses assigned by fixed or dynamic IP address assignment per subnet. type: array - items: + items: type: object - required: + required: - type - properties: + properties: type: description: > The type of the IP addresses. Permitted values: IPV4, IPV6. type: string - enum: + enum: - IPV4 - IPV6 addresses: @@ -262,7 +262,7 @@ definitions: "subnetId" if provided). Exactly one of "addresses" or "addressRange" shall be present. type: array - items: + items: $ref: "SOL002SOL003_def.yaml#/definitions/IpAddress" isDynamic: description: > @@ -276,7 +276,7 @@ definitions: An IP address range used, e.g., in case of egress connections. Exactly one of "addresses" or "addressRange" shall be present. type: object - required: + required: - minAddress - maxAddress properties: @@ -301,10 +301,10 @@ definitions: This type represents the links to resources that a notification can contain. type: object - required: + required: - vnfInstance - subscription - properties: + properties: vnfInstance: description: > Link to the resource representing the VNF instance to which the @@ -366,7 +366,7 @@ definitions: required: - callbackUri properties: - filter: + filter: description: > Filter settings for this subscription, to define the subset of all notifications this subscription relates to. A particular @@ -448,7 +448,7 @@ definitions: value "VnfLcmOperationOccurrenceNotification", and shall be absent otherwise. type: array - items: + items: $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType" operationStates: description: > @@ -458,7 +458,7 @@ definitions: value "VnfLcmOperationOccurrenceNotification", and shall be absent otherwise. type: array - items: + items: $ref: "#/definitions/LcmOperationStateType" MonitoringParameter: @@ -513,7 +513,7 @@ definitions: * SCALE_IN: removing VNFC instances from the VNF in order to release unused capacity. type: string - enum: + enum: - SCALE_OUT - SCALE_IN aspectId: @@ -541,7 +541,7 @@ definitions: type: object properties: instantiationLevelId: - description: > + description: > Identifier of the target instantiation level of the current deployment flavour to which the VNF is requested to be scaled. Either the instantiationLevelId attribute or the scaleInfo attribute @@ -612,7 +612,7 @@ definitions: description: > Metadata about this resource. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - + VnfExtCpInfo: description: > This type represents information about an external CP of a VNF. @@ -767,7 +767,7 @@ definitions: This notification shall be triggered by the VNFM when it has created a VNF instance resource and the associated VNF instance identifier. type: object - required: + required: - id - notificationType - subscriptionId @@ -811,7 +811,7 @@ definitions: This notification shall be triggered by the VNFM when it has deleted a VNF instance resource and the associated VNF instance identifier. type: object - required: + required: - id - notificationType - subscriptionId @@ -948,7 +948,7 @@ definitions: attribute from the VNFD in the VNF Package identified by the "vnfPkgId” attribute. $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/Version" - + VnfInfoModificationRequest: description: > This type represents attribute modifications for an "Individual VNF instance" resource, diff --git a/src/definitions/SOL002SOL003VNFLifecycleOperationGranting_def.yaml b/src/definitions/SOL002SOL003VNFLifecycleOperationGranting_def.yaml deleted file mode 100644 index 60a53347..00000000 --- a/src/definitions/SOL002SOL003VNFLifecycleOperationGranting_def.yaml +++ /dev/null @@ -1,9 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt - -definitions: - - - - - diff --git a/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml b/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml index d2bc7e19..394cbc0d 100644 --- a/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml @@ -9,7 +9,7 @@ definitions: required: - objectInstanceId - criteria - properties: + properties: objectInstanceId: description: > Identifier of the VNF instance associated with this threshold. @@ -40,7 +40,7 @@ definitions: CrossingDirectionType: type: string - enum: + enum: - UP - DOWN @@ -53,15 +53,15 @@ definitions: The notification shall be triggered by the VNFM when new performance information collected by a PM job is available. type: object - required: + required: - id - notificationType - subscriptionId - timeStamp - objectInstanceId - _links - properties: - id: + properties: + id: description: > Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these @@ -73,7 +73,7 @@ definitions: "PerformanceInformationAvailableNotification" for this notification type. type: string - enum: + enum: - PerformanceInformationAvailableNotification subscriptionId: description: > @@ -91,7 +91,7 @@ definitions: description: > Links to resources related to this notification. type: object - required: + required: - subscription - pmJob - performanceReport @@ -117,7 +117,7 @@ definitions: type "PerformanceReport" can be obtained. This link should point to an "Individual performance report" resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" - + PerformanceReport: description: > This type defines the format of a performance report provided by the VNFM to the EM as a result @@ -259,7 +259,7 @@ definitions: performance information is collected. Shall be present if the VNF instance information is accessible as a resource. type: array - items: + items: $ref: "SOL002SOL003_def.yaml#/definitions/Link" PmJobCriteria: @@ -276,7 +276,7 @@ definitions: Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) shall be present. type: array - items: + items: type: string performanceMetricGroup: description: > @@ -287,7 +287,7 @@ definitions: At least one of the two attributes (performance metric or group) shall be present. type: array - items: + items: type: string collectionPeriod: description: > @@ -327,7 +327,7 @@ definitions: This type represents a filter that can be used to subscribe for notifications related to performance management events. type: object - properties: + properties: vnfInstanceSubscriptionFilter: description: > Filter criteria to select VNF instances about which to notify. @@ -342,7 +342,7 @@ definitions: spelled exactly as the names of the notification types to facilitate automated code generation systems. type: string - enum: + enum: - ThresholdCrossedNotification - PerformanceInformationAvailableNotification @@ -350,11 +350,11 @@ definitions: description: > This type represents a subscription. type: object - required: + required: - id - callbackUri - _links - properties: + properties: id: description: > Identifier that identifies the subscription. @@ -387,7 +387,7 @@ definitions: description: > This type represents a subscription request. type: object - required: + required: - callbackUri properties: filter: @@ -414,12 +414,12 @@ definitions: description: > This type represents a threshold. type: object - required: + required: - id - objectInstanceId - criteria - _links - properties: + properties: id: description: > Identifier of this threshold resource. @@ -436,14 +436,14 @@ definitions: description: > Links for this resource. type: object - required: + required: - self - properties: + properties: self: description: > URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" - object: + object: description: > Link to a resource representing the VNF instance for which performance information is collected. Shall be present if the @@ -453,10 +453,10 @@ definitions: description: > This type represents criteria that define a threshold. type: object - required: + required: - performanceMetric - thresholdType - properties: + properties: performanceMetric: description: > Defines the performance metric associated with the threshold. @@ -479,10 +479,10 @@ definitions: Details of a simple threshold. Shall be present if thresholdType="SIMPLE". type: object - required: + required: - thresholdValue - hysteresis - properties: + properties: thresholdValue: description: > The threshold value. Shall be represented as a floating point @@ -513,7 +513,7 @@ definitions: The notification shall be triggered by the VNFM when a threshold has been crossed. type: object - required: + required: - id - notificationType - subscriptionId @@ -524,19 +524,19 @@ definitions: - performanceMetric - performanceValue - _links - properties: - id: + 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: "SOL002SOL003_def.yaml#/definitions/Identifier" - notificationType: + notificationType: description: > Discriminator for the different notification types. Shall be set to "ThresholdCrossedNotification" for this notification type. type: string - enum: + enum: - ThresholdCrossedNotification subscriptionId: description: > @@ -583,10 +583,10 @@ definitions: description: > Links to resources related to this notification. type: object - required: + required: - subscription - threshold - properties: + properties: subscription: description: > Link to the related subscription. -- GitLab