diff --git a/src/SOL005/APIVersion/APIVersion.yaml b/src/SOL005/APIVersion/APIVersion.yaml index d819757d961c0fdcf9a898cffe6ed4db872325bf..e5024d0b0a241cfcecef99bb67947d6c981e9c50 100644 --- a/src/SOL005/APIVersion/APIVersion.yaml +++ b/src/SOL005/APIVersion/APIVersion.yaml @@ -1,6 +1,6 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - API version interface" description: > SOL005 - API version Interface diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index 83cfa557ddd25dba5ad8a95b95a219f723f00f9c..e75e067f9fceec39189089c91bdc33c5b8ecea70 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NSD Management Interface" description: > SOL005 - NSD Management Interface diff --git a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml index b03d998de8a28d951f80ea6b2017a035180ce1dd..2825e2fe8a0254694eeaa4f7fc700777db540c22 100644 --- a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml +++ b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: SOL005 - NSD Management Notification interface description: > SOL005 - NSD Management Notification interface diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index 724f7a3ef09621481cfbe936c72dbfee5d7fcd2d..49f3b3037ce5728faf52b074e143b11900674e9f 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Fault Management Interface" description: > SOL005 - NS Fault Management Interface diff --git a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml index 5e49c2f59a29988d998daf05f06e3cf217b662a2..b35a94824506d2913510f8d562fa8d43d23c5ee8 100644 --- a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml +++ b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Fault Management Notification interface" description: > SOL005 - NS Fault Management Notification interface diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index adcbad9407298d04acc6a0971cb0ca9cbebeff6b..205af6488c2bf04d1466c6d0758eadd725bc69cb 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Lifecycle Management Interface" description: > SOL005 - NS Lifecycle Management Interface @@ -939,7 +939,7 @@ paths: items: properties: NsLcmOpOcc: - $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc" + $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1294,7 +1294,7 @@ paths: The response shall include a representation of the NS lifecycle management operation occurrence resource. schema: - $ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc" + $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc" headers: Content-Type: type: string diff --git a/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml index 58131062a8db8369af3d0831ca7490db5a5719ff..524e737b6745317f5198d8089b1300005ef67e14 100644 --- a/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml +++ b/src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml @@ -36,26 +36,6 @@ definitions: Cancellation mode to apply. $ref: "#/definitions/CancelModeType" - CancelModeType: - description: > - Cancellation mode. - - The NFVO shall not start any new VNF lifecycle management and resource - management operation, and shall wait for the ongoing VNF lifecycle management - and resource management operations in the underlying system, typically the VNFM - and VIM, to finish execution or to time out. After that, the NFVO shall put the - operation occurrence into the FAILED_TEMP state. - - The NFVO shall not start any new VNF lifecycle management and resource - management operation, shall cancel the ongoing VNF lifecycle management and - resource management operations in the underlying system, typically the VNFM and - VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO - shall put the operation occurrence into the FAILED_TEMP state. - type: string - enum: - - GRACEFUL - - FORCEFUL - HealNsData: description: > This type represents the information used to heal a NS. diff --git a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml index 6d7788761d2a5447ca73ec668b8de035c5ef849c..2308cd93232cd8c7502ad8257b3220fe20a5c146 100644 --- a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +++ b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml @@ -22,6 +22,26 @@ definitions: Human-readable description of the NS instance to be created. type: string + CancelModeType: + description: > + Cancellation mode. + + The NFVO shall not start any new VNF lifecycle management and resource + management operation, and shall wait for the ongoing VNF lifecycle management + and resource management operations in the underlying system, typically the VNFM + and VIM, to finish execution or to time out. After that, the NFVO shall put the + operation occurrence into the FAILED_TEMP state. + + The NFVO shall not start any new VNF lifecycle management and resource + management operation, shall cancel the ongoing VNF lifecycle management and + resource management operations in the underlying system, typically the VNFM and + VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO + shall put the operation occurrence into the FAILED_TEMP state. + type: string + enum: + - GRACEFUL + - FORCEFUL + NsInstance: description: > This type represents a response for Query NS operation. @@ -389,17 +409,17 @@ definitions: description: > Link to the resource representing the NS instance to which the notified change applies.. - $ref: "SOL005_def.yaml#/definitions/NotificationLink" + $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink" subscription: description: > Link to the subscription that triggered this notification. - $ref: "SOL005_def.yaml#/definitions/NotificationLink" + $ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink" nslcmOpOcc: description: > Link to the lifecycle operation occurrence that this notification is related to. Shall be present if there is a related lifecycle operation occurrence - $ref: "SOL005_def.yaml#/definitions/NotificationLink" + $ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink" Version: description: > @@ -781,7 +801,7 @@ definitions: type: array minItems: 1 items: - $ref: "SOL005_def.yaml#/definitions/CpProtocolInfo" + $ref: "#/definitions/CpProtocolInfo" extLinkPortId: description: > Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" @@ -844,7 +864,7 @@ definitions: a load balancing algorithm and criteria). $ref: "#/definitions/ForwardingBehaviourInputParameters" - cpPairInfo: + CpPairInfo: description: > This type represents describes a pair of ingress and egress CPs or SAPs which the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1. @@ -3676,7 +3696,7 @@ definitions: "operationState" was "FAILED_TEMP", this attribute shall be present and contain error information, unless it has been requested to be excluded via an attribute selector. - $ref: "#/definitions/ProblemDetails" + $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" resourceChanges: description: > This attribute contains information about the cumulative diff --git a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml index 0efb232cff8fc058f648fd5d4ebacd6efb711657..8e24b87438872b3fa4d70d5a4559c76cddb618c6 100644 --- a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml +++ b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Lifecycle Management Notification interface" description: > SOL005 - NS Lifecycle Management Notification interface diff --git a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml index d80dd60aa919826e3e88d3d86fa86ec47181f131..c01b86b1165e614fc55c79b370eab1e9c474d6ee 100644 --- a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Performance Management Interface" description: > SOL005 - NS Performance Management Interface diff --git a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml index 61766ca6cf4111f930303fe2087ac9db84fc7138..02d1d581ff7baeccaba2aff4b7ddddef02f7779a 100644 --- a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml +++ b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - NS Performance Management Notification interface" description: > SOL005 - NS Performance Management Notification interface diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 9fe64b30682d0b36d93a012133fc69292d4dd8ae..3e9a25991034b942446e6e03bf94faee2af0553f 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -1,8 +1,8 @@ swagger: "2.0" info: - version: "1.2.0" - title: "SOL005 - VNF Package Management Interface" + version: "1.1.0" + title: SOL005 - VNF Package Management Interface description: > SOL005 - VNF Package Management Interface IMPORTANT: Please note that this file might be not aligned to the current @@ -13,75 +13,68 @@ info: license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: + contact: name: "NFV-SOL WG" externalDocs: - description: ETSI GS NFV-SOL 005 V2.5.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf -basePath: /vnfpkgm/v1 + description: ETSI GS NFV-SOL 005 V2.4.1 + url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf +basePath: "/vnfpkgm/v1" schemes: - - http - https consumes: - - application/json + - "application/json" produces: - - application/json + - "application/json" paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api-versions': - $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions' - - ############################################################################### - # VNF Packages # - ############################################################################### +############################################################################### +# VNF Packages # +############################################################################### '/vnf_packages': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.2 get: summary: Query VNF packages information. - description: > + description: > The GET method queries the information of the VNF packages matching the filter. This method shall follow the provisions specified in the Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: filter - in: query + - name: "filter" + in: "query" required: false - type: string - description: > - Attribute-based filtering expression according to clause 4.3.2. - The NFVO shall support receiving this parameter as part of the URI query string. The - OSS/BSS may supply this parameter. + type: "string" + description: > + Attribute-based filtering parameters according to clause 4.3.2. + The NFVO shall support receiving filtering parameters as part of the URI query string. The + OSS/BSS may supply filtering parameters. All attribute names that appear in the VnfPkgInfo and in data types referenced from it shall - be supported by the NFVO in the filter expression. - - name: all_fields - in: query + be supported in attribute-based filtering parameters. + - name: "all_fields" + in: "query" required: false - type: string - description: > + type: "string" + description: > Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO shall support this parameter. - - name: fields - in: query + - name: "fields" + in: "query" required: false - type: string - description: > + type: "string" + description: > Complex attributes to be included into the response. See clause 4.3.3 for details. The NFVO should support this parameter. - - name: exclude_fields - in: query + - name: "exclude_fields" + in: "query" required: false - type: string - description: > + type: "string" + description: > Complex attributes to be excluded from the response. See clause 4.3.3 for details. The NFVO should support this parameter. - - name: exclude_default - in: query + - name: "exclude_default" + in: "query" required: false - type: string - description: > + type: "string" + description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The NFVO shall support this parameter. @@ -92,13 +85,6 @@ paths: - additionalArtifacts - userDefinedData - checksum - - name: nextpage_opaque_marker - in: query - description: > - Marker to obtain the next page of a paged response. Shall be supported by the NFVO - if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. - required: false - type: string - name: Accept description: > Content-Types that are acceptable for the response. @@ -112,51 +98,27 @@ paths: 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 + type: string responses: 200: description: > 200 OK - - Information about zero or more VNF packages was successfully queried. - The response body shall contain in an array the VNF package info - representations that match the attribute filter, i.e., zero or more - VNF package info representations as defined in clause 9.5.2.5. - If the NFVO supports alternative 2 (paging) according to - clause 4.7.2.1 for this resource, inclusion of the Link HTTP header - in this response shall follow the provisions in clause 4.7.2.3. + + Information of the selected VNF packages. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 - WWW-Authenticate: - type: string + WWW-Authenticate: + type: "string" 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. maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - Link: - description: > - Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. - type: string - maximum: 1 - minimum: 0 + minimum: 0 schema: type: array items: @@ -184,48 +146,48 @@ paths: post: summary: Create a new individual VNF package resource. - description: > + description: > The POST method creates a new individual VNF package resource. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - 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. - Reference: IETF RFC 7231 - 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 - schema: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest" + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + 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. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "CreateVnfPkgInfoRequest" + properties: + CreateVnfPkgInfoRequest: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest" description: > IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2 + responses: 201: - description: > + description: > 201 Created - + An individual VNF package resource has been created successfully. The response body shall contain a representation of the new individual VNF package resource, as defined @@ -239,43 +201,36 @@ paths: $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" headers: Content-Type: - type: string + type: "string" description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. maximum: 1 - minimum: 1 + minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. maximum: 1 minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - - ############################################################################### - # Individual VNF Package # - ############################################################################### +############################################################################### +# Individual VNF Package # +############################################################################### '/vnf_packages/{vnfPkgId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.3 parameters: - - name: vnfPkgId + - name: "vnfPkgId" description: > Identifier of the VNF package. The identifier is allocated by the NFVO. - in: path - type: string + in: "path" + type: "string" required: true get: summary: Read information about an individual VNF package. - description: > + description: > The GET method reads the information of a VNF package. parameters: - name: Accept @@ -291,43 +246,32 @@ paths: 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 + type: string responses: 200: description: > 200 OK - - Information of the VNF package was read successfully. - The response body shall contain the VNF package - info representation defined in clause 9.5.2.5. + + Information of the VNF package. schema: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + type: "object" + properties: + VnfPkgInfo: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" headers: Content-Type: - type: string + type: "string" description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: - type: string + type: "string" 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. 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: @@ -348,7 +292,7 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/503" delete: summary: Delete an individual VNF package. - description: > + description: > The DELETE method deletes an individual VNF Package resource. parameters: - name: Authorization @@ -357,20 +301,16 @@ paths: 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 + type: string responses: 204: description: > 204 No Content - + The VNF package was deleted successfully. The response body shall be empty. + 409: + $ref: "../responses/SOL005_resp.yaml#/responses/409" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -383,8 +323,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: @@ -393,45 +331,44 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/503" patch: summary: Update information about an individual VNF package. - description: > + description: > "The PATCH method updates the information of a VNF package." - + "This method shall follow the provisions specified in the Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query parameters, request and response data structures, and response codes." parameters: - - name: body - in: body - required: true - schema: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications" - description: > + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "VnfPkgInfoModifications" + properties: + VnfPkgInfoModifications: + $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. - Reference: IETF RFC 7231 - 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: + - 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. + Reference: IETF RFC 7231 + in: header + required: true + type: string + responses: 200: description: > 200 OK - + The operation was completed successfully. The response body shall contain attribute modifications for an "Individual VNF @@ -443,21 +380,19 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. 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/VnfPkgInfoModifications" + properties: + VnfPkgInfoModifications: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications" + 409: + $ref: "../responses/SOL005_resp.yaml#/responses/409" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -470,32 +405,30 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - - ############################################################################### - # VNFD in an individual VNF package # - ############################################################################### + +############################################################################### +# VNFD in an individual VNF package # +############################################################################### '/vnf_packages/{vnfPkgId}/vnfd': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.4 parameters: - name: vnfPkgId description: > - Identifier of the VNF package. The identifier is allocated by the NFVO. + Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO. in: path type: string - required: true + required: true get: summary: Read VNFD of an on-boarded VNF package. - description: > + description: > The GET method reads the content of the VNFD within a VNF package. - + The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the VNFD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. @@ -512,31 +445,25 @@ paths: This method shall follow the provisions specified in the Tables 9.4.4.3.2-1 and 9.4.4.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - in: header - required: true - type: string - enum: - - text/plain - - application/zip - - 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: Accept + description: > + Content-Types that are acceptable for the response. + in: header + required: true + type: string + 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: > + description: > 200 OK On success, the content of the VNFD is returned. @@ -554,19 +481,13 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. 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: @@ -587,61 +508,55 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - - ############################################################################### - # VNF Package Content # - ############################################################################### + +############################################################################### +# VNF Package Content # +############################################################################### '/vnf_packages/{vnfPkgId}/package_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.5 parameters: - - name: vnfPkgId + - name: "vnfPkgId" description: > - Identifier of the VNF package. The identifier is allocated by the NFVO. - in: path + Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO. + in: "path" required: true - type: string + type: "string" get: summary: Fetch an on-boarded VNF package. - description: > + description: > The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. This method shall follow the provisions specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - in: header - required: true - 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 - type: string - description: > - The request may contain a "Range" HTTP header to obtain single - range of bytes from the VNF package file. This can be used to - continue an aborted transmission. - - If the NFVO does not support range requests, it should return the - whole file with a 200 OK response instead. - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - name: Accept + description: > + Content-Types that are acceptable for the response. + in: header + required: true + 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 + type: "string" + description: > + The request may contain a "Range" HTTP header to obtain single + range of bytes from the VNF package file. This can be used to + continue an aborted transmission. + + If the NFVO does not support range requests, it should return the + whole file with a 200 OK response instead. responses: 200: - description: > + description: > 200 OK On success, a copy of the VNF package file is returned. @@ -657,21 +572,19 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. 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: + $ref: "../responses/SOL005_resp.yaml#/responses/409" + 416: + $ref: "../responses/SOL005_resp.yaml#/responses/416" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -684,64 +597,57 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - + put: summary: Upload a VNF package by providing the content of the VNF package. - description: > + description: > The PUT method uploads the content of a VNF package. This method shall follow the provisions specified in the Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters, request and response data structures, and response codes. consumes: - - multipart/form-data + - multipart/form-data parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - in: header - required: true - 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 - type: file - description: > - The payload body contains a ZIP file that represents the VNF package. - The "Content-Type" HTTP header shall be set according to the - type of the file, i.e. to "application/zip" for a VNF Package as - defined in ETSI GS NFV-SOL 004 [5]. - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - name: Accept + description: > + Content-Types that are acceptable for the response. + in: header + required: true + 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 + type: file + description: > + The payload body contains a ZIP file that represents the VNF package. + The "Content-Type" HTTP header shall be set according to the + type of the file, i.e. to "application/zip" for a VNF Package as + defined in ETSI GS NFV-SOL 004 [5]. responses: 202: - description: > + description: > 202 Accepted - + The VNF package was accepted for uploading, but the processing has not been completed. It is expected to take some time for processing. The response body shall be empty. + 409: + description: > + $ref: "../responses/SOL005_resp.yaml#/responses/409" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -754,72 +660,72 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - ############################################################################### - # Upload VNF package from URI task # - ############################################################################### +############################################################################### +# Upload VNF package from URI task # +############################################################################### '/vnf_packages/{vnfPkgId}/package_content/upload_from_uri': #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.6 post: summary: Upload a VNF package by providing the address information of the VNF package. - description: > + description: > The POST method provides the information for the NFVO to get the content of a VNF package. This method shall follow the provisions specified in the Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - 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. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: vnfPkgId - description: > - Identifier of the VNF package. The identifier is allocated by the NFVO. - in: path - required: true - type: string - - name: body - in: body - required: true - schema: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest" + parameters: + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + 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. + Reference: IETF RFC 7231 + in: header + required: true + type: string + + - name: "vnfPkgId" + description: > + Identifier of the VNF package. The identifier is allocated by the NFVO. + in: "path" + required: true + type: "string" + + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "UploadVnfPkgFromUriRequest" + properties: + UploadVnfPkgFromUriRequest: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest" description: > The payload body contains the address information based on - which the NFVO can obtain the content of the VNF package. - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + which the NFVO can obtain the content of the VNF package. + responses: 202: description: > 202 Accepted - + The information about the VNF package was received successfully, but the on-boarding has not been completed. It is expected to take some time for processing. @@ -842,132 +748,146 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - - ############################################################################### - # Individual VNF package artifact # - ############################################################################### + +############################################################################### +# Individual VNF package artifact # +############################################################################### '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}': - #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7 - parameters: - - name: vnfPkgId - description: > - Identifier of the VNF package. - The identifier is allocated by the NFVO. - This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or - VnfPackageChangeNotification. - in: path - type: string - required: true - - name: artifactPath - description: > - Sequence of one or path segments representing the path of the artifact - within the VNF package. - EXAMPLE: foo/bar/run.sh - This identifier can be retrieved from the "artifactPath" attribute of - the applicable "additionalArtifacts" entry in the body of the response - to a GET request querying the "Individual VNF package" or the - "VNF packages" resource. - in: path - type: string - required: true - get: - summary: Fetch individual VNF package artifact. - description: > - The GET method fetches the content of an artifact within a VNF package. - This method shall follow the provisions specified in the - Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - 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 - range of bytes from the VNF package file. This can be used to - continue an aborted transmission. - If the NFVO does not support range requests, it should return the - whole file with a 200 OK response instead. - in: header - 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: > - 200 OK - On success, the content of the artifact is returned. - The payload body shall contain a copy of the artifact file from - the VNF package, as defined by ETSI GS NFV-SOL 004. - The "Content-Type" HTTP header shall be set according to the - content type of the artifact file. If the content type cannot be - determined, the header shall be set to the value - "application/octet-stream". - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - type: string - 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. - 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" - 400: - $ref: "../responses/SOL005_resp.yaml#/responses/400" - 401: - $ref: "../responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "../responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "../responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "../responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOl005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" - 500: - $ref: "../responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" - - ############################################################################## - # Subscriptions # - ############################################################################### + #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.7 + parameters: + - name: vnfPkgId + description: > + Identifier of the on-boarded VNF package. + The identifier is allocated by the NFVO. + This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or + VnfPackageChangeNotification. + in: path + type: string + required: true + - name: artifactPath + description: > + Path of the artifact within the VNF package. + This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts" entry in + the body of the response to a GET request querying the "Individual VNF package" or the "VNF packages" + resource. + in: path + type: string + required: true + get: + summary: Fetch individual VNF package artifact. + description: > + The GET method fetches the content of an artifact within a VNF package. + This method shall follow the provisions specified in the + Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters, + request and response data structures, and response codes. + parameters: + - name: Accept + description: > + Content-Types that are acceptable for the response. + 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 + range of bytes from the VNF package file. This can be used to + continue an aborted transmission. + If the NFVO does not support range requests, it should return the + whole file with a 200 OK response instead. + in: header + type: string + responses: + 200: + description: > + 200 OK + On success, the content of the artifact is returned. + The payload body shall contain a copy of the artifact file from + the VNF package, as defined by ETSI GS NFV-SOL 004. + The "Content-Type" HTTP header shall be set according to the + content type of the artifact file. If the content type cannot be + determined, the header shall be set to the value + "application/octet-stream". + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + WWW-Authenticate: + type: "string" + 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. + maximum: 1 + minimum: 0 + + 206: + description: > + Partial Content. + On success, if the NFVO supports range requests, a single + consecutive byte range from the content of the VNF package file is + returned. + The response body shall contain the requested part of the VNF + package file. + The "Content-Range" HTTP header shall be provided according to + IETF RFC 7233. + The "Content-Type" HTTP header shall be set as defined above for + the "200 OK" response. + headers: + Content-Range: + type: string + maximum: 1 + minimum: 1 + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + WWW-Authenticate: + type: "string" + 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. + maximum: 1 + minimum: 0 + 400: + $ref: "../responses/SOL005_resp.yaml#/responses/400" + 401: + $ref: "../responses/SOL005_resp.yaml#/responses/401" + 403: + $ref: "../responses/SOL005_resp.yaml#/responses/403" + 404: + $ref: "../responses/SOL005_resp.yaml#/responses/404" + 405: + $ref: "../responses/SOL005_resp.yaml#/responses/405" + 406: + $ref: "../responses/SOL005_resp.yaml#/responses/406" + 409: + $ref: "../responses/SOL005_resp.yaml#/responses/409" + 416: + $ref: "../responses/SOL005_resp.yaml#/responses/416" + 500: + $ref: "../responses/SOL005_resp.yaml#/responses/500" + 503: + $ref: "../responses/SOL005_resp.yaml#/responses/503" + +############################################################################## +# Subscriptions # +############################################################################### '/subscriptions': - #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8 + #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.8 post: summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages. - description: > + description: > The POST method creates a new subscription. This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters, request and response data structures, and response codes. @@ -978,47 +898,47 @@ paths: to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri). parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - 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. - Reference: IETF RFC 7231 - 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 - schema: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest" + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + 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. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "PkgmSubscriptionRequest" + properties: + PkgmSubscriptionRequest: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest" description: > Representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that points to the created subscription resource. + responses: 201: description: > 201 Created - + Representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that points to the created subscription resource. @@ -1029,23 +949,19 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 + minimum: 0 schema: type: array items: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + properties: + PkgmSubscription: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" 303: $ref: "../responses/SOL005_resp.yaml#/responses/303" 400: @@ -1068,30 +984,23 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/503" get: summary: Query multiple subscriptions. - description: > + description: > The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall follow the provisions specified in the Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: filter - in: query + - name: "filter" + in: "query" required: false - type: string - description: > - Attribute-based filtering expression according to clause 4.3.2. - The NFVO shall support receiving this filtering parameter as part of the URI query - string. The OSS/BSS may supply this filtering parameter. + type: "string" + description: > + Attribute-based filtering parameters according to clause 4.3.2. + The NFVO shall support receiving filtering parameters as part of the URI query + string. The OSS/BSS may supply filtering parameters. All attribute names that appear in the PkgmSubscription and in data types - referenced from it shall be supported by the NFVO in the filtering expression. - - name: nextpage_opaque_marker - in: query - description: > - Marker to obtain the next page of a paged response. Shall be supported by the NFVO - if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. - required: false - type: string + referenced from it shall be supported in attribute-based filtering parameters - name: Accept description: > Content-Types that are acceptable for the response. @@ -1106,17 +1015,11 @@ 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 responses: 200: description: > 200 OK - + Active subscriptions of the functional block that invokes the method. headers: Content-Type: @@ -1125,29 +1028,19 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 - Link: - description: > - Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. - type: string - maximum: 1 - minimum: 0 + minimum: 0 schema: type: array items: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + properties: + PkgmSubscription: + $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1166,12 +1059,12 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" - - ############################################################################### - # Individual subscription # - ############################################################################### + +############################################################################### +# Individual subscription # +############################################################################### '/subscriptions/{subscriptionId}': - #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9 + #ETSI GS NFV-SOL 005 V2.4.1 location: 9.4.9 parameters: - name: subscriptionId description: > @@ -1184,7 +1077,7 @@ paths: type: string required: true get: - summary: Read an individual subscription resource. + summary: Read an individual subscription resource. description: > Query Subscription Information The GET method reads an individual subscription. @@ -1203,17 +1096,11 @@ 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 responses: 200: description: > 200 OK - + Representation of the subscription resource. headers: Content-Type: @@ -1222,19 +1109,13 @@ paths: maximum: 1 minimum: 1 WWW-Authenticate: - type: string + type: "string" 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. maximum: 1 - minimum: 0 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 + minimum: 0 schema: properties: PkgmSubscription: @@ -1259,7 +1140,7 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/503" delete: summary: Terminate a subscription. - description: > + description: > The DELETE method terminates an individual subscription. parameters: - name: Authorization @@ -1269,33 +1150,21 @@ 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 responses: 204: - description: > + description: > No Content The subscription resource was deleted successfully. headers: WWW-Authenticate: - type: string + type: "string" 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. 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 fe2cc1c4d737df1d830524baf6071fce7708b39a..32a6ac618c4b3c2c5af34e3a63a57beff55944bf 100644 --- a/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml +++ b/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml @@ -147,11 +147,11 @@ definitions: Link to the resource representing the VNF package to which the notified change applies, i.e. the individual on boarded VNF package resource that represents the VNF package. - $ref: "SOL005_def.yaml#/definitions/NotificationLink" + $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink" subscription: description: > Link to the related subscription. - $ref: "SOL005_def.yaml#/definitions/NotificationLink" + $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink" VnfPackageSoftwareImageInfo: description: > @@ -537,4 +537,4 @@ definitions: - PKG_DELETE: The VNF package has been deleted. enum: - OP_STATE_CHANGE - - PKG_DELETE + - PKG_DELETE \ No newline at end of file diff --git a/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml b/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml index 84c0f7fd2dcade2b784b3224f5532a654d383c9c..e0f6fb3be4f4fd0c18eaf8d3b6ff53fd7cc851ae 100644 --- a/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml +++ b/src/SOL005/VNFPackageManagement/responses/SOL005VNFPackageManagement_resp.yaml @@ -30,7 +30,7 @@ responses: maximum: 1 minimum: 0 schema: - $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" + $ref: "../../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" 202-with-Location-empty: description: > Accepted diff --git a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index a5a68d4bc71c917963fd9dfa614bb3225a165e3e..01ea470ad1fbabb16da9aa68c5bf268c06a3879c 100644 --- a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.2.0" + version: "1.1.0" title: "SOL005 - VNF Package Management Notification interface" description: > SOL005 - VNF Package Management Notification interface @@ -136,7 +136,7 @@ paths: schema: properties: VnfPackageChangeNotification: - $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPackageChangeNotification" + $ref: "definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" - name: Accept description: > Content-Types that are acceptable for the response. diff --git a/src/SOL005/definitions/SOL005_def.yaml b/src/SOL005/definitions/SOL005_def.yaml index cfc7c8b8c03dd0a16a3e6fa1c051daaeb56176e7..c7e2a78180eb0ad3a2e80d01c35e681994b00c43 100644 --- a/src/SOL005/definitions/SOL005_def.yaml +++ b/src/SOL005/definitions/SOL005_def.yaml @@ -178,7 +178,7 @@ definitions: type: string format: url - NSInstanceSubscriptionFilter: + NsInstanceSubscriptionFilter: description: > This type represents subscription filter criteria to match NS instances. type: object