diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index 49f3b3037ce5728faf52b074e143b11900674e9f..9da8d3bc7320587e90dff1f49e1e9298da318917 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -38,6 +38,20 @@ paths: ############################################################################### '/alarms': #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Query alarms related to NS instances. description: > @@ -78,19 +92,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -164,6 +165,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read individual alarm. description: > @@ -183,19 +197,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -263,13 +264,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The Content-Type header shall be set to @@ -280,12 +274,6 @@ paths: type: string enum: - application/merge-patch+json - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -342,6 +330,20 @@ paths: ############################################################################## '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string post: summary: Subscribe to alarms related to NSs. description: > @@ -362,13 +364,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -376,12 +371,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - name: body in: body required: true @@ -475,13 +464,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -489,12 +471,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -571,6 +547,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read an individual subscription. description: > @@ -587,13 +576,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -601,12 +583,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -659,20 +635,6 @@ paths: Terminate Subscription This method terminates an individual subscription. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 204: description: > diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index 194a3e9d80b12bf9784ad520719d470da1c5c1da..22f637a2af13f5d71cd2ffade5d1e0af0e3f419a 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -37,6 +37,20 @@ paths: ############################################################################### '/ns_instances': #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string post: summary: Create a NS instance resource. description: > @@ -49,13 +63,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -63,12 +70,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - name: body in: body required: true @@ -201,19 +202,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -290,6 +278,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read an individual NS instance resource. description: > @@ -303,13 +304,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -317,12 +311,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -381,20 +369,6 @@ paths: Delete NS Identifier This method deletes an individual NS instance resource. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 204: description: > @@ -492,7 +466,7 @@ paths: Parameters for the instantiate NS operation, as defined in clause 6.5.2.10. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -567,7 +541,7 @@ paths: Parameters for the scale NS operation, as defined in clause 6.5.2.13. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -641,7 +615,7 @@ paths: Parameters for the update NS operation, as defined in clause 6.5.2.11. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -712,12 +686,12 @@ paths: in: body required: true schema: - $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest" + $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest" description: > Parameters for the heal NS operation, as defined in clause 6.5.2.12. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -792,12 +766,12 @@ paths: in: body required: true schema: - $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest" + $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest" description: > The terminate NS request parameters, as defined in clause 6.5.2.14. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1102,7 +1076,7 @@ paths: type: string responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1163,7 +1137,7 @@ paths: type: string responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1218,7 +1192,7 @@ paths: type: string responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1394,14 +1368,14 @@ paths: in: body required: true schema: - $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode" + $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CancelMode" description: > The POST request to this resource shall include a CancelMode structure in the payload body to choose between "graceful" and "forceful" cancellation. responses: 202: - $ref: "responses/SOL005NSLifecycleManagement_resp.yaml#/responses/202-with-Location-empty" + $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1426,6 +1400,20 @@ paths: ############################################################################### '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.16 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string post: summary: Subscribe to NS lifecycle change notifications. description: > @@ -1446,13 +1434,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -1460,12 +1441,6 @@ paths: in: header required: true type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - name: body in: body required: true @@ -1557,19 +1532,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -1641,6 +1603,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read an individual subscription resource. description: > @@ -1655,19 +1630,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 200: description: > @@ -1720,20 +1682,6 @@ paths: The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string responses: 204: description: > diff --git a/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml deleted file mode 100644 index d86760afaa6edf083b9432ebf0014e3a7336fcdd..0000000000000000000000000000000000000000 --- a/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml +++ /dev/null @@ -1,191 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt -definitions: - HealNsRequest: - description: > - This operation supports the healing of an NS instance, - either by healing the complete NS instance or by healing one of - more of the VNF instances that are part of this NS. - It shall comply with the provisions defined in Table 6.5.2.13-1. - type: object - properties: - healNsData: - description: > - Indicates the reason why a healing procedure is required. - $ref: "#/definitions/HealNsData" - healVnfData: - description: > - Additional parameters passed by the NFVO as input to the healing - process, specific to the VNF being healed, as declared in the VNFD - as part of "HealVnfOpConfig". - type: array - items: - $ref: "#/definitions/HealVnfData" - - CancelMode: - description: > - This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. - It shall comply with the provisions defined in Table 6.5.2.16-1. - type: object - required: - - cancelMode - properties: - cancelMode: - description: > - Cancellation mode to apply. - $ref: "#/definitions/CancelModeType" - - CancelModeType: - description: > - The enumeration CancelModeType defines the valid modes of cancelling a NS LCM operation occurrence. - It shall comply with the provisions defined in Table 6.5.4.10-1. - type: string - enum: - - GRACEFUL - - FORCEFUL - - HealNsData: - description: > - This type represents the information used to heal a NS. - It shall comply with the provisions defined in Table 6.5.3.43-1. - type: object - required: - - degreeHealing - properties: - degreeHealing: - description: > - Indicates the degree of healing. Possible values - include: - - HEAL_RESTORE: Complete the healing of - the NS restoring the state of the NS before - the failure occurred - - HEAL_QOS: Complete the healing of the NS - based on the newest QoS values - - HEAL_RESET: Complete the healing of the - NS resetting to the original instantiation state of the NS - - PARTIAL_HEALING - type: string - enum: - - HEAL_RESTORE - - HEAL_QOS - - HEAL_RESET - - PARTIAL_HEALING - actionsHealing: - description: > - Used to specify dedicated healing actions in a - particular order (e.g. as a script). The actionsHealing - attribute can be used to provide a specific script whose - content and actions might only be possible to be - derived during runtime. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/String" - healScript: - description: > - Reference to a script from the NSD that shall be used - to execute dedicated healing actions in a particular - order. The healScript, since it refers to a script in the - NSD, can be used to execute healing actions which - are defined during NS design time. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" - additionalParamsforNs: - description: > - Allows the OSS/BSS to provide additional - parameter(s) to the healing process at the NS level. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" - - HealVnfData: - description: > - This type represents the information to heal a VNF that is part of an NS. - The NFVO shall then invoke the HealVNF - operation towards the appropriate VNFM. - It shall comply with the provisions defined in Table 6.5.3.44-1. - type: object - required: - - vnfInstanceId - properties: - vnfInstanceId: - description: > - Identifies the VNF instance, part of the NS, requiring a - healing action. - $ref: "SOL005_def.yaml#/definitions/Identifier" - cause: - description: > - Indicates the reason why a healing procedure is required. - type: string - additionalParams: - description: > - Additional parameters passed by the NFVO as input to - the healing process, specific to the VNF being healed. - EXAMPLE: Input parameters to VNF-specific healing procedures. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" - - TerminateNsRequest: - description: > - This type represents a NS termination request. - It shall comply with the provisions defined in Table 6.5.2.15-1. - type: object - properties: - terminationTime: - description: > - Timestamp indicating the end time of the NS, i.e. the NS - will be terminated automatically at this timestamp. - Cardinality "0" indicates the NS termination takes place immediately - $ref: "SOL005_def.yaml#/definitions/DateTime" - - ProblemDetails: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis structure. Compared to the - general framework defined in IETF RFC 7807 [19], the "status" and - "detail" attributes are mandated to be included by the present document, - to ensure that the response contains additional textual information about - an error. IETF RFC 7807 [19] foresees extensibility of the - "ProblemDetails" type. It is possible that particular APIs in the present - document, or particular implementations, define extensions to define - additional attributes that provide more information about the error. - The description column only provides some explanation of the meaning to - Facilitate understanding of the design. For a full description, see - IETF RFC 7807 [19]. - type: object - required: - - status - - detail - properties: - type: - description: > - A URI reference according to IETF RFC 3986 [5] that identifies the - problem type. It is encouraged that the URI provides human-readable - documentation for the problem (e.g. using HTML) when dereferenced. - When this member is not present, its value is assumed to be - "about:blank". - type: string - format: URI - title: - description: > - A short, human-readable summary of the problem type. It should not - change from occurrence to occurrence of the problem, except for - purposes of localization. If type is given and other than - "about:blank", this attribute shall also be provided. - A short, human-readable summary of the problem - type. It SHOULD NOT change from occurrence to occurrence of the - problem, except for purposes of localization (e.g., using - proactive content negotiation; see [RFC7231], Section 3.4). - type: string - status: - description: > - The HTTP status code for this occurrence of the problem. - The HTTP status code ([RFC7231], Section 6) generated by the origin - server for this occurrence of the problem. - type: integer - detail: - description: > - A human-readable explanation specific to this occurrence of the - problem. - type: string - instance: - description: > - A URI reference that identifies the specific occurrence of the - problem. It may yield further information if dereferenced. - type: string - format: URI \ No newline at end of file diff --git a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml index ae569f3b02d0780a42a590020949be33c35631cb..8fdcf8f9b6c96dc51c07c27edfa14b0834b854f8 100644 --- a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +++ b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml @@ -1,6 +1,130 @@ # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: + + HealNsRequest: + description: > + This operation supports the healing of an NS instance, + either by healing the complete NS instance or by healing one of + more of the VNF instances that are part of this NS. + It shall comply with the provisions defined in Table 6.5.2.13-1. + type: object + properties: + healNsData: + description: > + Indicates the reason why a healing procedure is required. + $ref: "#/definitions/HealNsData" + healVnfData: + description: > + Additional parameters passed by the NFVO as input to the healing + process, specific to the VNF being healed, as declared in the VNFD + as part of "HealVnfOpConfig". + type: array + items: + $ref: "#/definitions/HealVnfData" + + CancelMode: + description: > + This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. + It shall comply with the provisions defined in Table 6.5.2.16-1. + type: object + required: + - cancelMode + properties: + cancelMode: + description: > + Cancellation mode to apply. + $ref: "#/definitions/CancelModeType" + + HealNsData: + description: > + This type represents the information used to heal a NS. + It shall comply with the provisions defined in Table 6.5.3.43-1. + type: object + required: + - degreeHealing + properties: + degreeHealing: + description: > + Indicates the degree of healing. Possible values + include: + - HEAL_RESTORE: Complete the healing of + the NS restoring the state of the NS before + the failure occurred + - HEAL_QOS: Complete the healing of the NS + based on the newest QoS values + - HEAL_RESET: Complete the healing of the + NS resetting to the original instantiation state of the NS + - PARTIAL_HEALING + type: string + enum: + - HEAL_RESTORE + - HEAL_QOS + - HEAL_RESET + - PARTIAL_HEALING + actionsHealing: + description: > + Used to specify dedicated healing actions in a + particular order (e.g. as a script). The actionsHealing + attribute can be used to provide a specific script whose + content and actions might only be possible to be + derived during runtime. + type: array + items: + $ref: "../../definitions/SOL005_def.yaml#/definitions/String" + healScript: + description: > + Reference to a script from the NSD that shall be used + to execute dedicated healing actions in a particular + order. The healScript, since it refers to a script in the + NSD, can be used to execute healing actions which + are defined during NS design time. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" + additionalParamsforNs: + description: > + Allows the OSS/BSS to provide additional + parameter(s) to the healing process at the NS level. + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" + + HealVnfData: + description: > + This type represents the information to heal a VNF that is part of an NS. + The NFVO shall then invoke the HealVNF + operation towards the appropriate VNFM. + It shall comply with the provisions defined in Table 6.5.3.44-1. + type: object + required: + - vnfInstanceId + properties: + vnfInstanceId: + description: > + Identifies the VNF instance, part of the NS, requiring a + healing action. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + cause: + description: > + Indicates the reason why a healing procedure is required. + type: string + additionalParams: + description: > + Additional parameters passed by the NFVO as input to + the healing process, specific to the VNF being healed. + EXAMPLE: Input parameters to VNF-specific healing procedures. + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" + + TerminateNsRequest: + description: > + This type represents a NS termination request. + It shall comply with the provisions defined in Table 6.5.2.15-1. + type: object + properties: + terminationTime: + description: > + Timestamp indicating the end time of the NS, i.e. the NS + will be terminated automatically at this timestamp. + Cardinality "0" indicates the NS termination takes place immediately + $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" + CreateNsRequest: type: object required: @@ -12,7 +136,7 @@ definitions: description: > Identifier of the NSD that defines the NS instance to be created. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsName: description: > Human-readable name of the NS instance to be created. @@ -58,7 +182,7 @@ definitions: id: description: > Identifier of the NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsInstanceName: description: > Human readable name of the NS instance. @@ -70,18 +194,18 @@ definitions: nsdId: description: > Identifier of the NSD on which the NS instance is based. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsdInfoId: description: > Identifier of the NSD information object on which the NS instance is based. This identifier was allocated by the NFVO. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" flavourId: description: > Identifier of the NS deployment flavor applied to the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfInstance: description: > Information on constituent VNF(s) of the NS instance. @@ -120,7 +244,7 @@ definitions: Identifier of the nested NS(s) of the NS instance. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsState: description: > The state of the NS instance. @@ -167,34 +291,34 @@ definitions: self: description: > URI of this resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" nestedNsInstances: description: > Links to resources related to this notification. type: array items: - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" instantiate: description: > Link to the "instantiate" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance in NOT_INSTANTIATED state). - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" terminate: description: > Link to the "terminate" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" update: description: > Link to the "update" task resource, if the related operation is possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" scale: description: > Link to the "scale" task resource, if the related @@ -202,7 +326,7 @@ definitions: possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" heal: description: > Link to the "heal" task resource, if the related @@ -210,7 +334,7 @@ definitions: possible based on the current status of this NS instance resource (i.e. NS instance is in INSTANTIATED state). - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" VnfInstance: description: > @@ -229,7 +353,7 @@ definitions: id: description: > Identifier of the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfInstanceName: description: > Name of the VNF instance. @@ -243,7 +367,7 @@ definitions: vnfdId: description: > Identifier of the VNFD on which the VNF instance is based. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfProvider: description: > Provider of the VNF and the VNFD. The value is copied from the VNFD. @@ -255,11 +379,11 @@ definitions: vnfSoftwareVersion: description: > Software version of the VNF. The value is copied from the VNFD. - $ref: "#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" vnfdVersion: description: > Identifies the version of the VNFD. The value is copied from the VNFD. - $ref: "#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" vnfPkgId: description: > Identifier of information held by the NFVO about @@ -267,7 +391,7 @@ definitions: based. This identifier was allocated by the NFVO. This attribute can be modified with the PATCH method. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfConfigurableProperties: description: > Current values of the configurable properties of the VNF instance. @@ -293,11 +417,11 @@ definitions: set to true, auto-healing is currently enabled. If set to false, auto-healing is currently disabled. This attribute can be modified with the PATCH method. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" vimId: description: > Identifier of a VIM that manages resources for the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" instantiationState: description: > The instantiation state of the VNF. @@ -317,7 +441,7 @@ definitions: flavourId: description: > Identifier of the VNF deployment flavor applied to this VNF instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfState: description: > The state of the VNF instance. @@ -389,14 +513,14 @@ definitions: Additional VNF-specific metadata describing the VNF instance. Metadata that are writeable are declared in the VNFD. This attribute can be modified with the PATCH method. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" extensions: description: > VNF-specific attributes that affect the lifecycle management of this VNF instance by the VNFM, or the lifecycle management scripts. Extensions that are writeable are declared in the VNFD. This attribute can be modified with the PATCH method. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" LccnLinks: description: > @@ -421,11 +545,6 @@ definitions: related lifecycle operation occurrence $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink" - Version: - description: > - A Version. - type: string - VnfOperationalStateType: type: string enum: @@ -441,7 +560,7 @@ definitions: aspectId: description: > Identifier of the scaling aspect. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" scaleLevel: description: > Indicates the scale level. The minimum value shall be 0 and the @@ -463,7 +582,7 @@ definitions: pnfId: description: > Identifier of the PNF. This identifier is allocated by the OSS/BSS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfName: description: > Name of the PNF. @@ -471,17 +590,17 @@ definitions: pnfdId: description: > Identifier of the PNFD on which the PNF is based. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfdInfoId: description: > Identifier of the PNFD information onject related to this PNF. This identifier is allocated by the NFVO - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfProfileId: description: > Identifier of the related PnfProfile in the NSD on which the PNF is based. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" cpInfo: description: > Information on the external CP of the PNF. @@ -500,18 +619,18 @@ definitions: cpInstanceId: description: > Identifier of the CP in the scope of the PNF. - $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInPnf" cpdId: description: > Identifier of (reference to) the Connection Point Descriptor (CPD) for this CP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" cpProtocolData: description: > Parameters for configuring the network protocols on the CP. type: array items: - $ref: "SOL005_def.yaml#/definitions/CpProtocolData" + $ref: "#/definitions/CpProtocolData" NsVirtualLinkInfo: description: > @@ -527,22 +646,22 @@ definitions: id: description: > Identifier of the VL instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nsVirtualLinkDescId: description: > Identifier of the VLD in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" nsVirtualLinkProfileId: description: > Identifier of the VL profile in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" resourceHandle: description: > Identifier(s) of the virtualised network resource(s) realizing the VL instance. See note. type: array items: - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" linkPort: description: > Link ports of the VL instance. @@ -565,31 +684,31 @@ definitions: id: description: > Identifier of this VNFFG instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnffgdId: description: > Identifier of the VNFFGD in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfInstanceId: description: > Identifier(s) of the constituent VNF instance(s) of this VNFFG instance. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfdInfoId: description: > Identifier(s) of the constituent PNF instance(s) of this VNFFG instance. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsVirtualLinkInfoId: description: > Identifier(s) of the constituent VL instance(s) of this VNFFG instance. type: array items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nsCpHandle: description: > Identifiers of the CP instances attached to the @@ -612,13 +731,13 @@ definitions: id: description: > Identifier of this NFP instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nfpdId: description: > Identifier of the NFPD used to instantiate this NFP instance. It shall be present if the NFP instance is instantiated from the NFPD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" nfpName: description: > Human readable name for the NFP instance. @@ -667,37 +786,37 @@ definitions: description: > Identifier of the VNF instance associated to the CP instance. This attribute shall be present if the CP instance is VNF external CP. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfExtCpInstanceId: description: > Identifier of the VNF external CP instance in the scope of the VNF instance. This attribute shall be present if the CP instance is VNF external CP. See notes 1 and 4. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" pnfInfoId: description: > Identifier of the PNF instance associated to the CP instance. This attribute shall be present if the CP instance is PNF external CP. See notes 2 and 4. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfExtCpInstanceId: description: > Identifier of the PNF external CP instance in the scope of the PNF. This attribute shall be present if the CP instance is PNF external CP. See notes 2 and 4. - $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInPnf" nsInstanceId: description: > Identifier of the NS instance associated to the SAP instance. This attribute shall be present if the CP instance is NS SAP. See notes 3 and 4. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsSapInstanceId: description: > Identifier of the SAP instance in the scope of the NS instance. This attribute shall be present if the CP instance is NS SAP. See notes 3 and 4. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" SapInfo: description: > @@ -712,11 +831,11 @@ definitions: id: description: > Identifier of the SAP instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" sapdId: description: > Identifier of the SAPD in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" sapName: description: > Human readable name for the SAP instance. @@ -744,7 +863,7 @@ definitions: id: description: > Identifier of the monitoring parameter defined in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" name: description: > Human readable name of the monitoring parameter, as defined in the NSD. @@ -767,7 +886,7 @@ definitions: id: description: > Identifier of the monitoring parameter defined in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" name: description: > Human readable name of the monitoring parameter, as defined in the VNFD. @@ -790,11 +909,11 @@ definitions: id: description: > Identifier of the external CP instance and the related information instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the external CPD, VnfExtCpd, in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" cpProtocolInfo: description: > Network protocol information for this CP. @@ -810,7 +929,7 @@ definitions: metadata: description: > Metadata about this external CP. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" associatedVnfcCpId: description: > Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure @@ -818,7 +937,7 @@ definitions: Shall be present in case this CP instance maps to a VNFC CP(s). The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. One and only one shall be present. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" associatedVnfVirtualLinkId: description: > Identifier of the "VnfVirtualLinkResourceInfo" structure that represents @@ -826,7 +945,7 @@ definitions: present in case this CP instance maps to an internal VL. The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are mutually exclusive. One and only one shall be present. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" CpGroupInfo: description: > @@ -879,7 +998,7 @@ definitions: type: array maxItems: 2 items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" pnfExtCpIds: description: > Identifier(s) of the PNF CP(s) which form the pair. @@ -889,7 +1008,7 @@ definitions: type: array maxItems: 2 items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInPnf" sapIds: description: > Identifier(s) of the SAP(s) which form the pair. @@ -899,7 +1018,7 @@ definitions: type: array maxItems: 2 items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" ForwardingBehaviourInputParameters: description: > @@ -978,7 +1097,7 @@ definitions: macAddress: description: > Assigned MAC address. - $ref: "SOL005_def.yaml#/definitions/MacAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/MacAddress" ipAddresses: description: > Addresses assigned to the CP instance. Each entry represents IP @@ -1004,7 +1123,7 @@ definitions: "subnetId" if provided). type: array items: - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" isDynamic: description: > Indicates whether this set of addresses was assigned @@ -1024,18 +1143,18 @@ definitions: minAddress: description: > Lowest IP address belonging to the range. - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" subnetId: description: > Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses are bound to that subnet. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVim" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim" type: @@ -1051,7 +1170,7 @@ definitions: defined by "subnetId" if provided). See note. type: array items: - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" isDynamic: description: > Indicates whether this set of addresses was @@ -1072,26 +1191,26 @@ definitions: minAddress: description: > Lowest IP address belonging to the range. - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" minAddress: description: > Lowest IP address belonging to the range - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" maxAddress: description: > Highest IP address belonging to the range. - $ref: "SOL005_def.yaml#/definitions/IpAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" subnetId: description: > Subnet defined by the identifier of the subnet resource in the VIM. In case this attribute is present, IP addresses are bound to that subnet. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVim" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim" ExtVirtualLinkInfo: type: object @@ -1105,11 +1224,11 @@ definitions: information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" resourceHandle: description: > Reference to the resource realizing this VL. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" extLinkPorts: description: > Link ports of this VL. @@ -1130,18 +1249,18 @@ definitions: description: > Identifier of this link port as provided by the entity that has created the link port. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" resourceHandle: description: > Reference to the virtualised resource realizing this link port. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" cpInstanceId: description: > Identifier of the external CP of the VNF connected to this link port. There shall be at most one link port associated with any external connection point instance. The value refers to an "extCpInfo" item in the VnfInstance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" ExtManagedVirtualLinkInfo: type: object @@ -1155,15 +1274,15 @@ definitions: externally-managed VL information instance. The identifier is assigned by the NFV-MANO entity that manages this VL instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" networkResource: description: > Reference to the VirtualNetwork resource. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" vnfLinkPorts: description: > Link ports of this VL. @@ -1180,11 +1299,11 @@ definitions: id: description: > Identifier of this link port as provided by the entity that has created the link port. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" resourceHandle: description: > Reference to the virtualised network resource realizing this link port. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" cpInstanceId: description: > When the link port is used for external connectivity by the VNF, @@ -1201,7 +1320,7 @@ definitions: (i.e. VNFC CP) instance. The value refers to an "extCpInfo" item in the VnfInstance or a "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" cpInstanceType: description: > Type of the CP instance that is identified by cpInstanceId. @@ -1225,7 +1344,7 @@ definitions: id: description: > Identifier of the monitoring parameter defined in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" name: description: > Human readable name of the monitoring parameter, as defined in the VNFD. @@ -1258,27 +1377,27 @@ definitions: id: description: > Identifier of this VnfcResourceInfo instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" vduId: description: > Reference to the applicable VDU in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" computeResource: description: > Reference to the VirtualCompute resource. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" storageResourceIds: description: > References to the VirtualStorage resources. The value refers to a VirtualStorageResourceInfo item in the VnfInstance. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfcCpInfo: description: > CPs of the VNFC instance. @@ -1296,16 +1415,16 @@ definitions: description: > Identifier of this VNFC CP instance and the associated array entry. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" cpdId: description: > Identifier of the VDU CPD, cpdId, in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfExtCpId: description: > When the VNFC CP is exposed as external CP of the VNF, the identifier of this external VNF CP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" cpProtocolInfo: description: > Network protocol information for this CP. @@ -1317,15 +1436,15 @@ definitions: Identifier of the "vnfLinkPorts" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if the CP is associated to a link port. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" metadata: description: > Metadata about this CP. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" metadata: description: > Metadata about this resource. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" VnfVirtualLinkResourceInfo: description: > @@ -1340,20 +1459,20 @@ definitions: id: description: > Identifier of this VnfVirtualLinkResourceInfo instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" vnfVirtualLinkDescId: description: > Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" networkResource: description: > Reference to the VirtualNetwork resource. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfLinkPorts: description: > Links ports of this VL. @@ -1366,7 +1485,7 @@ definitions: metadata: description: > Metadata about this resource. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" VirtualStorageResourceInfo: description: > @@ -1381,24 +1500,24 @@ definitions: id: description: > Identifier of this VirtualStorageResourceInfo instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the VirtualStorageDesc in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" storageResource: description: > Reference to the VirtualStorage resource. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" reservationId: description: > The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" metadata: description: > Metadata about this resource. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" NsLinkPortInfo: description: > @@ -1413,12 +1532,12 @@ definitions: description: > Identifier of this link port as provided by the entity that has created the link port. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" resourceHandle: description: > Identifier of the virtualised network resource realizing this link port. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" nsCpHandle: description: > Identifier of the CP/SAP instance to be connected to this @@ -1453,7 +1572,7 @@ definitions: the NS to be instantiated. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfProfileId: description: > Reference to a vnfProfile defined in the NSD. @@ -1466,7 +1585,7 @@ definitions: presents is not necessary as a part of the NS to be instantiated. type: array items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfInstanceId: description: > Reference to the existing VNF instance as the subject of @@ -1474,7 +1593,7 @@ definitions: is not necessary as a part of the NS to be instantiated. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" affinityOrAntiAffiinty: description: > The type of the constraint. @@ -1509,7 +1628,7 @@ definitions: nsFlavourId: description: > Identifier of the NS deployment flavor to be instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" sapData: description: > Create data concerning the SAPs of this NS. @@ -1563,7 +1682,7 @@ definitions: which is covered in additionalParamsForVnf), and as opposed to the nested NS level, which is covered in additionalParamForNestedNs. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" additionalParamForNestedNs: description: > Allows the OSS/BSS to provide additional parameter(s) @@ -1593,14 +1712,14 @@ definitions: description: > Timestamp indicating the earliest time to instantiate the NS. Cardinality "0" indicates the NS instantiation takes place immediately. - $ref: "SOL005_def.yaml#/definitions/DateTime" + $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" nsInstantiationLevelId: description: > Identifies one of the NS instantiation levels declared in the DF applicable to this NS instance. If not present, the default NS instantiation level as declared in the NSD shall be used. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" additionalAffinityOrAntiAffinityRule: description: > Specifies additional affinity or anti-affinity constraint for @@ -1622,14 +1741,13 @@ definitions: nsProfileId: description: > Identifier of a NsProfile to which the additional parameters apply. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" additionalParam: description: > Additional parameters that are to be applied on a per nested NS instance. type: array items: - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" - + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" ParamsForVnf: description: > @@ -1644,12 +1762,12 @@ definitions: description: > Identifier of (reference to) a vnfProfile to which the additional parameters apply. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" additionalParams: description: > Additional parameters that are applied for the VNF instance to be created. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" LocationConstraints: description: > @@ -1701,7 +1819,7 @@ definitions: description: > Identifier of (reference to) a vnfProfile to which the additional parameters apply. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" locationConstraints: description: > Defines the location constraints for the VNF instance to @@ -1721,14 +1839,14 @@ definitions: vnfInstanceId: description: > Identifier of the existing VNF instance to be used in the NS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfProfileId: description: > Identifier of (Reference to) a vnfProfile defined in the NSD which the existing VNF instance shall be matched with. If not present, the NFVO will select the VnfProfile matching the information in the VNF instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" NestedNsInstanceData: description: > @@ -1742,14 +1860,14 @@ definitions: nestedNsInstanceId: description: > Identifier of the existing nested NS instance to be used in the NS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsProfileId: description: > Identifier of an NsProfile defined in the NSD which the existing nested NS instance shall be matched with. If not present, the NFVO will select the NsProfile matching the information in the nested NS instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" SapData: description: > @@ -1764,7 +1882,7 @@ definitions: sapdId: description: > Reference to the SAPD for this SAP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" sapName: description: > Human readable name for the SAP. @@ -1778,7 +1896,7 @@ definitions: Parameters for configuring the network protocols on the SAP. type: array items: - $ref: "SOL005_def.yaml#/definitions/CpProtocolData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/CpProtocolData" ScaleNsRequest: description: > @@ -1814,7 +1932,7 @@ definitions: Timestamp indicating the scale time of the NS, i.e. the NS will be scaled at this timestamp. Cardinality "0" indicates the NS scaling takes place immediately". - $ref: "SOL005_def.yaml#/definitions/DateTime" + $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" UpdateNsRequest: description: > @@ -1896,7 +2014,7 @@ definitions: terminated by the NFVO. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" instantiateVnfData: description: > Identifies the new VNF to be instantiated. It can be used @@ -1948,7 +2066,7 @@ definitions: NS instance. It shall be present only if updateType = "REMOVE_SAP." type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" addNestedNsData: description: > The identifier of an existing nested NS instance to be @@ -1964,7 +2082,7 @@ definitions: updateType = "REMOVE_NESTED_NS". type: array items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" assocNewNsdVersionData: description: > Specify the new NSD to be used for the NS instance. It @@ -1994,7 +2112,7 @@ definitions: "REMOVE_VNFFG". type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" updateVnffg: description: > Specify the new VNFFG Information data to be updated @@ -2029,13 +2147,14 @@ definitions: It shall be present only if updateType = "REMOVE_PNF". type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" updateTime: description: > Timestamp indicating the update time of the NS, i.e. the NS will be updated at this timestamp. Cardinality "0" indicates the NS update takes place immediately. - $ref: "SOL005_def.yaml#/definitions/DateTime" + $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" + InstantiateVnfData: description: > This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the @@ -2052,18 +2171,18 @@ definitions: description: > Information sufficient to identify the VNFD which defines the VNF to be instantiated. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfFlavourId: description: > Identifier of the VNF deployment flavor to be instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfInstantiationLevelId: description: > Identifier of the instantiation level of the deployment flavor to be instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfInstanceName: description: > Human-readable name of the VNF instance to be created. @@ -2077,13 +2196,13 @@ definitions: Information about external VLs to connect the VNF to. type: array items: - $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > Information about internal VLs that are managed by other entities than the VNFM. type: array items: - $ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData" localizationLanguage: description: > Localization language of the VNF to be instantiated. @@ -2093,7 +2212,7 @@ definitions: description: > Additional input parameters for the instantiation process, specific to the VNF being instantiated. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" ChangeVnfFlavourData: description: > @@ -2108,36 +2227,36 @@ definitions: vnfInstanceId: description: > Identifier of the VNF instance to be modified. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" newFlavourId: description: > Identifier of the VNF deployment flavor to be instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" instantiationLevelId: description: > Identifier of the instantiation level of the deployment flavor to be instantiated. If not present, the default instantiation level as declared in the VNFD is instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" extVirtualLinks: description: > Information about external VLs to connect the VNF to. type: array items: - $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ExtVirtualLinkData" extManagedVirtualLinks: description: > information about internal VLs that are managed by NFVO. type: array items: - $ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData" additionalParams: description: > Additional input parameters for the flavor change process, specific to the VNF being modified, as declared in the VNFD as part of "ChangeVnfFlavourOpConfig". - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" OperateVnfData: description: > @@ -2152,7 +2271,7 @@ definitions: vnfInstanceId: description: > Identifier of the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" changeStateTo: description: > The desired operational state (i.e. started or stopped) @@ -2177,6 +2296,7 @@ definitions: enum: - STARTED - STOPPED + StopType: description: > * FORCEFUL: The VNFM will stop the VNF immediately after accepting the @@ -2203,7 +2323,7 @@ definitions: vnfInstanceId: description: > Identifier of the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfInstanceName: description: > New value of the "vnfInstanceName" attribute in @@ -2218,22 +2338,22 @@ definitions: description: > New value of the "vnfPkgId" attribute in "VnfInstance". The value "null" is not permitted - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfConfigurableProperties: description: > Modifications to entries in the "vnfConfigurableProperties" list, as defined below this Table. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" Metadata: description: > Modifications to entries in the "metadata" list, as defined below this Table. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" Extensions: description: > Modifications to entries in the "extensions" list, as defined below this Table. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" ChangeExtVnfConnectivityData: description: > @@ -2254,19 +2374,19 @@ definitions: vnfInstanceId: description: > Identifier of the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" extVirtualLink: description: > Information about external VLs to change (e.g. connect the VNF to). type: array items: - $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ExtVirtualLinkData" additionalParams: description: > Additional parameters passed by the OSS as input to the external connectivity change process, specific to the VNF instance being changed. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" AssocNewNsdVersionData: description: > @@ -2284,7 +2404,7 @@ definitions: description: > Identifier of the new NSD version that is to be associated to the NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" sync: description: > Specify whether the NS instance shall be automatically @@ -2320,13 +2440,13 @@ definitions: description: > Specify the target NS instance where the VNF instances are moved to. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfInstanceId: description: > Specify the VNF instance that is moved. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" AddVnffgData: description: > @@ -2342,7 +2462,7 @@ definitions: description: > Identifier of the VNFFGD used to create this VNFFG instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnffgName: description: > Human readable name for the VNFFG. @@ -2363,7 +2483,7 @@ definitions: vnffgInfoId: description: > Identifier of an existing VNFFG to be updated for the NS Instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nfp: description: > Indicate the desired new NFP(s) for a given VNFFG @@ -2379,7 +2499,7 @@ definitions: Identifier(s) of the NFP to be deleted from a given VNFFG. type: array items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" NfpData: description: > @@ -2394,7 +2514,7 @@ definitions: for modified NFPs and shall be absent for the new NFP. It shall be present for modified NFPs and shall be absent for the new NFP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nfpName: description: > Human readable name for the NFP. It shall be present @@ -2438,11 +2558,11 @@ definitions: etherDestinationAddress: description: > Indicates a destination Mac address. - $ref: "SOL005_def.yaml#/definitions/MacAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/MacAddress" etherSourceAddress: description: > Indicates a source Mac address. - $ref: "SOL005_def.yaml#/definitions/MacAddress" + $ref: "../../definitions/SOL005_def.yaml#/definitions/MacAddress" etherType: description: > Human readable description for the VNFFG. @@ -2456,7 +2576,7 @@ definitions: tag [6] Multiple tags can be included for QinQ stacking. See note. type: array items: - $ref: "SOL005_def.yaml#/definitions/String" + $ref: "../../definitions/SOL005_def.yaml#/definitions/String" protocol: description: > Indicates the L4 protocol, For IPv4 [7] this @@ -2485,25 +2605,25 @@ definitions: sourcePortRange: description: > Indicates a range of source ports - $ref: "SOL005_def.yaml#/definitions/PortRange" + $ref: "../../definitions/SOL005_def.yaml#/definitions/PortRange" destinationPortRange: description: > Indicates a range of destination ports. - $ref: "SOL005_def.yaml#/definitions/PortRange" + $ref: "../../definitions/SOL005_def.yaml#/definitions/PortRange" sourceIpAddressPrefix: description: > Indicates the source IP address range in CIDR format. - $ref: "SOL005_def.yaml#/definitions/IpAddressPrefix" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddressPrefix" destinationIpAddressPrefix: description: > Indicates the destination IP address range in CIDR format. - $ref: "SOL005_def.yaml#/definitions/IpAddressPrefix" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddressPrefix" extendedCriteria: description: > Indicates values of specific bits in a frame. type: array items: - $ref: "SOL005_def.yaml#/definitions/Mask" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Mask" ChangeNsFlavourData: description: > @@ -2518,12 +2638,12 @@ definitions: newNsFlavourId: description: > Identifier of an existing VNFFG to be updated for the NS Instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" instantiationLevelId: description: > Identifier of the instantiation level of the deployment flavour to be instantiated. If not present, the default instantiation level as declared in the NSD is instantiated. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" AddPnfData: description: > @@ -2539,7 +2659,7 @@ definitions: pnfId: description: > Identifier of the PNF. This identifier is allocated by the OSS/BSS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfName: description: > Name of the PNF @@ -2547,11 +2667,11 @@ definitions: pnfdId: description: > Identifier of the PNFD on which the PNF is based. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfProfileId: description: > Identifier of related PnfProfile in the NSD on which the PNF is based. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" cpData: description: > Address assigned for the PNF external CP(s). @@ -2571,17 +2691,17 @@ definitions: cpInstanceI16: description: > Identifier of the CP. Shall be present for existing CP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInPnf" cpdId: description: > Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" cpProtocolData: description: > Address assigned for this CP. type: array items: - $ref: "SOL005_def.yaml#/definitions/CpProtocolData" + $ref: "#/definitions/CpProtocolData" ModifyPnfData: description: > @@ -2595,7 +2715,7 @@ definitions: pnfId: description: > Identifier of the PNF. This identifier is allocated by the OSS/BSS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfName: description: > Name of the PNF. @@ -2622,11 +2742,11 @@ definitions: description: > Identifier of the virtual link instance, identifying the applicable "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" virtualLinkDescId: description: > Identifier of the related VLD in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" changeType: description: > Signals the type of change. Permitted values: @@ -2651,13 +2771,13 @@ definitions: Reference to the VirtualNetwork resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" metadata: description: > Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the VnfVirtualLinkResourceInfo structure. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" AffectedVirtualStorage: description: > @@ -2674,11 +2794,11 @@ definitions: description: > Identifier of the storage instance, identifying the applicable "virtualStorageResourceInfo" entry in the "VnfInstance" data type. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" virtualStorageDescId: description: > Identifier of the related VirtualStorage descriptor in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" changeType: description: > Signals the type of change. Permitted values: @@ -2699,13 +2819,13 @@ definitions: Reference to the VirtualStorage resource. Detailed information is (for new and modified resources) or has been (for removed resources) available from the VIM. - $ref: "SOL005_def.yaml#/definitions/ResourceHandle" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" metadata: description: > Metadata about this resource. The content of this attribute shall be a copy of the content of the "metadata" attribute of the VirtualStorageResourceInfo structure. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" AffectedVnf: description: > @@ -2720,15 +2840,15 @@ definitions: vnfInstanceId: description: > Identifier of the VNF instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfdId: description: > Identifier of the VNFD of the VNF Instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfProfileId: description: > Identifier of the VNF profile of the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vnfName: description: > Name of the VNF Instance. @@ -2810,15 +2930,15 @@ definitions: description: > Identifier of the affected PNF. This identifier is allocated by the OSS/BSS. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" pnfdId: description: > Identifier of the PNFD on which the PNF is based. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" pnfProfileId: description: > Identifier of the VNF profile of the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" pnfName: description: > Name of the PNF. @@ -2828,7 +2948,7 @@ definitions: Identifier of the CP in the scope of the PNF. type: array items: - $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInPnf" changeType: description: > Signals the type of change. @@ -2868,15 +2988,15 @@ definitions: nsVirtualLinkInstanceId: description: > Identifier of the VL Instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" nsVirtualLinkDescId: description: > Identifier of the VLD in the NSD for this VL. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" vlProfileId: description: > Identifier of the VLD in the NSD for this VL. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" changeType: description: > Signals the type of change. @@ -2920,11 +3040,11 @@ definitions: vnffgInstanceId: description: > Identifier of the VNFFG instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNs" vnffgdId: description: > Identifier of the VNFFGD of the VNFFG instance. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" changeType: description: > Signals the type of change. @@ -2965,11 +3085,11 @@ definitions: nsInstanceId: description: > Identifier of the nested NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" nsdId: description: > Identifier of the NSD of the nested NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" changeType: description: > Signals the type of lifecycle change. @@ -3018,11 +3138,11 @@ definitions: sapInstanceId: description: > Identifier of the nested NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" sapdId: description: > Identifier of the NSD of the nested NS instance. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" sapName: description: > Human readable name for the SAP. @@ -3111,7 +3231,7 @@ definitions: callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "SOL005_def.yaml#/definitions/Uri" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to configure the use of Authorization when @@ -3119,7 +3239,7 @@ definitions: in clause 4.5.3.4. This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "SOL005_def.yaml#/definitions/SubscriptionAuthentication" + $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" LccnSubscription: description: > @@ -3134,7 +3254,7 @@ definitions: id: description: > Identifier of this subscription resource. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" filter: description: > Filter settings for this subscription, to define the subset of all @@ -3145,7 +3265,7 @@ definitions: callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "SOL005_def.yaml#/definitions/Uri" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" _links: description: > Links to resources related to this resource. @@ -3156,7 +3276,7 @@ definitions: self: description: > URI of this resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" LifecycleChangeNotificationsFilter: description: > @@ -3173,7 +3293,7 @@ definitions: nsInstanceSubscriptionFilter: description: > Filter criteria to select NS instances about which to notify. - $ref: "#/definitions/NsInstanceSubscriptionFilter" + $ref: "../../definitions/SOL005_def.yaml#/definitions/NsInstanceSubscriptionFilter" notificationTypes: description: > Match particular notification types. @@ -3256,11 +3376,11 @@ definitions: nsScalingAspectId: description: > Identifier of the NS scaling aspect. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" nsScaleLevelId: description: > Identifier of the NS scale level. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" ScaleNsData: description: > @@ -3282,7 +3402,7 @@ definitions: instance as part of the scaling operation. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" scaleNsByStepsData: description: > The information used to scale an NS instance by @@ -3333,7 +3453,7 @@ definitions: vnfInstanceid: description: > Identifier of the VNF instance being scaled. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" scaleVnfType: description: > Type of the scale VNF operation requested. @@ -3383,7 +3503,7 @@ definitions: description: > The aspect of the NS that is requested to be scaled, as declared in the NSD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" numberOfSteps: description: > The number of scaling steps to be performed. Defaults to 1. @@ -3402,7 +3522,7 @@ definitions: description: > Identifier of the target NS instantiation level of the current DF to which the NS instance is requested to be scaled. - $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" nsScaleInfo: description: > For each NS scaling aspect of the current DF, defines @@ -3423,7 +3543,7 @@ definitions: description: > Identifier of the target instantiation level of the current deployment flavor to which the VNF is requested to be scaled. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" vnfScaleInfo: description: > For each scaling aspect of the current deployment @@ -3436,7 +3556,7 @@ definitions: description: > Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" ScaleByStepData: description: > @@ -3451,7 +3571,7 @@ definitions: description: > Identifier of (reference to) the aspect of the VNF that is requested to be scaled, as declared in the VNFD. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" numberOfSteps: description: > Number of scaling steps. It shall be a positive number. @@ -3466,54 +3586,7 @@ definitions: description: > Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF instance being scaled. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" - - NsInstanceSubscriptionFilter: - description: > - This type represents subscription filter criteria to match NS instances. - It shall comply with the provisions defined in - Table 4.4.1.5-1. - type: object - properties: - nsdIds: - description: > - If present, match NS instances that were created - based on a NSD identified by one of the nsdId - values listed in this attribute. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/Identifier" - vnfdIds: - description: > - If present, match NS instances that contain VNF - instances that were created based on a VNFD - identified by one of the vnfdId values listed in - this attribute. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/Identifier" - pnfdIds: - description: > - If present, match NS instances that contain - PNFs that are represented by a PNFD identified - by one of the pnfdId values listed in this attribute. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/Identifier" - nsInstanceIds: - description: > - If present, match NS instances with an instance - identifier listed in this attribute. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/Identifier" - nsInstanceNames: - description: > - If present, match NS instances with a NS - Instance Name listed in this attribute. - type: array - items: - $ref: "SOL005_def.yaml#/definitions/String" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" LcmOperationStateType: description: > @@ -3549,6 +3622,7 @@ definitions: - VNF - PNF - NS + LcmOpNameForChangeNotificationType: description: > The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1. @@ -3584,6 +3658,7 @@ definitions: - NS_UPDATE - NS_TERMINATE - NS_HEAL + LcmOpOccStatusForChangeNotificationType: description: > The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management @@ -3623,11 +3698,11 @@ definitions: id: description: > Identifier of this NS lifecycle operation occurrence. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" operationState: description: > The state of the NS LCM operation. - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationStateType" + $ref: "#/definitions/NsLcmOperationStateType" stateEnteredTime: description: > Date-time when the current state was entered. @@ -3636,12 +3711,12 @@ definitions: nsInstanceId: description: > Identifier of the NS instance to which the operation applies. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" lcmOperationType: description: > Type of the actual LCM operation represented by this lcm operation occurrence. - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpType" + $ref: "#/definitions/NsLcmOpType" startTime: description: > Date-time of the start of the operation. @@ -3713,7 +3788,7 @@ definitions: represents the result of a lifecycle operation. type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnf" + $ref: "#/definitions/AffectedVnf" affectedPnfs: description: > Information about the PNF instances that were affected @@ -3721,7 +3796,7 @@ definitions: represents the result of a lifecycle operation. type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedPnf" + $ref: "#/definitions/AffectedPnf" affectedVls: description: > Information about the VL instances that were affected @@ -3729,7 +3804,7 @@ definitions: represents the result of a lifecycle operation. type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVl" + $ref: "#/definitions/AffectedVl" affectedVnffgs: description: > Information about the VNFFG instances that were @@ -3737,7 +3812,7 @@ definitions: represents the result of a lifecycle operation. See note type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnffg" + $ref: "#/definitions/AffectedVnffg" affectedNss: description: > Information about the nested NS instances that were @@ -3745,7 +3820,7 @@ definitions: represents the result of a lifecycle operation. See note. type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedNs" + $ref: "#/definitions/AffectedNs" affectedSaps: description: > Information about the nested NS instances that were @@ -3753,7 +3828,7 @@ definitions: represents the result of a lifecycle operation. See note. type: array items: - $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedSap" + $ref: "#/definitions/AffectedSap" _links: description: > Links to resources related to this resource. @@ -3765,38 +3840,377 @@ definitions: self: description: > URI of this resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" nsInstance: description: > Link to the NS instance that the operation applies to. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" cancel: description: > Link to the task resource that represents the "cancel" operation for this LCM operation occurrence, if cancelling is currently allowed. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" retry: description: > Link to the task resource that represents the "cancel" operation for this LCM operation occurrence, if cancelling is currently allowed. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" rollback: description: > Link to the task resource that represents the "rollback" operation for this LCM operation occurrence, if rolling back is currently allowed. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" continue: description: > Link to the task resource that represents the "continue" operation for this LCM operation occurrence, if rolling back is currently allowed. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" fail: description: > Link to the task resource that represents the "fail" operation for this LCM operation occurrence, if rolling back is currently allowed. - $ref: "SOL005_def.yaml#/definitions/Link" \ No newline at end of file + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" + + subscriptionId: + description: > + Identifier of the subscription that this notification relates to. + type: string + + nsInstanceId: + description: > + The deleted NS instance identifier. + type: string + + CpProtocolData: + description: > + This type represents network protocol data. + type: object + required: + - layerProtocol + properties: + layerProtocol: + description: > + Identifier of layer(s) and protocol(s). + Permitted values: IP_OVER_ETHERNET. + type: string + enum: + - IP_OVER_ETHERNET + ipOverEthernet: + description: > + Network address data for IP over Ethernet to + assign to the extCP instance. Shall be + present if layerProtocol is equal to + "IP_OVER_ETHERNET", and shall be absent otherwise. + $ref: "#/definitions/IpOverEthernetAddressData" + + IpOverEthernetAddressData: + description: > + This type represents network address data for IP over Ethernet. + type: object + properties: + macAddress: + description: > + MAC address. If this attribute is not present, it shall be chosen by the NFV MANO. + $ref: "../../definitions/SOL005_def.yaml#/definitions/MacAddress" + ipAddresses: + description: > + List of IP addresses to assign to the CP instance. Each entry + represents IP address data for fixed or dynamic IP address + assignment per subnet. + If this attribute is not present, no IP address shall be assigned. + type: array + items: + type: object + required: + - type + properties: + type: + description: > + The type of the IP addresses. + Permitted values: IPV4, IPV6. + type: string + enum: + - IPV4 + - IPV6 + fixedAddresses: + description: > + Fixed addresses to assign (from the subnet defined by + "subnetId" if provided). + Exactly one of "fixedAddresses", "numDynamicAddresses" or + "ipAddressRange" shall be present. + type: array + items: + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" + numDynamicAddresses: + description: > + Number of dynamic addresses to assign (from the subnet defined + by "subnetId" if provided). + Exactly one of "fixedAddresses", "numDynamicAddresses" or + "ipAddressRange" shall be present. + type: integer + addressRange: + description: > + An IP address range to be used, e.g. in case of egress + connections. + In case this attribute is present, IP addresses from the range + will be used. + type: object + required: + - minAddress + - maxAddress + properties: + minAddress: + description: > + Lowest IP address belonging to the range. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" + maxAddress: + description: > + Highest IP address belonging to the range. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IpAddress" + subnetId: + description: > + Subnet defined by the identifier of the subnet resource in the + VIM. + In case this attribute is present, IP addresses from that + subnet will be assigned; otherwise, IP addresses not bound to + a subnet will be assigned. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim" + + ExtVirtualLinkData: + description: > + This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1. + type: object + required: + - resourceId + - extCps + properties: + extVirtualLinkId: + description: > + The identifier of the external VL instance, if provided. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + vimId: + description: > + Identifier of the VIM that manages this resource. This + attribute shall only be supported and present if VNFrelated + resource management in direct mode is applicable. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + resourceProviderId: + description: > + Identifies the entity responsible for the management of + this resource. + This attribute shall only be supported and present if + VNF-related resource management in indirect mode is + applicable. The identification scheme is outside the + scope of the present document. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + resourceId: + description: > + The identifier of the resource in the scope of the VIM or + the resource provider. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim" + extCps: + description: > + External CPs of the VNF to be connected to this external VL. + type: array + items: + $ref: "#/definitions/VnfExtCpData" + extLinkPorts: + description: > + Externally provided link ports to be used to connect + external connection points to this external VL. + type: array + items: + $ref: "#/definitions/ExtLinkPortData" + + ExtManagedVirtualLinkData: + description: > + This type represents an externally-managed internal VL. + It shall comply with the provisions defined in Table 6.5.3.27-1. + type: object + required: + - virtualLinkDescId + - resourceId + properties: + extManagedVirtualLinkId: + description: > + The identifier of the externally-managed internal VL + instance, if provided. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + vmfVirtualLinkDescId: + description: > + The identifier of the VLD in the VNFD for this VL. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" + vimId: + description: > + Identifier of the VIM that manage this resource. This + attribute shall only be supported and present if VNFrelated + resource management in direct mode is applicable. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + resourceProviderId: + description: > + Identifies the entity responsible for the management of + this resource. This attribute shall only be supported and present if + VNF-related resource management in indirect mode is + applicable. The identification scheme is outside the + scope of the present document. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + resourceId: + description: > + The identifier of the resource in the scope of the VIM or + the resource provider. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVim" + + VnfExtCpData: + description: > + This type represents configuration information for external CPs created + from a CPD. + type: object + required: + - cpdId + properties: + cpdId: + description: > + The identifier of the CPD in the VNFD. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" + cpConfig: + description: > + List of instance data that need to be configured on the CP instances + created from the respective CPD. + type: array + items: + $ref: "#/definitions/VnfExtCpConfig" + + ExtLinkPortData: + description: > + This type represents an externally provided link port to be used to + connect an external connection point to an external VL. + type: object + required: + - id + - resourceHandle + properties: + id: + description: > + Identifier of this link port as provided by the entity that has + created the link port. + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + resourceHandle: + description: > + Reference to the virtualised resource realizing this link port. + $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle" + + VnfExtCpConfig: + description: > + This type represents an externally provided link port or network address + information per instance of an external connection point. In case a link + port is provided, the VNFM shall use that link port when connecting the + external CP to the external VL. In a link port is not provided, the VNFM + shall create a link port on the external VL, and use that link port to + connect the external CP to the external VL. + type: object + properties: + cpInstanceId: + description: > + Identifier of the external CP instance to which this set of + configuration parameters is requested to be applied. + Shall be present if this instance has already been created. + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnf" + linkPortId: + description: > + Identifier of a pre-configured link port to which the external CP + will be associated. + The following conditions apply to the attributes "linkPortId" and + "cpProtocolData": + * The "linkPortId" and "cpProtocolData" attributes shall both be + absent for the deletion of an existing external CP instance + addressed by cpInstanceId. + * At least one of these attributes shall be present for a + to-be-created external CP instance or an existing external + CP instance. + * If the "linkPortId" attribute is absent, the VNFM shall create a + link port. + * If the "cpProtocolData" attribute is absent, the "linkPortId" + attribute shall be provided referencing a pre-created link port, + and the VNFM can use means outside the scope of the present + document to obtain the pre-configured address information for the + connection point from the resource representing the link port. + * If both "cpProtocolData" and "linkportId" are provided, the API + consumer shall ensure that the cpProtocolData can be used with the + pre-created link port referenced by "linkPortId". + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" + cpProtocolData: + description: > + Parameters for configuring the network protocols on the link port + that connects the CP to a VL. + The following conditions apply to the attributes "linkPortId" and + "cpProtocolData": + * The "linkPortId" and "cpProtocolData" attributes shall both be + absent for the deletion of an existing external CP instance + addressed by cpInstanceId. + * At least one of these attributes shall be present for a + to-be-created external CP instance or an existing external + CP instance. + * If the "linkPortId" attribute is absent, the VNFM shall create a + link port. + * If the "cpProtocolData" attribute is absent, the "linkPortId" + attribute shall be provided referencing a pre-created link port, + and the VNFM can use means outside the scope of the present + document to obtain the pre-configured address information for the + connection point from the resource representing the link port. + * If both "cpProtocolData" and "linkportId" are provided, the API + consumer shall ensure that the cpProtocolData can be used with the + pre-created link port referenced by "linkPortId". + type: array + items: + $ref: "#/definitions/CpProtocolData" + + PortRange: + description: > + The PortRange data type provides the lower and upper bounds of a range of Internet ports. + It shall comply with the provisions defined in Table 6.5.3.42-1. + type: object + required: + - lowerPort + - upperPort + properties: + lowerPort: + description: > + Identifies the lower bound of the port range. upperPort Integer + type: integer + minimum: 0 + upperPort: + description: > + Identifies the upper bound of the port range. + type: integer + minimum: 0 + + Mask: + description: > + The Mask data type identifies the value to be matched for a sequence of + bits at a particular location in a frame. It shall + comply with the provisions defined in Table 6.5.3.41-1. + type: object + required: + - startingPoint + - length + - value + properties: + startingPoint: + description: > + Indicates the offset between the last bit of the source + mac address and the first bit of the sequence of bits + to be matched. + type: integer + length: + description: > + Indicates the number of bits to be matched. + type: integer + value: + description: > + Provide the sequence of bit values to be matched. + type: string diff --git a/src/SOL005/NSLifecycleManagement/definitions/SOL005_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/SOL005_def.yaml deleted file mode 100644 index 41921fefff2c7210bad928a8588fa7b947af80d6..0000000000000000000000000000000000000000 --- a/src/SOL005/NSLifecycleManagement/definitions/SOL005_def.yaml +++ /dev/null @@ -1,616 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt -definitions: - Identifier: - description: > - An identifier with the intention of being globally unique. - type: string - - subscriptionId: - description: > - Identifier of the subscription that this notification relates to. - type: string - - nsInstanceId: - description: > - The deleted NS instance identifier. - type: string - - Link: - description: > - This type represents a link to a resource. - type: object - required: - - href - properties: - href: - description: > - URI of the referenced resource. - type: string - format: url - - DateTime: - description: > - Date-time stamp. - Representation: String formatted according to IETF RFC 3339. - type: string - format: "date-time" - - String: - description: > - This type represents stack of string values - type: string - - KeyValuePairs: - description: > - This type represents a list of key-value pairs. The order of the pairs in the list is not significant. - In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions - defined in clause 4 of IETF RFC 7159. - type: object - - IdentifierInVnfd: - description: > - Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. - type: string - - IdentifierInVnf: - description: > - An identifier that is unique for the respective type within a VNF - instance, but may not be globally unique. - type: string - - IdentifierInNsd: - description: > - An identifier that is unique within a NS descriptor. Representation: string of variable - length. - type: string - - IdentifierInPnf: - description: > - Identifier of the CP in the scope of the PNF. - type: string - - IdentifierInNs: - description: > - An identifier that is unique with respect to a NS. - Representation: string of variable length. - type: string - - MacAddress: - description: > - A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons. - type: string - format: MAC - - IpAddress: - description: > - An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal - integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that - consists of groups of zero to four hexadecimal digits, separated by colons. - type: string - format: IP - - IpAddressPrefix: - description: > - An IPV4 or IPV6 address range in CIDR format. For IPV4 address range, refer to IETF - RFC 4632 [12]. For IPV6 address range, refer to IETF RFC 4291 [11]. - type: string - format: CIDR - - IdentifierInVim: - description: > - An identifier maintained by the VIM or other resource provider. It is - expected to be unique within the VIM instance. - type: string - - ProblemDetails: - #SOL005 location: 4.3.5.3-1 - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis structure. Compared to the - general framework defined in IETF RFC 7807 [19], the "status" and - "detail" attributes are mandated to be included by the present document, - to ensure that the response contains additional textual information about - an error. IETF RFC 7807 [19] foresees extensibility of the - "ProblemDetails" type. It is possible that particular APIs in the present - document, or particular implementations, define extensions to define - additional attributes that provide more information about the error. - The description column only provides some explanation of the meaning to - Facilitate understanding of the design. For a full description, see - IETF RFC 7807 [19]. - type: object - required: - - status - - detail - properties: - type: - description: > - A URI reference according to IETF RFC 3986 [5] that identifies the - problem type. It is encouraged that the URI provides human-readable - documentation for the problem (e.g. using HTML) when dereferenced. - When this member is not present, its value is assumed to be - "about:blank". - type: string - format: URI - title: - description: > - A short, human-readable summary of the problem type. It should not - change from occurrence to occurrence of the problem, except for - purposes of localization. If type is given and other than - "about:blank", this attribute shall also be provided. - A short, human-readable summary of the problem - type. It SHOULD NOT change from occurrence to occurrence of the - problem, except for purposes of localization (e.g., using - proactive content negotiation; see [RFC7231], Section 3.4). - type: string - status: - description: > - The HTTP status code for this occurrence of the problem. - The HTTP status code ([RFC7231], Section 6) generated by the origin - server for this occurrence of the problem. - type: integer - detail: - description: > - A human-readable explanation specific to this occurrence of the - problem. - type: string - instance: - description: > - A URI reference that identifies the specific occurrence of the - problem. It may yield further information if dereferenced. - type: string - format: URI - #TODO: How to express "any additional attributes"? - - ResourceHandle: - required: - - vimConnectionId - - resourceId - type: object - description: > - This type represents the information that allows addressing a virtualised - resource that is used by a VNF instance. Information about the resource - is available from the VIM. - properties: - vimConnectionId: - description: > - Identifier of the VIM connection to manage the resource. This - attribute shall only be supported and present if VNF-related resource - management in direct mode is applicable. The applicable - "VimConnectionInfo" structure, which is referenced by - vimConnectionId, can be obtained from the "vimConnectionInfo" - attribute of the "VnfInstance" structure. - $ref: "#/definitions/Identifier" - resourceProviderId: - description: > - Identifier of the entity responsible for the management of the - resource. This attribute shall only be supported and present when - VNF-related resource management in indirect mode is applicable. The - identification scheme is outside the scope of the present document. - $ref: "#/definitions/Identifier" - resourceId: - description: > - Identifier of the resource in the scope of the VIM or the resource - provider. - $ref: "#/definitions/IdentifierInVim" - vimLevelResourceType: - description: > - Type of the resource in the scope of the VIM or the resource - provider. - type: string - #TODO: Note of Table 4.4.1.7-1 - - CpProtocolData: - description: > - This type represents network protocol data. - type: object - required: - - layerProtocol - properties: - layerProtocol: - description: > - Identifier of layer(s) and protocol(s). - Permitted values: IP_OVER_ETHERNET. - type: string - enum: - - IP_OVER_ETHERNET - ipOverEthernet: - description: > - Network address data for IP over Ethernet to - assign to the extCP instance. Shall be - present if layerProtocol is equal to - "IP_OVER_ETHERNET", and shall be absent otherwise. - $ref: "#/definitions/IpOverEthernetAddressData" - - IpOverEthernetAddressData: - description: > - This type represents network address data for IP over Ethernet. - type: object - properties: - macAddress: - description: > - MAC address. If this attribute is not present, it shall be chosen by the NFV MANO. - $ref: "#/definitions/MacAddress" - ipAddresses: - description: > - List of IP addresses to assign to the CP instance. Each entry - represents IP address data for fixed or dynamic IP address - assignment per subnet. - If this attribute is not present, no IP address shall be assigned. - type: array - items: - type: object - required: - - type - properties: - type: - description: > - The type of the IP addresses. - Permitted values: IPV4, IPV6. - type: string - enum: - - IPV4 - - IPV6 - fixedAddresses: - description: > - Fixed addresses to assign (from the subnet defined by - "subnetId" if provided). - Exactly one of "fixedAddresses", "numDynamicAddresses" or - "ipAddressRange" shall be present. - type: array - items: - $ref: "#/definitions/IpAddress" - numDynamicAddresses: - description: > - Number of dynamic addresses to assign (from the subnet defined - by "subnetId" if provided). - Exactly one of "fixedAddresses", "numDynamicAddresses" or - "ipAddressRange" shall be present. - type: integer - addressRange: - description: > - An IP address range to be used, e.g. in case of egress - connections. - In case this attribute is present, IP addresses from the range - will be used. - type: object - required: - - minAddress - - maxAddress - properties: - minAddress: - description: > - Lowest IP address belonging to the range. - $ref: "#/definitions/IpAddress" - maxAddress: - description: > - Highest IP address belonging to the range. - $ref: "#/definitions/IpAddress" - subnetId: - description: > - Subnet defined by the identifier of the subnet resource in the - VIM. - In case this attribute is present, IP addresses from that - subnet will be assigned; otherwise, IP addresses not bound to - a subnet will be assigned. - $ref: "#/definitions/IdentifierInVim" - - ExtVirtualLinkData: - description: > - This type represents an external VL. It shall comply with the provisions defined in Table 6.5.3.26-1. - type: object - required: - - resourceId - - extCps - properties: - extVirtualLinkId: - description: > - The identifier of the external VL instance, if provided. - $ref: "#/definitions/Identifier" - vimId: - description: > - Identifier of the VIM that manages this resource. This - attribute shall only be supported and present if VNFrelated - resource management in direct mode is applicable. - $ref: "#/definitions/Identifier" - resourceProviderId: - description: > - Identifies the entity responsible for the management of - this resource. - This attribute shall only be supported and present if - VNF-related resource management in indirect mode is - applicable. The identification scheme is outside the - scope of the present document. - $ref: "#/definitions/Identifier" - resourceId: - description: > - The identifier of the resource in the scope of the VIM or - the resource provider. - $ref: "#/definitions/IdentifierInVim" - extCps: - description: > - External CPs of the VNF to be connected to this external VL. - type: array - items: - $ref: "#/definitions/VnfExtCpData" - extLinkPorts: - description: > - Externally provided link ports to be used to connect - external connection points to this external VL. - type: array - items: - $ref: "#/definitions/ExtLinkPortData" - - ExtManagedVirtualLinkData: - description: > - This type represents an externally-managed internal VL. - It shall comply with the provisions defined in Table 6.5.3.27-1. - type: object - required: - - virtualLinkDescId - - resourceId - properties: - extManagedVirtualLinkId: - description: > - The identifier of the externally-managed internal VL - instance, if provided. - $ref: "#/definitions/Identifier" - vmfVirtualLinkDescId: - description: > - The identifier of the VLD in the VNFD for this VL. - $ref: "#/definitions/IdentifierInVnfd" - vimId: - description: > - Identifier of the VIM that manage this resource. This - attribute shall only be supported and present if VNFrelated - resource management in direct mode is applicable. - $ref: "#/definitions/Identifier" - resourceProviderId: - description: > - Identifies the entity responsible for the management of - this resource. This attribute shall only be supported and present if - VNF-related resource management in indirect mode is - applicable. The identification scheme is outside the - scope of the present document. - $ref: "#/definitions/Identifier" - resourceId: - description: > - The identifier of the resource in the scope of the VIM or - the resource provider. - $ref: "#/definitions/IdentifierInVim" - - VnfExtCpData: - description: > - This type represents configuration information for external CPs created - from a CPD. - type: object - required: - - cpdId - properties: - cpdId: - description: > - The identifier of the CPD in the VNFD. - $ref: "#/definitions/IdentifierInVnfd" - cpConfig: - description: > - List of instance data that need to be configured on the CP instances - created from the respective CPD. - type: array - items: - $ref: "#/definitions/VnfExtCpConfig" - - ExtLinkPortData: - description: > - This type represents an externally provided link port to be used to - connect an external connection point to an external VL. - type: object - required: - - id - - resourceHandle - properties: - id: - description: > - Identifier of this link port as provided by the entity that has - created the link port. - $ref: "#/definitions/Identifier" - resourceHandle: - description: > - Reference to the virtualised resource realizing this link port. - $ref: "#/definitions/ResourceHandle" - - VnfExtCpConfig: - description: > - This type represents an externally provided link port or network address - information per instance of an external connection point. In case a link - port is provided, the VNFM shall use that link port when connecting the - external CP to the external VL. In a link port is not provided, the VNFM - shall create a link port on the external VL, and use that link port to - connect the external CP to the external VL. - type: object - properties: - cpInstanceId: - description: > - Identifier of the external CP instance to which this set of - configuration parameters is requested to be applied. - Shall be present if this instance has already been created. - $ref: "#/definitions/IdentifierInVnf" - linkPortId: - description: > - Identifier of a pre-configured link port to which the external CP - will be associated. - The following conditions apply to the attributes "linkPortId" and - "cpProtocolData": - * The "linkPortId" and "cpProtocolData" attributes shall both be - absent for the deletion of an existing external CP instance - addressed by cpInstanceId. - * At least one of these attributes shall be present for a - to-be-created external CP instance or an existing external - CP instance. - * If the "linkPortId" attribute is absent, the VNFM shall create a - link port. - * If the "cpProtocolData" attribute is absent, the "linkPortId" - attribute shall be provided referencing a pre-created link port, - and the VNFM can use means outside the scope of the present - document to obtain the pre-configured address information for the - connection point from the resource representing the link port. - * If both "cpProtocolData" and "linkportId" are provided, the API - consumer shall ensure that the cpProtocolData can be used with the - pre-created link port referenced by "linkPortId". - $ref: "#/definitions/Identifier" - cpProtocolData: - description: > - Parameters for configuring the network protocols on the link port - that connects the CP to a VL. - The following conditions apply to the attributes "linkPortId" and - "cpProtocolData": - * The "linkPortId" and "cpProtocolData" attributes shall both be - absent for the deletion of an existing external CP instance - addressed by cpInstanceId. - * At least one of these attributes shall be present for a - to-be-created external CP instance or an existing external - CP instance. - * If the "linkPortId" attribute is absent, the VNFM shall create a - link port. - * If the "cpProtocolData" attribute is absent, the "linkPortId" - attribute shall be provided referencing a pre-created link port, - and the VNFM can use means outside the scope of the present - document to obtain the pre-configured address information for the - connection point from the resource representing the link port. - * If both "cpProtocolData" and "linkportId" are provided, the API - consumer shall ensure that the cpProtocolData can be used with the - pre-created link port referenced by "linkPortId". - type: array - items: - $ref: "#/definitions/CpProtocolData" - - PortRange: - description: > - The PortRange data type provides the lower and upper bounds of a range of Internet ports. - It shall comply with the provisions defined in Table 6.5.3.42-1. - type: object - required: - - lowerPort - - upperPort - properties: - lowerPort: - description: > - Identifies the lower bound of the port range. upperPort Integer - type: integer - minimum: 0 - upperPort: - description: > - Identifies the upper bound of the port range. - type: integer - minimum: 0 - - Mask: - description: > - The Mask data type identifies the value to be matched for a sequence of - bits at a particular location in a frame. It shall - comply with the provisions defined in Table 6.5.3.41-1. - type: object - required: - - startingPoint - - length - - value - properties: - startingPoint: - description: > - Indicates the offset between the last bit of the source - mac address and the first bit of the sequence of bits - to be matched. - type: integer - length: - description: > - Indicates the number of bits to be matched. - type: integer - value: - description: > - Provide the sequence of bit values to be matched. - type: string - - Uri: - description: > - String formatted according to IETF RFC 3986. - type: string - - SubscriptionAuthentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which the API - consumer is willing to accept when receiving a notification. - Permitted values: - * BASIC: In every HTTP request to the notification endpoint, use - HTTP Basic authentication with the client credentials. - * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the - notification endpoint, use an OAuth 2.0 Bearer token, obtained - using the client credentials grant type. - * TLS_CERT: Every HTTP request to the notification endpoint is sent - over a mutually authenticated TLS session, i.e. not only the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - description: > - Parameters for authentication/authorization using BASIC. - Shall be present if authType is "BASIC" and the contained - information has not been provisioned out of band. - Shall be absent otherwise. - type: object - properties: - userName: - description: > - Username to be used in HTTP Basic authentication. Shall be - present if it has not been provisioned out of band. - type: string - password: - description: > - Password to be used in HTTP Basic authentication. Shall be - present if it has not been provisioned out of band. - type: string - paramsOauth2ClientCredentials: - description: > - Parameters for authentication/authorization using - OAUTH2_CLIENT_CREDENTIALS. - Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the - contained information has not been provisioned out of band. - Shall be absent otherwise. - type: object - properties: - clientId: - description: > - Client identifier to be used in the access token request of the - OAuth 2.0 client credentials grant type. - Shall be present if it has not been provisioned out of band. - The clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are used - to obtain authorization for API requests. Client credentials may - differ between subscriptions. The value of clientPassword should - be generated by a random process. - type: string - clientPassword: - description: > - Client password to be used in the access token request of the - OAuth 2.0 client credentials grant type. - Shall be present if it has not been provisioned out of band. - The clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are used - to obtain authorization for API requests. Client credentials may - differ between subscriptions. The value of clientPassword should - be generated by a random process. - type: string - tokenEndpoint: - description: > - The token endpoint from which the access token can be obtained. - Shall be present if it has not been provisioned out of band. - $ref: "#/definitions/Uri" diff --git a/src/SOL005/NSLifecycleManagement/responses/SOL005NSLifecycleManagement_resp.yaml b/src/SOL005/NSLifecycleManagement/responses/SOL005NSLifecycleManagement_resp.yaml deleted file mode 100644 index 384bebb3e4cd531498e629758f5abfc24c99fee0..0000000000000000000000000000000000000000 --- a/src/SOL005/NSLifecycleManagement/responses/SOL005NSLifecycleManagement_resp.yaml +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt -responses: - 202-with-Location: - description: > - 202 ACCEPTED - - The request was accepted for processing, but the processing has not - been completed. - - The response body shall be empty. - - The HTTP response shall include a "Location" HTTP - header that contains the URI of the newly-created - "NS lifecycle operation occurrence" resource - corresponding to the operation. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created NS instance - type: string - format: url - 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 - schema: - $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" - - 202-with-Location-empty: - description: > - 202 ACCEPTED - - The request was accepted for processing, but the processing has not - been completed. On success, the HTTP response shall include a - "Location" HTTP header that contains the URI of the newly-created - "NS LCM operation occurrence" resource corresponding to the - operation. - The response body shall be empty. - headers: - Location: - description: The resource URI of the created NS instance - type: string - format: url - 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 \ No newline at end of file diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 84dcca6067b8adfe3d3ee9abc1865b36c5ecdebd..71c0da27857f72f37bbcdf0005e9f5b461a535e3 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -27,11 +27,31 @@ consumes: produces: - application/json paths: + ############################################################################### + # API Versions # + ############################################################################### + '/api-versions': + $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' + ############################################################################### # VNF Packages # ############################################################################### '/vnf_packages': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Query VNF packages information. description: > @@ -93,13 +113,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 200: description: > @@ -120,6 +133,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -157,13 +176,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -209,7 +221,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 - + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 ############################################################################### # Individual VNF Package # ############################################################################### @@ -222,6 +239,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read information about an individual VNF package. description: > @@ -234,13 +264,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 200: description: > @@ -263,6 +286,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -286,14 +315,6 @@ paths: summary: Delete an individual VNF package. description: > The DELETE method deletes an individual VNF Package resource. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 204: description: > @@ -301,6 +322,13 @@ paths: The VNF package was deleted successfully. The response body shall be empty. + headers: + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 409: $ref: "../responses/SOL005_resp.yaml#/responses/409" 400: @@ -338,13 +366,6 @@ paths: $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications" description: > Parameters for VNF package information modifications. - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -375,6 +396,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 schema: properties: VnfPkgInfoModifications: @@ -406,6 +433,19 @@ paths: '/vnf_packages/{vnfPkgId}/vnfd': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4 parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string - name: vnfPkgId description: > Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO. @@ -442,13 +482,6 @@ paths: enum: - text/plain - application/zip - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 200: description: > @@ -476,6 +509,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -503,6 +542,19 @@ paths: '/vnf_packages/{vnfPkgId}/package_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5 parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string - name: vnfPkgId description: > Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO. @@ -524,13 +576,6 @@ paths: type: string enum: - application/zip - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Range in: header required: false @@ -567,6 +612,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 206: $ref: "../responses/SOL005_resp.yaml#/responses/206" 409: @@ -608,13 +659,6 @@ paths: type: string enum: - application/zip - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - in: formData name: file required: false @@ -633,6 +677,13 @@ paths: processing has not been completed. It is expected to take some time for processing. The response body shall be empty. + headers: + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 409: description: > $ref: "../responses/SOL005_resp.yaml#/responses/409" @@ -680,6 +731,12 @@ paths: in: header required: false type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string - name: vnfPkgId description: > Identifier of the VNF package. The identifier is allocated by the NFVO. @@ -703,6 +760,13 @@ paths: successfully, but the on-boarding has not been completed. It is expected to take some time for processing. The response body shall be empty. + headers: + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 409: $ref: "../responses/SOL005_resp.yaml#/responses/409" 400: @@ -746,6 +810,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Fetch individual VNF package artifact. description: > @@ -760,13 +837,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Range description: > The request may contain a "Range" HTTP header to obtain single @@ -801,6 +871,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 206: description: > Partial Content. @@ -857,6 +933,20 @@ paths: ############################################################################### '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8 + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string post: summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages. description: > @@ -877,13 +967,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -922,6 +1005,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -972,13 +1061,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 200: description: > @@ -999,6 +1081,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -1038,6 +1126,19 @@ paths: in: path type: string required: true + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235. + in: header + required: false + type: string + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + type: string get: summary: Read an individual subscription resource. description: > @@ -1051,13 +1152,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 200: description: > @@ -1078,6 +1172,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 schema: $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" 400: @@ -1102,14 +1202,6 @@ paths: summary: Terminate a subscription. description: > The DELETE method terminates an individual subscription. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string responses: 204: description: > @@ -1125,6 +1217,12 @@ paths: has provided an invalid authorization token. maximum: 1 minimum: 0 + Version: + description: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: diff --git a/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml b/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml index 32a6ac618c4b3c2c5af34e3a63a57beff55944bf..0a55d1de5ecad17871daf65105311d6305a502e0 100644 --- a/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml +++ b/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml @@ -10,14 +10,14 @@ definitions: id: description: > Identifier of the VNF package. This identifier is allocated by the NFVO. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfdId: description: > This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way. It is copied from the VNFD of the on boarded VNF package. It shall be present after the VNF package content has been on-boarded and absent otherwise. - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfProvider: description: > Provider of the VNF package and the VNFD. This information is copied from the VNFD. @@ -37,20 +37,20 @@ definitions: This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. - $ref: "SOL005_def.yaml#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" vnfdVersion: description: > The version of the VNFD. This information is copied from the VNFD. It shall be present after the VNF package content has been on-boarded and absent otherwise. - $ref: "SOL005_def.yaml#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" checksum: description: > Checksum of the on-boarded VNF package. It shall be present after the VNF package content has been on-boarded and absent otherwise. - $ref: "SOL005_def.yaml#/definitions/Checksum" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" softwareImages: description: > Information about VNF package artifacts that are software images. @@ -86,7 +86,7 @@ definitions: userDefinedData: description: > Usage state of the VNF package. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" _links: type: object description: > @@ -98,17 +98,17 @@ definitions: self: description: > URI of this resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" vnfd: description: > Link to the VNFD resource. This link shall be present after the VNF package content is on-boarded. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" packageContent: description: > Link to the "VNF package content" resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" VnfPackageArtifactInfo: description: > @@ -123,16 +123,16 @@ definitions: description: > Path in the VNF package, which identifies the artifact and also allows to access a copy of the artifact. - $ref: "SOL005_def.yaml#/definitions/String" + $ref: "../../definitions/SOL005_def.yaml#/definitions/String" checksum: description: > Checksum of the artifact file. - $ref: "SOL005_def.yaml#/definitions/Checksum" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" metadata: description: > The metadata of the artifact that are available in the VNF package, such as Content type, size, creation date, etc. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" PkgmLinks: description: > @@ -175,7 +175,7 @@ definitions: description: > Name of the algorithm used to generate the checksum, as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512. - $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" + $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd" name: description: > Name of the software image. @@ -187,11 +187,11 @@ definitions: version: description: > Version of the software image. - $ref: "SOL005_def.yaml#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" checksum: description: > Checksum of the software image file. - $ref: "SOL005_def.yaml#/definitions/Checksum" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum" containerFormat: description: > Container format indicates whether the software image @@ -245,7 +245,7 @@ definitions: createdAt: description: > Time when this software image was created. - $ref: "SOL005_def.yaml#/definitions/DateTime" + $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime" minDisk: description: > The minimal disk for this software image in bytes. @@ -264,7 +264,7 @@ definitions: userMetadata: description: > User-defined data. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" imagePath: description: > Path in the VNF package, which identifies the image @@ -323,7 +323,7 @@ definitions: type: "object" properties: userDefinedData: - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" description: > IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2. @@ -340,13 +340,13 @@ definitions: userDefinedData: description: > User defined data to be updated. For existing keys, the value is replaced. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" UploadVnfPkgFromUriRequest: type: "object" properties: userDefinedData: - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" description: > "The payload body contains the address information based on which the NFVO can obtain the content of the VNF package" @@ -363,7 +363,7 @@ definitions: id: description: > Identifier of this subscription resource - $ref: "SOL005_def.yaml#/definitions/Uri" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" filter: description: > Filter settings for this subscription, to define the subset @@ -374,7 +374,7 @@ definitions: callbackUri: description: > The URI of the endpoint to send the notification to - $ref: "SOL005_def.yaml#/definitions/Uri" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" _links: description: > Links to resources related to this resource. @@ -385,7 +385,7 @@ definitions: self: description: > URI of this resource. - $ref: "SOL005_def.yaml#/definitions/Link" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Link" PkgmSubscriptionRequest: description: > @@ -405,7 +405,7 @@ definitions: callbackUri: description: > The URI of the endpoint to send the notification to. - $ref: "SOL005_def.yaml#/definitions/Uri" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" authentication: description: > Authentication parameters to conFigure the use of @@ -413,7 +413,7 @@ definitions: to this subscription, as defined in clause 4.5.3.4. This attribute shall only be present if the subscriber requires authorization of notifications. - $ref: "SOL005_def.yaml#/definitions/SubscriptionAuthentication" + $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" PkgmNotificationsFilter: description: > @@ -477,7 +477,7 @@ definitions: vnfSoftwareVersion: description: > VNF software version to match - $ref: "SOL005_def.yaml#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" vnfdVersions: description: > If present, match VNF packages that contain @@ -486,7 +486,7 @@ definitions: name, from one particular provider. type: array items: - $ref: "SOL005_def.yaml#/definitions/Version" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Version" vnfdId: description: > @@ -494,7 +494,7 @@ definitions: listed in the attribute. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" vnfPkgId: description: > Match VNF packages with a package identifier @@ -505,7 +505,7 @@ definitions: absent otherwise. type: array items: - $ref: "SOL005_def.yaml#/definitions/Identifier" + $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" operationalState: description: > Match VNF packages with a package identifier diff --git a/src/SOL005/VNFPackageManagement/definitions/SOL005_def.yaml b/src/SOL005/VNFPackageManagement/definitions/SOL005_def.yaml deleted file mode 100644 index 6e332420ad030e39de989324b0db5fd6bb79b93d..0000000000000000000000000000000000000000 --- a/src/SOL005/VNFPackageManagement/definitions/SOL005_def.yaml +++ /dev/null @@ -1,214 +0,0 @@ -definitions: - Identifier: - description: > - An identifier with the intention of being globally unique. - type: string - - Link: - description: > - This type represents a link to a resource. - type: object - required: - - href - properties: - href: - description: > - URI of the referenced resource. - type: string - format: url - - DateTime: - description: > - Date-time stamp. - Representation: String formatted according to IETF RFC 3339. - type: string - format: "date-time" - - String: - description: > - This type represents stack of string values - type: string - - Object: - description: > - This type represents stack of object values - type: object - - KeyValuePairs: - description: > - This type represents a list of key-value pairs. The order of the pairs in the list is not significant. - In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions - defined in clause 4 of IETF RFC 7159. - type: object - - ProblemDetails: - description: > - The definition of the general "ProblemDetails" data structure from - IETF RFC 7807 [19] is reproduced inthis structure. Compared to the - general framework defined in IETF RFC 7807 [19], the "status" and - "detail" attributes are mandated to be included by the present document, - to ensure that the response contains additional textual information about - an error. IETF RFC 7807 [19] foresees extensibility of the - "ProblemDetails" type. It is possible that particular APIs in the present - document, or particular implementations, define extensions to define - additional attributes that provide more information about the error. - The description column only provides some explanation of the meaning to - Facilitate understanding of the design. For a full description, see - IETF RFC 7807 [19]. - type: object - required: - - status - - detail - properties: - type: - description: > - A URI reference according to IETF RFC 3986 [5] that identifies the - problem type. It is encouraged that the URI provides human-readable - documentation for the problem (e.g. using HTML) when dereferenced. - When this member is not present, its value is assumed to be - "about:blank". - type: string - format: URI - title: - description: > - A short, human-readable summary of the problem type. It should not - change from occurrence to occurrence of the problem, except for - purposes of localization. If type is given and other than - "about:blank", this attribute shall also be provided. - A short, human-readable summary of the problem - type. It SHOULD NOT change from occurrence to occurrence of the - problem, except for purposes of localization (e.g., using - proactive content negotiation; see [RFC7231], Section 3.4). - type: string - status: - description: > - The HTTP status code for this occurrence of the problem. - The HTTP status code ([RFC7231], Section 6) generated by the origin - server for this occurrence of the problem. - type: integer - detail: - description: > - A human-readable explanation specific to this occurrence of the - problem. - type: string - instance: - description: > - A URI reference that identifies the specific occurrence of the - problem. It may yield further information if dereferenced. - type: string - format: URI - IdentifierInVnfd: - description: > - Identifier of the software image. - type: string - Uri: - description: > - String formatted according to IETF RFC 3986. - type: string - Version: - description: > - Software version of the VNF. This is - changed when there is any change to the - software included in the VNF package. - This information is copied from the VNFD. - It shall be present after the VNF package - content has been on-boarded and absent otherwise. - type: string - Checksum: - description: > - This type represents the checksum of a VNF package or an artifact file. - required: - - algorithm - - hash - type: object - properties: - algorithm: - description: > - Name of the algorithm used to generate the checksum, - as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512. - type: string - hash: - description: > - The hexadecimal value of the checksum. - type: string - - SubscriptionAuthentication: - type: object - required: - - authType - properties: - authType: - description: > - Defines the types of Authentication / Authorization which the API - consumer is willing to accept when receiving a notification. - Permitted values: - * BASIC: In every HTTP request to the notification endpoint, use - HTTP Basic authentication with the client credentials. - * OAUTH2_CLIENT_CREDENTIALS: In every HTTP request to the - notification endpoint, use an OAuth 2.0 Bearer token, obtained - using the client credentials grant type. - * TLS_CERT: Every HTTP request to the notification endpoint is sent - over a mutually authenticated TLS session, i.e. not only the - server is authenticated, but also the client is authenticated - during the TLS tunnel setup. - type: array - items: - type: string - enum: - - BASIC - - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT - paramsBasic: - description: > - Parameters for authentication/authorization using BASIC. - Shall be present if authType is "BASIC" and the contained - information has not been provisioned out of band. - Shall be absent otherwise. - type: object - properties: - userName: - description: > - Username to be used in HTTP Basic authentication. Shall be - present if it has not been provisioned out of band. - type: string - password: - description: > - Password to be used in HTTP Basic authentication. Shall be - present if it has not been provisioned out of band. - type: string - paramsOauth2ClientCredentials: - description: > - Parameters for authentication/authorization using - OAUTH2_CLIENT_CREDENTIALS. - Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the - contained information has not been provisioned out of band. - Shall be absent otherwise. - type: object - properties: - clientId: - description: > - Client identifier to be used in the access token request of the - OAuth 2.0 client credentials grant type. - Shall be present if it has not been provisioned out of band. - The clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are used - to obtain authorization for API requests. Client credentials may - differ between subscriptions. The value of clientPassword should - be generated by a random process. - type: string - clientPassword: - description: > - Client password to be used in the access token request of the - OAuth 2.0 client credentials grant type. - Shall be present if it has not been provisioned out of band. - The clientId and clientPassword passed in a subscription shall - not be the same as the clientId and clientPassword that are used - to obtain authorization for API requests. Client credentials may - differ between subscriptions. The value of clientPassword should - be generated by a random process. - type: string - tokenEndpoint: - description: > - The token endpoint from which the access token can be obtained. - Shall be present if it has not been provisioned out of band. - $ref: "#/definitions/Uri" \ No newline at end of file diff --git a/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml b/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml deleted file mode 100644 index e0f6fb3be4f4fd0c18eaf8d3b6ff53fd7cc851ae..0000000000000000000000000000000000000000 --- a/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml +++ /dev/null @@ -1,291 +0,0 @@ -# Copyright (c) ETSI 2017. -# https://forge.etsi.org/etsi-forge-copyright-notice.txt -responses: - 202-with-Location: - description: > - Accepted - - The request was accepted for processing, but the processing has not - been completed. The response body shall be empty. - The HTTP response shall include a "Location" HTTP - header that contains the URI of the newly-created - "NS lifecycle operation occurrence" resource - corresponding to the operation. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created NS instance - type: string - format: url - 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 - schema: - $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" - 202-with-Location-empty: - description: > - Accepted - - The request was accepted for processing, but the processing has not - been completed. On success, the HTTP response shall include a - "Location" HTTP header that contains the URI of the newly-created - "NS Descriptor operation occurrence" resource corresponding to the - operation. - The response body shall be empty. - headers: - Location: - description: The resource URI of the created NS instance - type: string - format: url - 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 - 406-state-conflict: - description: > - Error: The operation cannot be executed currently, - due to a conflict with the state of the resource. - Typically, this is due to the fact that - "onboardingState" of the VNF package has a value - different from "ONBOARDED". - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall convey - more information about the error. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409: - description: > - Conflict. - - Error: The operation cannot be executed - currently, due to a conflict with the state of - the resource. - Typically, this is due to any of the following - scenarios: - - Disable a VNF package resource of - hich the operational state is not - ENABLED - - Enable a VNF package resource of - which the operational state is not - DISABLED - The response body shall contain a - ProblemDetails structure, in which the - "detail" attribute shall 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - - 409-another-nsd-operation-ongoing: - description: > - Conflict. - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that another Descriptor operation is - ongoing. - 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-inconsistent-state: - 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 - 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-INSTANTIATED: - description: > - Conflict. - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is in - INSTANTIATED state. - 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-not-FAILED_TEMP: - description: > - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is - not in FAILED_TEMP state, or another error handling action is starting, - such as rollback or fail. - 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-NOT-INSTANTIATED: - description: > - Conflict. - - The operation cannot be executed currently, due to a conflict with the - state of the NS instance resource. - Typically, this is due to the fact that the NS instance resource is in - NOT-INSTANTIATED state, or that another lifecycle management operation - is ongoing. - 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-ONBOARDING: - description: > - Conflict. - - Error: The operation cannot be executed currently, - due to a conflict with the state of the resource. - Typically, this is due to the fact that "onboardingState" - of the VNF package has a value different from "ONBOARDED". - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall convey - more information about the error. - headers: - Content-Type: - description: 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" - 409-state-conflict-ONBOARDING-NOT-CREATED: - description: > - Conflict. - - Error: The operation cannot be executed currently, - due to a conflict with the state of the resource. - Typically, this is due to the fact that the on boarding - state of the VNF package resource is not CREATED . - The response body shall contain a ProblemDetails - structure, in which the "detail" attribute shall 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 - schema: - $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" \ No newline at end of file diff --git a/src/SOL005/definitions/SOL005_def.yaml b/src/SOL005/definitions/SOL005_def.yaml index b5709eb0fe20e96a84990bb83cee13671d4b351e..ec6622e7cedceaa3f7a13f33aff9f0235786c75b 100644 --- a/src/SOL005/definitions/SOL005_def.yaml +++ b/src/SOL005/definitions/SOL005_def.yaml @@ -27,6 +27,17 @@ definitions: It is expected to be unique within the VIM instance. Representation: string of variable length. type: string + IdentifierInVnfd: + description: > + Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. + type: string + + IdentifierInVnf: + description: > + An identifier that is unique for the respective type within a VNF + instance, but may not be globally unique. + type: string + DateTime: description: > Date-time stamp. diff --git a/src/SOL005/responses/SOL005_resp.yaml b/src/SOL005/responses/SOL005_resp.yaml index f48f3c81c9ad8945f34e45fe85cb80b2bd04cef8..d7ec415f796488b63d71fdb545948651da9734ff 100644 --- a/src/SOL005/responses/SOL005_resp.yaml +++ b/src/SOL005/responses/SOL005_resp.yaml @@ -2,6 +2,73 @@ # https://forge.etsi.org/etsi-forge-copyright-notice.txt responses: + + 202-with-Location: + description: > + 202 ACCEPTED + + The request was accepted for processing, but the processing has not + been completed. The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS lifecycle operation occurrence" resource + corresponding to the operation. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Location: + description: The resource URI of the created NS instance + type: string + format: url + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" + 202-with-Location-empty: + description: > + 202 ACCEPTED + + The request was accepted for processing, but the processing has not + been completed. On success, the HTTP response shall include a + "Location" HTTP header that contains the URI of the newly-created + "NS Descriptor operation occurrence" resource corresponding to the + operation. + The response body shall be empty. + headers: + Location: + description: The resource URI of the created NS instance + type: string + format: url + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + 206: description: > 206 PARTIAL CONTENT @@ -262,9 +329,284 @@ responses: schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 406-state-conflict: + description: > + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that + "onboardingState" of the VNF package has a value + different from "ONBOARDED". + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + Content-Type: + description: 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409: description: > 409 CONFLICT + + Error: The operation cannot be executed + currently, due to a conflict with the state of + the resource. + Typically, this is due to any of the following + scenarios: + - Disable a VNF package resource of + hich the operational state is not + ENABLED + - Enable a VNF package resource of + which the operational state is not + DISABLED + The response body shall contain a + ProblemDetails structure, in which the + "detail" attribute shall 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + + 409-another-nsd-operation-ongoing: + description: > + 409 CONFLICT + + The operation cannot be executed currently, due to a conflict with the + state of the NS instance resource. + Typically, this is due to the fact that another Descriptor operation is + ongoing. + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-inconsistent-state: + description: > + 409 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 + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-state-conflict-INSTANTIATED: + description: > + 409 CONFLICT + + The operation cannot be executed currently, due to a conflict with the + state of the NS instance resource. + Typically, this is due to the fact that the NS instance resource is in + INSTANTIATED state. + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-state-conflict-not-FAILED_TEMP: + description: > + 409 CONFLICT + + The operation cannot be executed currently, due to a conflict with the + state of the NS instance resource. + Typically, this is due to the fact that the NS instance resource is + not in FAILED_TEMP state, or another error handling action is starting, + such as rollback or fail. + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-state-conflict-NOT-INSTANTIATED: + description: > + 409 CONFLICT + + The operation cannot be executed currently, due to a conflict with the + state of the NS instance resource. + Typically, this is due to the fact that the NS instance resource is in + NOT-INSTANTIATED state, or that another lifecycle management operation + is ongoing. + 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-state-conflict-ONBOARDING: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that "onboardingState" + of the VNF package has a value different from "ONBOARDED". + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. + headers: + Content-Type: + description: 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: > + Version of the API used in the response. + type: string + maximum: 1 + minimum: 1 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-state-conflict-ONBOARDING-NOT-CREATED: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the on boarding + state of the VNF package resource is not CREATED . + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. headers: Content-Type: description: The MIME type of the body of the response. @@ -321,7 +663,7 @@ responses: 413: description: > - PAYLOAD TOO LARGE + 413 PAYLOAD TOO LARGE If the payload body of a request is larger than the amount of data the API producer is willing or able to process, it shall respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted.