diff --git a/.gitignore b/.gitignore index bd807fe65e47931373170ecc22b10e605dc2a008..7203a6edcc4a623eff3bc1be20d10d44c844a822 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ build/ *.pyc - +.idea/ diff --git a/Readme.md b/Readme.md index 59baacd0f4388f33f402492962e5cd1de3ddc11c..1f94e8ad04d166b369b578af5377ee6b185c5b85 100644 --- a/Readme.md +++ b/Readme.md @@ -1,7 +1,7 @@ # NFV SOL002 and SOL003 APIs This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation -for the APIs defined in ETSI NFV GSs [SOL002](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_NFV-SOL002v020701p.pdf) and [SOL003](https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_nfv-sol003v020701p.pdf). +for the APIs defined in ETSI NFV GSs SOL002 and SOL003 v3.3.1. The APIs described in this repository are defined for the following reference points: diff --git a/docker/Dockerfile b/docker/Dockerfile index 5d7ff5d727ff1ee4e0c26cf943ba79c5a3ddb064..9b3d8380bbce4da5163ba8292cbefad5963ab448 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,7 +1,7 @@ # Copyright ETSI 2017 # See: https://forge.etsi.org/etsi-forge-copyright-statement.txt -FROM alpine:3.6 +FROM alpine:3.10.0 RUN env RUN apk update @@ -16,9 +16,9 @@ RUN gem install rdoc --pre || gem install rdoc --pre RUN gem install asciidoctor-pdf-cjk RUN wget https://forge.etsi.org/swagger2markup-cli-1.3.2.jar RUN npm config set proxy $http_proxy -RUN npm install -g swagger-tools@0.10.3 -RUN npm install -g json-refs@3.0.4 -RUN npm install -g yamljs@0.3.0 +RUN npm install -g swagger-cli +RUN npm install -g json-refs +RUN npm install -g yamljs ADD validate-in-docker.sh /validate-in-docker.sh RUN chmod +x /validate-in-docker.sh diff --git a/docker/validate-in-docker.sh b/docker/validate-in-docker.sh index 716291a14d9970be10695ceef6076370880a9cf0..c9d54f73ca5bd0174aad839a7ecc103e974048d5 100755 --- a/docker/validate-in-docker.sh +++ b/docker/validate-in-docker.sh @@ -32,7 +32,7 @@ function validate_api () { mv "${deliverable}-${api}-API.pdf" "../build/" echo "--- Validating ${merged_file}" - swagger-tools validate "${merged_file}" + swagger-cli validate "${merged_file}" vres=$? echo "--- Validation done ($vres)." diff --git a/src/SOL002/APIVersion/APIVersion.yaml b/src/SOL002/APIVersion/APIVersion.yaml index c050b0548c5e01f140a6637b41da507c54a2a9a6..dee16ad390a3d5b3619ce22a33144aba50b0d2f3 100644 --- a/src/SOL002/APIVersion/APIVersion.yaml +++ b/src/SOL002/APIVersion/APIVersion.yaml @@ -1,50 +1,31 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - API version interface - description: > - SOL002 - API version Interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - API version Interface IMPORTANT: Please note that this file might be not aligned to the current version of + the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies + the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf paths: - ############################################################################### - # API Versions # - ############################################################################### - '/vnfconfig/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - - '/vnffm/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - - '/vnfind/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - - '/vnflcm/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - - '/vnfpm/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' \ No newline at end of file + /vnfconfig/api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions + /vnffm/api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions + /vnfind/api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions + /vnflcm/api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions + /vnfpm/api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions \ No newline at end of file diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index b70febcf653489cc32a261c145addbff20117d47..84f7196ecde1f26abb21840218c1a367e04fb326 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -1,183 +1,162 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Configuration interface - description: > - SOL002 - VNF Configuration Interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Configuration Interface IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of + discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /vnfconfig/v1 + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/vnfconfig/v1 + - url: https://127.0.0.1/vnfconfig/v1 paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api_versions': + /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - ############################################################################### - # VNF Configuration # - ############################################################################### - '/configuration': + /configuration: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Read VNF/VNFC configuration from VNF - description: > + description: | The client can use this method to read configuration information about a VNF instance and/or its VNFC instances. responses: - 200: - description: > - 200 OK - - Shall be returned when configuration information about a VNF instance - has been read successfully. - The response body shall contain a representation of the configuration resource. - schema: - $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + "200": + $ref: '#/components/responses/Configuration.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + patch: summary: Modify VNF/VNFC configuration. description: This method sets or modifies a configuration resource. - parameters: - - name: configModifications - description: > - The parameter for the configuration modification, as defined in - clause 9.5.2.2. - required: true - in: body - schema: - $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications' + requestBody: + $ref: '#/components/requestBodies/ConfigurationRequest' responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/Configuration.Patch' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "412": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the request has been accepted and completed. - The response body shall contain the parameters of the configuration - modification that was applied to the configuration resource. +components: + requestBodies: + ConfigurationRequest: + description: | + The parameter for the configuration modification, as defined in clause 9.5.2.2. + content: + application/json: schema: - $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 412: - # description: > - # 412 PRECONDITION FAILED + $ref: ./definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications + required: true - # Shall be returned upon the following error: A precondition given - # in an HTTP request header is not fulfilled. - # Typically, this is due to an ETag mismatch, indicating that the resource - # was modified by another entity. The response body should contain a - # ProblemDetails structure, in which the "detail" attribute should convey - # more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + responses: + Configuration.Get: + description: | + 200 OK + Shall be returned when configuration information about a VNF instance has been read successfully. The response + body shall contain a representation of the configuration resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration + + Configuration.Patch: + description: | + 200 OK + Shall be returned when the request has been accepted and completed. The response body shall contain the + parameters of the configuration modification that was applied to the configuration resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications \ No newline at end of file diff --git a/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml b/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml index 45d668898061fcb722b6285b675d926c6b456944..d56c1edc32ee02e3ef33ca1348a2d21b33901af5 100644 --- a/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml +++ b/src/SOL002/VNFConfiguration/definitions/SOL002VNFConfiguration_def.yaml @@ -10,6 +10,11 @@ definitions: * NOTE 2: The VnfcConfiguration data type can only be used to modify the configuration of existing VNFC instances. type: object + anyOf: + - required: + - vnfConfigurationData + - required: + - vnfcConfigurationData properties: vnfConfigurationData: description: > @@ -100,6 +105,7 @@ definitions: vnfcInstanceId: description: > Identifier of a VNFC instance to which this set of configuration data applies. + The identifier references the "id" attribute in a "VnfcInfo" structure. $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' intCpConfig: description: > @@ -148,6 +154,16 @@ definitions: * NOTE 1: Either "address" or "useDynamicAddress" shall be present. * NOTE 2: At least one of "macAddress" and "ipAddress" shall be present. type: object + oneOf: + - required: + - address + - required: + - useDynamicAddress + anyOf: + - required: + - macAddress + - required: + - ipAddress properties: address: description: > diff --git a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml index 0b7df075439ed9dc48522512a0fd1d08117ff7f4..0dd76c0f03a29e69f1367189c74869e6f6b7dfd4 100644 --- a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml @@ -1,888 +1,647 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Fault Management interface - description: > - SOL002 - VNF Fault Management interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Fault Management interface IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /vnffm/v1 - -schemes: - - http - - https + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/vnffm/v1 + - url: https://127.0.0.1/vnffm/v1 paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api_versions': + /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - ############################################################################### - # Alarms # - ############################################################################### - '/alarms': - #SOL003 location: 7.4.2 + /alarms: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method to retrieve information about the alarm - list. + description: | + The client can use this method to retrieve information about the alarm list. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter. - The following attribute names shall be supported in the filter expression: id, managedObjectId, - vnfcInstanceIds, rootCauseFaultyResource.faultyResourceType, eventType, perceivedSeverity, probableCause. - If the vnfcInstanceIds parameter is provided, exactly one value for the managedObjectId attribute - shall be provided. - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports alternative 2 - (paging) according to clause 5.4.2.1 5.2 of ETSI GS NFV-SOL 013 - for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/Alarms.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about zero or more alarms was queried successfully. - The response body shall contain in an array the representations of zero or more alarms - as defined in clause 7.5.2.4. - If the "filter" URI parameter was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clause 5.2.2 of - ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of - ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this response - shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 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 - schema: - $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual alarm # - ############################################################################### - '/alarms/{alarmId}': - #SOL003 location: 7.4.3 + /alarms/{alarmId}: parameters: - - name: alarmId - description: > - Identifier of the alarm. - This identifier can be retrieved from the "id" attribute of the - "alarm" attribute in the AlarmNotification or - AlarmClearedNotification. It can also be retrieved from the "id" - attribute of the applicable array element in the payload body of the - response to a GET request to the "Alarms" resource. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/AlarmId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > + description: | The client can use this method to read an individual alarm. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/IndividualAlarm.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about an individual alarm read - successfully. - The response body shall contain a representation of the individual - alarm. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" patch: - description: > + description: | This method modifies an individual alarm resource. parameters: - - name: AlarmModifications - description: The parameter for the alarm modification - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: Content-Type - description: > - The Content-Type header shall be set to "application/mergepatch+json" - Reference: IETF RFC 7396 - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/IndividualAlarmRequest' responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/IndividualAlarm.Patch' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "412": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the request was accepted and completed. - The response body shall contain attribute modifications for - an "Individual alarm" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Shall be returned upon the following error: The operation cannot be executed - # currently, due to a conflict with the state of the "Individual alarm" resource. - # Typically, this is due to the fact that the alarm is already in the state that - # is requested to be set (such as trying to acknowledge an already-acknowledged - # alarm). - # The response body shall contain a ProblemDetails structure, in which the - # "detail" attribute shall convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 412: - # description: > - # 412 PRECONDITION FAILED - - # ErrorShall be returned upon the following error: A precondition given in an - # HTTP request header is not fulfilled. - # Typically, this is due to an ETag mismatch, indicating that the resource was - # modified by another entity. - # The response body should contain a ProblemDetails structure, in which the - # "detail" attribute should convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Escalate Perceived Severity task # - ############################################################################### - '/alarms/{alarmId}/escalate': - #SOL002 location: 7.4.4 + /alarms/{alarmId}/escalate: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/AlarmId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method enables the consumer to escalate the perceived severity - of an alarm that is represented by an ndividual alarm resource. - As the result of successfully executing this method, a new "Individual - subscription" resource as defined in clause 7.4.5 shall have been created. - This method shall not trigger any notification. - parameters: - - name: alarmId - description: > - Identifier of the alarm. - This identifier can be retrieved from the "id" attribute of the - "alarm" attribute in the AlarmNotification or - AlarmClearedNotification. It can also be retrieved from the "id" - attribute of the applicable array element in the payload body of the - response to a GET request to the "Alarms" resource. - in: path - type: string - required: true - - name: PerceivedSeverityRequest - description: The proposed "escalated perceived severity" value - in: body - schema: - $ref: "definitions/SOL002VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest" + description: | + The POST method enables the consumer to escalate the perceived severity of an alarm that is represented by an + individual alarm resource. As the result of successfully executing this method, a new "Individual subscription" + resource as defined in clause 7.4.5 shall have been created. This method shall not trigger any notification. + requestBody: + $ref: '#/components/requestBodies/IndividualAlarmEscalateRequest' responses: - 200: - description: > - 204 No Content + "200": + $ref: '#/components/responses/IndividualAlarmEscalate.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the VNFM has received the proposed "escalated - perceived severity" value successfully. The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Subscriptions # - ############################################################################### - '/subscriptions': - #SOL003 location: 7.4.4 + /subscriptions: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The client can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the + client. It can be used e.g. for resynchronization after error situations. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + "200": + $ref: '#/components/responses/Subscriptions.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + post: - description: > + description: | The POST method creates a new subscription. parameters: - - name: FmSubscriptionRequest - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/FmSubscriptionRequest' responses: - 201: - description: > - 201 CREATED + "201": + $ref: '#/components/responses/Subscriptions.Post' + "303": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - The subscription was created successfully. The response body shall - contain a representation of the created subscription resource. - The HTTP response shall include a "Location:" HTTP header that - points to the created subscription resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - The resource URI of the created subscription resource. - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" - 303: - # description: > - # 303 SEE OTHER - - # A subscription with the same callbackURI and the same filter already exists and the policy of - # the VNFM is to not create redundant subscriptions. - # The HTTP response shall include a "Location" HTTP header that contains the resource URI of the - # existing subscription resource. - # The response body shall be empty. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - # description: > - # 422 UNPROCESSABLE ENTITY - - # Shall be returned upon the following error: The content - # type of the payload body is supported and the payload - # body of a request contains syntactically correct data but - # the data cannot be processed. - # The general cause for this error and its handling is - # specified in clause 6.4 of ETSI GS NFV-SOL 013 [6], - # including rules for the presence of the response body. - # Specifically in case of this resource, the response code - # 422 shall also be returned if the VNFM has tested the - # Notification endpoint as described in clause 7.4.7.3.2 - # and the test has failed. - # In this case, the "detail" attribute in the "ProblemDetails" - # structure shall convey more information about the error - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + /subscriptions/{subscriptionId}: + parameters: + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method to retrieve the list of active - subscriptions for VNF alarms subscribed by the client. It can be used - e.g. for resynchronization after error situations. + description: | + The client can use this method for reading an individual subscription for VNF alarms subscribed by the client. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter. - All attribute names that appear in the FmSubscription and in data types referenced from it - shall be supported by the VNFM in the filter expression. + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + responses: + "200": + $ref: '#/components/responses/IndividualSubscription.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} + delete: + description: | + This method terminates an individual subscription. As the result + of successfully executing this method, the "Individual subscription" + resource shall not exist any longer. This means that no notifications for + that subscription shall be sent to the formerly-subscribed API consumer. + NOTE: Due to race conditions, some notifications might still be received + by the formerly-subscribed API consumer for a certain time period after + the deletion. + responses: + "204": + $ref: '#/components/responses/IndividualSubscription.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Request 1: - GET …/container +components: + parameters: + AlarmId: + name: alarmId + in: path + description: | + Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute + in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of + the applicable array element in the payload body of the response to a GET request to the "Alarms" resource. + required: true + style: simple + explode: false + schema: + type: string - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" + HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved + from the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string - Request 2: - GET …/container?filter=(eq.weight,100) + requestBodies: + IndividualAlarmRequest: + description: The parameter for the alarm modification + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications + required: true - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports alternative 2 - (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for - this resource. - in: query - required: false - type: string - responses: - 200: - description: > - 200 OK + IndividualAlarmEscalateRequest: + description: The proposed "escalated perceived severity" value + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest + required: false - The list of subscriptions has been queried successfully. The response - body shall contain the representations of all active - subscriptions of the functional block that invokes the method. - If the "filter" URI parameter was supplied in the request, the data - in the response body shall have been transformed according to the - rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause - 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the - Link HTTP header in this response shall follow the provisions in - clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual subscription # - ############################################################################### - '/subscriptions/{subscriptionId}': - #SOL003 location: 7.4.5 - parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new subscription resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 - get: - description: > - The client can use this method for reading an individual subscription - for VNF alarms subscribed by the client. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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 + FmSubscriptionRequest: + description: The VNF creation parameters + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest + required: true - Shall be returned when information about an individual subscription - has been read successfully. - The response body shall contain a representation of the "Individual - subscription" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - delete: - description: > - This method terminates an individual subscription. - As the result of successfully executing this method, the "Individual - subscription" resource shall not exist any longer. This means that no - notifications for that subscription shall be sent to the - formerly-subscribed API consumer. - NOTE: Due to race conditions, some notifications might still be - received by the formerly-subscribed API consumer for a certain time - period after the deletion. - responses: - 204: - description: > - 204 NO CONTENT + responses: + Alarms.Get: + description: | + 200 OK + Shall be returned when information about zero or more alarms was queried successfully. The response body shall + contain in an array the representations of zero or more alarms as defined in clause 7.5.2.4. If the "filter" + URI parameter was supplied in the request, the data in the response body shall have been transformed according + to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) + according to clause 5.4.2.1 of ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this + response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm + + IndividualAlarm.Get: + description: | + 200 OK + Shall be returned when information about an individual alarm read successfully. The response body shall contain + a representation of the individual alarm. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm + + IndividualAlarm.Patch: + description: | + 200 OK + Shall be returned when the request was accepted and completed. The response body shall contain attribute + modifications for an "Individual alarm" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications - Shall be returned when the "Individual subscription" resource has - been deleted successfully. - The response body shall be empty. - headers: - Version: - description: The used API version. - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + IndividualAlarmEscalate.Post: + description: | + 204 No Content + Shall be returned when the VNFM has received the proposed "escalated perceived severity" value successfully. + The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: {} + + Subscriptions.Get: + description: | + 200 OK + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain the representations of all active subscriptions of the functional block that + invokes the method. If the "filter" URI parameter was supplied in the request, the data in the response body + shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, + inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of + ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription + + Subscriptions.Post: + description: | + 201 CREATED + The subscription was created successfully. The response body shall contain a representation of the created + subscription resource. The HTTP response shall include a "Location:" HTTP header that points to the created + subscription resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription + + IndividualSubscription.Get: + description: | + 200 OK + Shall be returned when information about an individual subscription has been read successfully. The response body shall contain a representation of the "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription + + IndividualSubscription.Delete: + description: | + 204 NO CONTENT + Shall be returned when the "Individual subscription" resource has been deleted successfully. + The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml index e2b4c336a9238af2f9a5b3915c338e8d6abc8b81..285540b21537937754514defcc66a94b26b8a950 100644 --- a/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml +++ b/src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml @@ -29,6 +29,8 @@ definitions: vnfcInstanceIds: description: > Identifiers of the affected VNFC instances. + Each identifier references the "id" attribute in a "VnfcInfo" structure. + Shall be present if the alarm affects at least one VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" @@ -124,9 +126,64 @@ definitions: instance information is accessible as a resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + AlarmNotification: + description: > + This type represents an alarm notification about VNF faults. + This notification shall be triggered by the VNFM when: + * An alarm has been created. + * An alarm has been updated, e.g. if the severity of the alarm has + changed. + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - alarm + - _links + properties: + id: + description: > + Identifier of this notification. If a notification is sent multiple + times due to multiple subscriptions, the "id" attribute of all these + notifications shall have the same value. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + notificationType: + description: > + Discriminator for the different notification types. Shall be set to + "AlarmNotification" for this notification type. + type: string + enum: + - AlarmNotification + subscriptionId: + description: > + Identifier of the subscription that this notification relates to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + timeStamp: + description: > + Date-time of the generation of the notification. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + alarm: + description: > + Information about an alarm including AlarmId, affected VNF + identifier, and FaultDetails. + $ref: "#/definitions/Alarm" + _links: + description: > + Links to resources related to this notification. + type: object + required: + - subscription + properties: + subscription: + description: > + Link to the related subscription. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" + PerceivedSeverityRequest: description: > This type represents the escalated value of the perceived severity for an alarm. + type: object required: - proposedPerceivedSeverity properties: diff --git a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 061f08c2337fca7c9ae6c8c5620f087fd0984b83..f2f3ff62e8986eaec6182215f519810f07887c5c 100644 --- a/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -1,389 +1,258 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Fault Management Notification interface - description: > - SOL002 - VNF Fault Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Fault Management Notification interface IMPORTANT: Please note that this file might be not aligned to + the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to + https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -basePath: /callback/v1 - -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint AlarmNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmNotification: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: - description: > + description: | Notify - - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: AlarmNotification - description: > - Information of a VNF alarm. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. responses: - 204: - description: > - 201 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate the notification endpoint has been - tested successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - ############################################################################### - # Notification endpoint AlarmClearedNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmClearedNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 post: - description: > + description: | Notify - - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: AlarmClearedNotification - description: > - Information of the clearance of a VNF alarm - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmClearedNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + /URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. responses: - 204: - description: > - 201 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate the notification endpoint has been - tested successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - ############################################################################### - # Notification endpoint AlarmListRebuiltNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_AlarmListRebuiltNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 post: - description: > + description: | Notify - - The POST method notifies a VNF alarm or that the alarm list has been - rebuilt. The API consumer shall have previously created an "Individual - subscription" resource with a matching filter. + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: AlarmListRebuiltNotification - description: > - Information that the alarm list has been rebuilt by the VNFM - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" - - name: Content-Type - description: > - The Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmListRebuiltNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFFMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during subscription. - responses: - 204: - description: > - 204 NO CONTENT +components: + requestBodies: + AlarmNotification: + description: | + Information of a VNF alarm. + content: + application/json: + schema: + $ref: ../VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml#/definitions/AlarmNotification + required: true + + AlarmClearedNotification: + description: | + Information of the clearance of a VNF alarm. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification + required: true + + AlarmListRebuiltNotification: + description: | + Information that the alarm list has been rebuilt by the VNFM. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification + required: true + + responses: + VNFFMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} - Shall be returned to indicate the notification endpoint has been - tested successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + VNFFMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFIndicator/VNFIndicator.yaml b/src/SOL002/VNFIndicator/VNFIndicator.yaml index cb5532d79a3d54d8074b1251532f682664a6bb01..84ac22e513fc9224d1a7be410c7641ae26a81daf 100644 --- a/src/SOL002/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL002/VNFIndicator/VNFIndicator.yaml @@ -1,775 +1,580 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Indicator interface - description: > + description: | SOL002 - VNF Indicator interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + + IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it + refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification + takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /vnfind/v1 + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/vnfind/v1 + - url: https://127.0.0.1/vnfind/v1 paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions - ############################################################################### - # VNF Indicators # - ############################################################################### /indicators: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple indicators - description: Get a list of indicators. Support of attribute based filtering via query parameters. + description: Get a list of indicators. Support of attribute based filtering + via query parameters. parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter. - All attribute names that appear in the VnfIndicator data type and in data types referenced from - it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not - supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2). - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF - if the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 of - ETSI GS NFV-SOL 013for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/Indicators.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about zero or more VNF indicators was - queried successfully. The response body shall contain in an array the - representations of all VNF indicators that match the attribute-based - filtering parameters, i.e. zero or more representations of VNF indicators - as defined in clause 8.5.2.2. - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header - in this response shall follow the provisions in clause 5.4.2.3 of - ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - schema: - type: array - items: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator' - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # VNF indicators related to a VNF instance # - ############################################################################### /indicators/{vnfInstanceId}: parameters: - - name: vnfInstanceId - in: path - description: > - Service Unavailable - - Identifier of the VNF instance to which the VNF indicators applies. - NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a - POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body - of that response. - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple indicators related to a VNF instance. - description: > - Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters. + description: | + Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query + parameters. parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM/VNF shall support receiving filtering parameters as part of the URI query string. - The VNFM may supply filtering parameters. - All attribute names that appear in the VnfIndicator data type and in data types referenced - from it shall be supported in attribute-based filtering parameters. - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported - by the EM/VNF if the EM/VNF supports alternative 2 (paging) according - to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/VnfIndicators.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about zero or more VNF indicators - was queried successfully. - The response body shall contain in an array the representations of all - VNF indicators that are related to the particular VNF instance and that - match the attribute filter., i.e. zero or more representations of VNF - indicators as defined in clause 8.5.2.2. - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the EM/VMF supports alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP - header in this response shall follow the provisions in clause 5.4.2.3 - of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - schema: - type: array - items: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator' - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual VNF indicator # - ############################################################################### /indicators/{vnfInstanceId}/{indicatorId}: parameters: - - name: vnfInstanceId - in: path - description: > - Service Unavailable - - Identifier of the VNF instance to which the VNF indicators applies. - NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a - POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body - of that response. - type: string - required: true - - name: indicatorId - in: path - description: > - Identifier of the VNF indicator. - # LEH NOTE from SOL002 is strange - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: '#/components/parameters/IndicatorId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Read an inidividual VNF indicator related to a VNF instance. - description: > - Read an individual VNF indicator related to a specific VNF instance. - NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a - POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body - of that response. + description: | + Read an individual VNF indicator related to a specific VNF instance. NOTE: This identifier can be retrieved + from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF + instance resource. It can also be retrieved from the "id" attribute in the payload body of that response. responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/VnfIndividualIndicator.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the VNF indicator has been read successfully. - The response body shall contain the representation of the VNF indicator. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator' - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Subscriptions # - ############################################################################### /subscriptions: - post: - summary: Create a new subscription to VNF indicator change notifications - description: > - This method creates a new subscription. - As the result of successfully executing this method, a new "Individual - subscription" resource as defined in clause 8.4.6 shall have been created. - This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result in - performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very - rare use cases. Consequently, the API producer may either allow creating a new "Individual subscription" resource if - another "Individual subscription" resource with the same filter and callbackUri already exists (in which case it shall - return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in - which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource - with the same filter and callbackUri). - This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters, - request and response data structures, and response codes - parameters: - - name: vnfIndicatorSubscriptionRequest - in: body - description: Details of the subscription to be created. - required: true - schema: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest' - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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: - 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created - "Individual subscription" resource. - schema: - type: array - items: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription' - headers: - Location: - description: > - Pointer to the created subscription resource. - type: string - format: URI - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 303: - # description: > - # 303 SEE OTHER - - # Shall be returned when a subscription with the same callbackURI and - # the same filter already exists and the policy of the VNFM is to not - # create redundant subscriptions. - # The HTTP response shall include a "Location" HTTP header that contains - # the resource URI of the existing "Individual subscription" resource. - # The response body shall be empty. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Query multiple subscriptions. - description: > + description: | Service Unavailable - - 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. + 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. parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The EM shall and the VNF may support receiving this parameter as part - of the URI query string. The VNFM may supply this parameter. - All attribute names that appear in the VnfIndicatorSubscription data - type and in data types referenced from it shall be supported in the filter expression. - If receiving, this parameter is not supported, a 400 Bad Request response shall - be returned (see table 8.4.5.3.2-2). - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + "200": + $ref: '#/components/responses/VnfIndicatorSubscriptions.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported - by the EM if the EM supports alternative 2 (paging) according to - clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + post: + summary: Create a new subscription to VNF indicator change notifications + description: | + This method creates a new subscription. As the result of successfully executing this method, a new "Individual + subscription" resource as defined in clause 8.4.6 shall have been created. This method shall not trigger any + notification. Creation of two "Individual subscription" resources with the same callbackURI and the same filter + can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make + sense only in very rare use cases. Consequently, the API producer may either allow creating a new "Individual + subscription" resource if another "Individual subscription" resource with the same filter and callbackUri already + exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate + "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing + the existing "Individual subscription" resource with the same filter and callbackUri). This method shall follow + the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters, request and response + data structures, and response codes + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIndicatorSubscriptionRequest' responses: - 200: - description: > - 200 OK + "201": + $ref: '#/components/responses/VnfIndicatorSubscription.Post' + "303": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the list of subscriptions was queried successfully. - The response body shall contain in an array the representations of all - active subscriptions of the functional block that invokes the method which - match the attribute filter, i.e. zero or more representations of VNF - indicators subscriptions as defined in clause 8.5.2.4. - If the "filter" URI parameter was supplied in the request, the data in - the response body shall have been transformed according to the rules - specified in clause 5.2.2 of ETSI GS NFV SOL 013. - If the EM supports alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP - header in this response shall follow the provisions in clause 5.4.2.3 - of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - schema: - type: array - items: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription' - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual Subscription # - ############################################################################### /subscriptions/{subscriptionId}: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Read an individual subscription. - description: > + description: | Service Unavailable - - This resource represents an individual subscription. The client can use this resource to - read and to terminate a subscription to notifications related to VNF indicator value changes. - parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - NOTE: - This identifier can be retrieved from the resource referenced by the "Location" HTTP header - in the response to a POST request creating a new subscription resource. It can also be retrieved - from the "id" attribute in the payload body of that response. - in: path - type: string - required: true + This resource represents an individual subscription. The client can use this resource to read and to terminate a subscription to notifications related to VNF indicator value changes. responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/VnfIndicatorSubscription.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about an individual subscription - has been read successfully. - The response body shall contain the representation of the - "Individual subscription" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription' - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" delete: summary: Delete a subscription - description: > - This method terminates an individual subscription. - As the result of successfully executing this method, the "Individual - subscription" resource shall not exist any longer. This means that no - notifications for that subscription shall be sent to the formerly-subscribed - API consumer. - NOTE: Due to race conditions, some notifications might still be received - by the formerly-subscribed API consumer for a certain time period after + description: | + This method terminates an individual subscription. As the result + of successfully executing this method, the "Individual subscription" + resource shall not exist any longer. This means that no notifications for + that subscription shall be sent to the formerly-subscribed API consumer. + NOTE:\tDue to race conditions, some notifications might still be received + by the formerly-subscribed API consumer for a certain time period after the deletion. - parameters: - - name: subscriptionId - description: > - Service Unavailable - - Identifier of this subscription. - NOTE: - This identifier can be retrieved from the resource referenced by the "Location" HTTP header - in the response to a POST request creating a new subscription resource. It can also be retrieved - from the "id" attribute in the payload body of that response. - in: path - type: string - required: true responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VnfIndicatorSubscription.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + +components: + parameters: + VnfInstanceId: + name: vnfInstanceId + in: path + description: | + Service Unavailable. + Identifier of the VNF instance to which the VNF indicators applies. + NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the + response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + IndicatorId: + name: indicatorId + in: path + description: | + Identifier of the VNF indicator. + required: true + style: simple + explode: false + schema: + type: string - Shall be returned when the subscription has been deleted successfully. - The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. NOTE: + This identifier can be retrieved from the resource referenced by the "Location" HTTP header + in the response to a POST request creating a new subscription resource. It can also be retrieved + from the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + VnfIndicatorSubscriptionRequest: + description: Details of the subscription to be created. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest + required: true + + responses: + Indicators.Get: + description: | + 200 OK + Shall be returned when information about zero or more VNF indicators was queried successfully. + The response body shall contain in an array the representations of all VNF indicators that match the + attribute-based filtering parameters, i.e. zero or more representations of VNF indicators as defined + in clause 8.5.2.2. If the "filter" URI parameter was supplied in the request, the data in the response + body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013for this + resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 + of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + VnfIndicators.Get: + description: | + 200 OK + Shall be returned when information about zero or more VNF indicators was queried successfully. + The response body shall contain in an array the representations of all VNF indicators that are related + to the particular VNF instance and that match the attribute filter., i.e. zero or more representations + of VNF indicators as defined in clause 8.5.2.2. If the "filter" URI parameter was supplied in the request, + the data in the response body shall have been transformed according to the rules specified in clause + 5.2.2 of ETSI GS NFV-SOL 013. If the EM/VMF supports alternative 2 (paging) according to clause 5.4.2.1 of + ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the + provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + VnfIndividualIndicator.Get: + description: | + 200 OK + Shall be returned when the VNF indicator has been read successfully. The response body shall contain the + representation of the VNF indicator. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + VnfIndicatorSubscriptions.Get: + description: | + 200 OK + Shall be returned when the list of subscriptions was queried successfully. + The response body shall contain in an array the representations of all active subscriptions of the functional + block that invokes the method which match the attribute filter, i.e. zero or more representations of VNF + indicators subscriptions as defined in clause 8.5.2.4. If the "filter" URI parameter was supplied in the request, + the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of + ETSI GS NFV SOL 013. If the EM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 + of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + VnfIndicatorSubscription.Post: + description: | + 201 CREATED + Shall be returned when the subscription has been created successfully. The response body shall contain a + representation of the created "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Location: + description: | + Pointer to the created subscription resource. + style: simple + explode: false + schema: + type: string + format: URI + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + VnfIndicatorSubscription.Get: + description: | + 200 OK + Shall be returned when information about an individual subscription has been read successfully. The response body shall contain the representation of the "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + VnfIndicatorSubscription.Delete: + description: | + 204 NO CONTENT + Shall be returned when the subscription has been deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 3bc5145b9b87079414314e3c59ab6e3418ed6929..4e8aa6bc810c7588b349a77d4944334f280f1b8f 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -1,137 +1,207 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" - title: SOL002 - VNF Indicator Notification Endpoint interface - description: > - SOL002 - VNF Indicator Notification Endpoint interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + title: SOL002 - VNF Indicator Notification interface + description: | + SOL002 - VNF Indicator Notification interface + + IMPORTANT: Please note that this file might be not aligned to + the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -schemes: - - http - - https + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint VnfIndicatorValueChangeNotification # - ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification': parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + summary: Test notification endpoint. + description: | + Service Unavailable + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFInNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: summary: Notification endpoint - description: > - The API producer can use this resource to send notifications related to VNF indicator - value changes to a subscribed API consumer, which has provided the URI of this resource - during the subscription process. - The POST method delivers a notification from API producer to an API consumer. The API - consumer shall have previously created an "Individual subscription" resource with a - matching filter. + description: | + The API producer can use this resource to send notifications related to VNF indicator value changes to a + subscribed API consumer, which has provided the URI of this resource during the subscription process. + The POST method delivers a notification from API producer to an API consumer. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. parameters: - - name: vnfIndicatorValueChangeNotification - in: body - description: > - A notification about VNF indicator value changes. - required: true - schema: - $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIndicatorValueChangeNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFInNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + '/URI-is-provided-by-the-client-when-creating-the-subscription_SupportedIndicatorsChangeNotification': + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: summary: Test notification endpoint. - description: > + description: | Service Unavailable + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFInNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The GET method allows the server to test the notification endpoint that is provided - by the client, e.g. during subscription. + post: + summary: Notification endpoint + description: | + The API producer can use this resource to send notifications related to VNF indicator value changes to a + subscribed API consumer, which has provided the URI of this resource during the subscription process. + The POST method delivers a notification from API producer to an API consumer. The API consumer shall have + previously created an "Individual subscription" resource with a matching filter. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/SupportedIndicatorsChangeNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFInNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + +components: + requestBodies: + VnfIndicatorValueChangeNotification: + description: | + A notification about VNF indicator value changes. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification + required: true - Shall be returned when the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + SupportedIndicatorsChangeNotification: + description: | + A notification about changes of the set of supported indicators. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/SupportedIndicatorsChangeNotification + required: true + + responses: + VNFInNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFInNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml b/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml index 8c042ff3f407fa989ea90075669a42734449e000..8b90980c0c2cba45f578a5db17f95698388d2cdc 100644 --- a/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml +++ b/src/SOL002/VNFIndicatorNotification/definitions/SOL002VNFIndicatorNotification_def.yaml @@ -67,4 +67,74 @@ definitions: subscription: description: > Link to the related subscription. - $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link' \ No newline at end of file + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link' + + SupportedIndicatorsChangeNotification: + description: | + This type represents a notification to inform the receiver that the set of indicators supported by a VNF instance + has changed. + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - vnfInstanceId + properties: + id: + descriptions: | + Identifier of this notification. + If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these + notifications shall have the same value. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' + notificationType: + description: | + Discriminator for the different notification types. Shall be set to "SupportedIndicatorsChangeNotification" + for this notification type. + type: string + subscriptionId: + description: | + Identifier of the subscription that this notification relates to. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' + timeStamp: + description: | + Date-time of the generation of the notification. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime' + vnfInstanceId: + description: | + Identifier of the VNF instance which provides the indicator value. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier' + supportedIndicators: + description: | + Set of VNF indicators supported by the VNF instance. + type: array + items: + type: object + required: + - vnfIndicatorId + properties: + vnfIndicatorId: + description: | + Identifier of the VNF indicator whose value has changed. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf' + name: + description: | + Human readable name of the VNF indicator. Shall be present if defined in the VNFD. + ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. + type: string + _links: + description: | + Links for this resource. + type: object + required: + - subscription + properties: + vnfInstance: + description: | + Link to the related "Individual VNF instance" resource. Shall be present if the VNF instance information + is accessible as a resource. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink' + subscription: + description: | + Link to the related subscription. + $ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink' \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 51bbbc5c048d5f04d44de0e42ecf8222de1d4524..e05122db016268bb03a3503da03b875f786fcb8e 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -1,2411 +1,2396 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Lifecycle Management interface - description: > - SOL002 - VNF Lifecycle Management interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Lifecycle Management interface IMPORTANT: Please note that this file might be not aligned to the + current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /vnflcm/v1 - -schemes: - - http - - https + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/vnflcm/v1 + - url: https://127.0.0.1/vnflcm/v1 paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - - ############################################################################### - # VNF instances # - ############################################################################### - '/vnf_instances': - #SOL003 location: 5.4.2 + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions + + /vnf_instances: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 - post: - description: > - The POST method creates a new VNF instance resource. - parameters: - - name: createVnfRequest - description: > - The VNF creation parameters, as defined in clause 5.5.2.3. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: - 201: - description: > - 201 CREATED - - Shall be returned when a new "Individual VNF Instance" resource and - the associated VNF instance identifier has been created successfully. - The response body shall contain a representation of the created VNF - instance, as defined in clause 5.5.2.2. - The HTTP response shall include a "Location" HTTP header that contains - the resource URI of the created VNF instance. - 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 VNF instance - type: string - format: url - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > + description: | The GET method queries information about multiple VNF instances. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. All attribute names that appear in the VnfInstance - and in data types referenced from it shall be supported by the VNFM in the filter expression. - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the VnfInstance structure - in the response body if this parameter is provided, or none of the parameters - "all_fields," "fields", "exclude_fields", "exclude_default" are provided: - - vnfConfigurableProperties - - instantiatedVnfInfo - - metadata - - extensions - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports - alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK - - Information about zero or more VNF instances has been queried - successfully. The response body shall contain in an array the - representations of zero or more VNF instances. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - type: array - items: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual VNF instance # - ############################################################################### - '/vnf_instances/{vnfInstanceId}': - #SOL003 location: 5.4.3.2 + "200": + $ref: '#/components/responses/VnfInstances.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + post: + description: | + The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in "ENABLED" state. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfInstanceCreationRequest' + responses: + "201": + $ref: '#/components/responses/VnfInstances.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the response - to a POST request creating a new VNF instance resource. It can also - be retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > + description: | Information about a VNF instance by reading an "Individual VNF instance". responses: - 200: - description: > - 200 OK - - Information about an individual VNF instance has been read successfully. - The response body shall contain a representation of the VNF instance, - as defined in clause 5.5.2.2. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - patch: - #SOL003 location: 5.4.3.3.4 - description: > - This method modifies an "Individual VNF instance" resource. Changes to - the VNF configurable properties are applied to the configuration in - the VNF instance, and are reflected in the representation of this - resource. Other changes are applied to the VNF instance information - managed by the VNFM, and are reflected in the representation of this - resource - parameters: - - name: vnfInfoModifications - description: Input parameters for VNF info modification - required: true - in: body - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" - responses: - 202: - 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 an "Individual VNF LCM operation occurrence" resource - corresponding to the operation. - The response body shall be empty. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Error: The operation cannot be executed currently, due to a conflict with the state - # of the "Individual VNF instance" resource. - # Typically, this is due to the fact that another LCM operation is ongoing. - # The response body shall contain a ProblemDetails structure, in which the "detail" - # attribute should convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + "200": + $ref: '#/components/responses/IndividualVnfInstance.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + delete: - description: > + description: | This method deletes an "Individual VNF instance" resource. responses: - 204: - description: > - 204 NO CONTENT - - The "Individual VNF instance" resource and the associated VNF identifier were - deleted successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF instance" resource is in INSTANTIATED state. - # The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Instantiate VNF task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/instantiate': - #SOL003 location: 5.4.4.2 + "204": + $ref: '#/components/responses/IndividualVnfInstance.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + patch: + description: | + This method modifies an "Individual VNF instance" resource. Changes to the VNF configurable properties are + applied to the configuration in the VNF instance, and are reflected in the representation of this resource. + Other changes are applied to the VNF instance information managed by the VNFM, and are reflected in the + representation of this resource. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceModificationRequest' + responses: + "202": + $ref: '#/components/responses/IndividualVnfInstance.Patch' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "412": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/instantiate: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the response - to a POST request creating a new VNF instance resource. It can also - be retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - #SOL003 location: 5.4.4.3.1 - description: > + description: | The POST method instantiates a VNF instance. - parameters: - - name: InstantiateVnfRequest - description: Parameters for the VNF instantiation. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" + requestBody: + $ref: '#/components/requestBodies/VnfInstanceInstantiationRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF instance" resource is in INSTANTIATED state. - # The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Scale VNF task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/scale': - #SOL003 location: 5.4.5.2 + "202": + $ref: '#/components/responses/InstantiateVnfInstance.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/scale: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be scaled. This identifier can be - retrieved from the resource referenced by the "Location" HTTP header - in the response to a POST request creating a new VNF instance - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - #SOL003 location: 5.4.5.3.1 - description: > - The POST method requests to scale a VNF instance resource - incrementally. - parameters: - - name: ScaleVnfRequest - description: Parameters for the scale VNF operation. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest" + description: | + The POST method requests to scale a VNF instance resource incrementally. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceScaleRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "Individual VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Scale VNF to Level task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/scale_to_level': - #SOL003 location: 5.4.6.2 + "202": + $ref: '#/components/responses/ScaleVnfInstance.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/scale_to_level: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be scaled to a target level. This - identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new VNF instance resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - #SOL003 location: 5.4.6.3.1 - description: > - The POST method requests to scale a VNF instance resource to a target - level. - parameters: - - name: ScaleVnfToLevelRequest - description: Parameters for the scale VNF to Level operation. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest" + description: | + The POST method requests to scale a VNF instance resource to a target level. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceScaleToLevelRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Change VNF Flavour task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/change_flavour': - #SOL003 location: 5.4.7.2 + "202": + $ref: '#/components/responses/ScaleVnfInstanceToLevel.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/change_flavour: parameters: - - name: vnfInstanceId - description: > - The identifier of the VNF instance of which the deployment flavour - is requested to be changed. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the - response to a POST request creating a new VNF instance resource. It - can also be retrieved from the "id" attribute in the payload body of - that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > + description: | The POST method changes the deployment flavour of a VNF instance. - parameters: - - name: ChangeVnfFlavourRequest - description: Parameters for the Change VNF Flavour operation. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest" + requestBody: + $ref: '#/components/requestBodies/VnfInstanceChangeFlavourRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "Individual VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Terminate VNF task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/terminate': - #SOL003 location: 5.4.8.2 + "202": + $ref: '#/components/responses/VnfInstanceChangeFlavour.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/terminate: parameters: - - name: vnfInstanceId - description: > - The identifier of the VNF instance to be terminated. This identifier - can be retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new VNF instance - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method terminates a VNF instance. - parameters: - - name: TerminateVnfRequest - description: Parameters for the VNF termination. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest" + description: | + The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM the release of its + used virtualised resources. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceTerminationRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that contains the URI of the - newly-created "VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Heal VNF task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/heal': - #SOL003 location: 5.4.9.2 + "202": + $ref: '#/components/responses/TerminateVnfInstance.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/heal: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be healed. This identifier can be - retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new VNF instance - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > + description: | The POST method requests to heal a VNF instance. - parameters: - - name: HealVnfRequest - description: Parameters for the Heal VNF operation. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest" + requestBody: + $ref: '#/components/requestBodies/VnfInstanceHealRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "Individual VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 "Individual VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Operate VNF task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/operate': - #SOL003 location: 5.4.9.2 + "202": + $ref: '#/components/responses/HealVnfInstance.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/operate: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be operated. This identifier can - be retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new VNF instance - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > + description: | The POST method changes the operational state of a VNF instance. - parameters: - - name: OperateVnfRequest - description: Parameters for the Operate VNF operation. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest" + requestBody: + $ref: '#/components/requestBodies/VnfInstanceOperateRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 VNF 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Change external VNF connectivity task # - ############################################################################### - '/vnf_instances/{vnfInstanceId}/change_ext_conn': - #SOL003 location: 5.4.9.2 + "202": + $ref: '#/components/responses/OperateVnfInstance.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/change_ext_conn: parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance of which the external connectivity is - requested to be changed. This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a POST request creating a new VNF instance resource. It can also be - retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > + description: | The POST method changes the external connectivity of a VNF instance. - parameters: - - name: ChangeExtVnfConnectivityRequest - description: > - Parameters for the Change external VNF connectivity operation. - in: body - required: true - schema: - $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest" + requestBody: + $ref: '#/components/requestBodies/VnfInstanceChangeExtConnRequest' responses: - 202: - description: > - 202 ACCEPTED - - The request has been 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 "VNF LCM 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 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: > - Used in redirection, or when a new resource has been created. - This header field shall be present if the response status code is 201 or 3xx. - In the present document this header field is also used if the response status - code is 202 and a new resource was created. - type: string - format: url - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # 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 another lifecycle management operation is ongoing. - # The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # VNF LCM operation occurrences # - ############################################################################### - '/vnf_lcm_op_occs': - #SOL003 location: 5.4.12 + "202": + $ref: '#/components/responses/VnfInstanceChangeExtConn.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/change_vnfpkg: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + post: + description: | + The POST method changes the current VNF package on which the VNF instance is based. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceChangeVnfPkgRequest' + responses: + "202": + $ref: '#/components/responses/VnfInstanceChangeVnfPkg.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method to query status information about - multiple VNF lifecycle management operation occurrences. + description: | + The client can use this method to query status information about multiple VNF lifecycle management operation occurrences. parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM/VNF may supply this parameter. All attribute names that appear in the VnfLcmOpOcc - and in data types referenced from it shall be supported by the VNFM in the filter expression. - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the VnfLcmOpOcc structure - in the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - - operationParams - - error - - resourceChanges - - changedInfo - - changedExtConnectivity - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports - alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK - - Status information for zero or more VNF lifecycle management operation - occurrences has been queried successfully. - The response body shall contain in an array the status information - about zero or more VNF lifecycle operation occurrences, as defined in - clause 5.5.2.13. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP - header in this response shall follow the provisions in clause 5.4.2.3 - of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: > - The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual VNF LCM operation occurrence # - ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}': - #SOL003 location: 5.4.13 + "200": + $ref: '#/components/responses/VnfLcmOpOccs.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs/{vnfLcmOpOccId}: parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a PATCH or POST request - triggering a VNF LCM operation. It can also be retrieved from the - "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method to retrieve status information about a - VNF lifecycle management operation occurrence by reading an "Individual - VNF LCM operation occurrence" resource. + description: | + The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence + by reading an "Individual VNF LCM operation occurrence" resource. responses: - 200: - description: > - 200 OK - - Information about an individual VNF instance has been queried - successfully. The response body shall contain status information - about a VNF lifecycle management operation occurrence. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Retry operation task # - ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry': - #SOL003 location: 5.4.14 + "200": + $ref: '#/components/responses/IndividualVnfLcmOpOcc.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs/{vnfLcmOpOccId}/retry: parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - retried. This identifier can be retrieved from the resource - referenced by the "Location" HTTP header in the response to a PATCH - or POST request triggering a VNF LCM operation. It can also be - retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method initiates retrying a VNF lifecycle operation if that - operation has experienced a temporary failure, i.e. the related - "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" - state. + description: | + The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary + failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. responses: - 202: - description: > - 202 ACCEPTED - - The request has been accepted for processing, but processing has - not been completed. - The response shall have an empty payload body. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Error: The operation cannot be executed currently, due to a conflict with the state of - # the VNF LCM operation occurrence resource. - # Typically, this is due to the fact that the VNF LCM operation occurrence 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Rollback operation task # - ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback': - #SOL003 location: 5.4.15 + "202": + $ref: '#/components/responses/VnfLcmOpOccRetry.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback: parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be rolled back. This identifier can be retrieved from the resource - referenced by the "Location" HTTP header in the response to a PATCH - or POST request triggering a VNF LCM operation. It can also be - retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method initiates rolling back a VNF lifecycle operation if - that operation has experienced a temporary failure, i.e. the related - "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" - state. + description: | + The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary + failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. responses: - 202: - description: > - 202 ACCEPTED - - The request has been accepted for processing, but processing has not been completed. - The response shall have an empty payload body. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Error: The operation cannot be executed currently, due to a conflict with the state of - # the VNF LCM operation occurrence resource. - # Typically, this is due to the fact that the VNF LCM operation occurrence 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Fail operation task # - ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail': - #SOL003 location: 5.4.16 + "202": + $ref: '#/components/responses/VnfLcmOpOccRollback.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs/{vnfLcmOpOccId}/fail: parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be marked as "failed". This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a PATCH or POST request triggering a VNF LCM operation. It can also - be retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method marks a VNF lifecycle management operation occurrence - as "finally failed" if that operation occurrence is in "FAILED_TEMP" - state. + description: | + The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation + occurrence is in "FAILED_TEMP" state. responses: - 200: - description: > - 200 OK - - The state of the VNF lifecycle management operation occurrence has - been changed successfully. The response shall include a representation - of the "Individual VNF lifecycle operation occurrence" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Error: The operation cannot be executed currently, due to a conflict with the state of - # the VNF LCM operation occurrence resource. - # Typically, this is due to the fact that the VNF LCM operation occurrence 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 shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Cancel operation task # - ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel': - #SOL003 location: 5.4.17 + "200": + $ref: '#/components/responses/VnfLcmOpOccFail.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel: parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be cancelled. This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a PATCH or POST request triggering a VNF LCM operation. It can also - be retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: cancelMode - description: > - The POST request to this resource shall include a CancelMode - structure in the payload body to choose between "graceful" and - "forceful" cancellation. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelMode" + - $ref: '#/components/parameters/VnfLcmOpOccId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > - The POST method initiates cancelling an ongoing VNF lifecycle - operation while it is being executed or rolled back, i.e. the related - "Individual VNF LCM operation occurrence" is either in "PROCESSING" or - "ROLLING_BACK" state. + description: | + The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled + back, i.e. the related "Individual VNF LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state. responses: - 202: - description: > - 202 ACCEPTED - - The request has been accepted for processing, but processing has not - been completed. - The response shall have an empty payload body. - headers: - #TODO: Add headers defined in 4.3.4.3 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - # description: > - # 409 CONFLICT - - # Error: The operation cannot be executed currently, due to a conflict with the state of - # the VNF LCM operation occurrence resource. - # Typically, this is due to the fact that the operation occurrence is not in STARTING, - # PROCESSING or ROLLING_BACK state. - # The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Subscriptions # - ############################################################################### - '/subscriptions': - #SOL003 location: 5.4.18 + "202": + $ref: '#/components/responses/VnfLcmOpOccCancel.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /subscriptions: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method queries the list of active subscriptions of the functional block that invokes the method. It can + be used e.g. for resynchronization after error situations. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + "200": + $ref: '#/components/responses/Subscriptions.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + post: - description: > + description: | The POST method creates a new subscription. - parameters: - - name: LccnSubscriptionRequest - description: > - Details of the subscription to be created. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest" + requestBody: + $ref: '#/components/requestBodies/VnfLcmSubscriptionRequest' + responses: + "201": + $ref: '#/components/responses/Subscriptions.Post' + "303": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /subscriptions/{subscriptionId}: + parameters: + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method retrieves information about a subscription by reading an "Individual subscription" resource. + responses: + "200": + $ref: '#/components/responses/IndividualSubscription.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + delete: + description: | + The DELETE method terminates an individual subscription. responses: - 201: - description: > - 201 CREATED - - The subscription has been created successfully. The response body shall - contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual subscription" resource. - 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 VNF 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: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" - 303: - # description: > - # 303 SEE OTHER - - # A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM - # is to not create redundant subscriptions. - # The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing - # subscription resource. - # The response body shall be empty. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + "204": + $ref: '#/components/responses/IndividualSubscription.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/create_snapshot: + parameters: + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + post: + description: | + The POST method requests tacking a VNF instance snapshot and populating a previously created VNF snapshot resource + (refer to clause 5.4.23.3.1) with the snapshot content. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceCreateSnapshotRequest' + responses: + "202": + $ref: '#/components/responses/VnfInstanceCreateSnapshot.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_instances/{vnfInstanceId}/revert_to_snapshot: + parameters: + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + post: + description: | + The POST method requests reverting a VNF/VNFC instance to a VNF/VNFC snapshot. + requestBody: + $ref: '#/components/requestBodies/VnfInstanceRevertToSnapshotRequest' + responses: + "202": + $ref: '#/components/responses/VnfInstanceRevertToSnapshot.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_snapshots: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + post: + description: | + The POST method creates a new individual VNF snapshot resource. + requestBody: + $ref: '#/components/requestBodies/VnfSnapshotsRequest' + responses: + "201": + $ref: '#/components/responses/VnfSnapshots.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + get: - description: > - The GET method queries the list of active subscriptions of the - functional block that invokes the method. It can be used e.g. for - resynchronization after error situations. + description: | + The GET method queries information about multiple VNF/VNFC snapshots. parameters: - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. All attribute names that appear in the LccnSubscription - and in data types referenced from it shall be supported by the VNFM in the filter expression. - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container - - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] - - Request 2: - GET …/container?filter=(eq.weight,100) - - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports - alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK - - The list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active subscriptions - of the functional block that invokes the method, i.e. zero or more representations of lifecycle - change notification subscriptions as defined in clause 5.5.2.16. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual subscription # - ############################################################################### - '/subscriptions/{subscriptionId}': - #SOL003 location: 5.4.19 + "200": + $ref: '#/components/responses/VnfSnapshots.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_snapshots/{vnfSnapshotInfoId}: parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by - the "Location" HTTP header in the response to a POST request - creating a new subscription resource. It can also be retrieved from - the "id" attribute in the payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: '#/components/parameters/VnfSnapshotInfoId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method retrieves information about a subscription by reading - an "Individual subscription" resource. + description: | + The GET method retrieves information about a VNF /VNFC snapshot by reading an individual VNF snapshot resource. responses: - 200: - description: > - 200 OK - - The operation has completed successfully. - The response body shall contain a representation of the - "Individual subscription" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + "200": + $ref: '#/components/responses/IndividualVnfSnapshot.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + delete: - description: > - The DELETE method terminates an individual subscription. + description: | + This method deletes an individual VNF snapshot resource and the associated VNF snapshot information managed by + the VNFM, and any resource associated to the VNF/VNFC snapshot managed by the VIM. responses: - 204: - description: > - 204 NO CONTENT - - The "Individual subscription" resource has been deleted successfully. - The response body shall be empty. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + "200": + $ref: '#/components/responses/IndividualVnfSnapshot.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + +components: + parameters: + VnfInstanceId: + name: vnfInstanceId + in: path + description: | + Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" + HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved + from the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + VnfLcmOpOccId: + name: vnfLcmOpOccId + in: path + description: | + Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource + referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. + It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification. + required: true + style: simple + explode: false + schema: + type: string + + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" + HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from + the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + VnfSnapshotInfoId: + name: vnfSnapshotInfoId + in: path + description: | + Identifier of the individual VNF snapshot resource. This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a new VNF snapshot resource. It can also be + retrieved from the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + VnfInstanceCreationRequest: + description: | + The VNF creation parameters, as defined in clause 5.5.2.3. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest + required: true + + VnfInstanceModificationRequest: + description: Input parameters for VNF info modification + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest + required: true + + VnfInstanceInstantiationRequest: + description: Parameters for the VNF instantiation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest + required: true + + VnfInstanceScaleRequest: + description: Parameters for the scale VNF operation. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest + required: true + + VnfInstanceScaleToLevelRequest: + description: Parameters for the scale VNF to Level operation. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest + required: true + + VnfInstanceChangeFlavourRequest: + description: Parameters for the Change VNF Flavour operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest + required: true + + VnfInstanceTerminationRequest: + description: Parameters for the VNF termination. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest + required: true + + VnfInstanceHealRequest: + description: Parameters for the Heal VNF operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest + required: true + + VnfInstanceOperateRequest: + description: Parameters for the Operate VNF operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest + required: true + + VnfInstanceChangeExtConnRequest: + description: | + Parameters for the Change external VNF connectivity operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest + required: true + + VnfInstanceChangeVnfPkgRequest: + description: | + Parameters for the Change current VNF package operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest + required: true + + VnfLcmSubscriptionRequest: + description: | + Details of the subscription to be created. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest + required: true + + VnfInstanceCreateSnapshotRequest: + description: | + Parameters for the “Create VNF/VNFC Snapshot” operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotRequest + required: true + + VnfInstanceRevertToSnapshotRequest: + description: | + Parameters for the Revert-to VNF/VNFC snapshot operation. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest + required: true + + VnfSnapshotsRequest: + description: | + The VNF snapshot resource creation parameters. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotInfoRequest + required: true + + responses: + VnfInstances.Get: + description: | + 200 OK + Information about zero or more VNF instances has been queried successfully. The response body shall contain in + an array the representations of zero or more VNF instances. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance + + VnfInstances.Post: + description: | + 201 CREATED + Shall be returned when a new "Individual VNF Instance" resource and the associated VNF instance identifier + has been created successfully. The response body shall contain a representation of the created VNF instance, + as defined in clause 5.5.2.2. The HTTP response shall include a "Location" HTTP header that contains the + resource URI of the created VNF instance. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + The resource URI of the created VNF instance + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance + + IndividualVnfInstance.Get: + description: | + 200 OK + Information about an individual VNF instance has been read successfully. The response body shall contain a + representation of the VNF instance, as defined in clause 5.5.2.2. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance + + IndividualVnfInstance.Delete: + description: | + 204 NO CONTENT + The "Individual VNF instance" resource and the associated VNF identifier were deleted successfully. + The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification + + IndividualVnfInstance.Patch: + 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 an "Individual + VNF LCM operation occurrence" resource corresponding to the operation. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + InstantiateVnfInstance.Post: + description: | + 202 ACCEPTED + The request has been 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + ScaleVnfInstance.Post: + description: | + 202 ACCEPTED + The request has been 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 "Individual VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + ScaleVnfInstanceToLevel.Post: + description: | + 202 ACCEPTED + The request has been 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 + "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceChangeFlavour.Post: + description: | + 202 ACCEPTED + The request has been 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 "Individual VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + TerminateVnfInstance.Post: + description: | + 202 ACCEPTED + The request has been accepted for processing. The response body shall be empty. The HTTP response shall include + a "Location" HTTP header that contains the URI of the newly-created "Individual VNF LCM operation occurrence" + resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + HealVnfInstance.Post: + description: | + 202 ACCEPTED + The request has been 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 "Individual VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + OperateVnfInstance.Post: + description: | + 202 ACCEPTED + The request has been 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceChangeExtConn.Post: + description: | + 202 ACCEPTED + The request has been 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceChangeVnfPkg.Post: + description: | + 202 ACCEPTED + Shall be returned when the request has been accepted for processing. + The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI + of the newly-created "Individual VNF LCM operation occurrence" resource corresponding to the instantiation operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfLcmOpOccs.Get: + description: | + 200 OK + Status information for zero or more VNF lifecycle management operation occurrences has been queried + successfully. The response body shall contain in an array the status information about zero or more VNF + lifecycle operation occurrences, as defined in clause 5.5.2.13. If the VNFM supports alternative 2 (paging) + according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in + this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + + IndividualVnfLcmOpOcc.Get: + description: | + 200 OK + Information about an individual VNF instance has been queried successfully. The response body shall contain + status information about a VNF lifecycle management operation occurrence. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + + VnfLcmOpOccRetry.Post: + description: | + 202 ACCEPTED + The request has been accepted for processing, but processing has not been completed. The response shall + have an empty payload body. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VnfLcmOpOccRollback.Post: + description: | + 202 ACCEPTED + The request has been accepted for processing, but processing has not been completed. The response shall have + an empty payload body. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VnfLcmOpOccFail.Post: + description: | + 200 OK + The state of the VNF lifecycle management operation occurrence has been changed successfully. The response + shall include a representation of the "Individual VNF lifecycle operation occurrence" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc + + VnfLcmOpOccCancel.Post: + description: | + 202 ACCEPTED + The request has been accepted for processing, but processing has not been completed. The response shall + have an empty payload body. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + Subscriptions.Get: + description: | + 200 OK + The list of subscriptions has been queried successfully. The response body shall contain in an array the + representations of all active subscriptions of the functional block that invokes the method, i.e. zero or + more representations of lifecycle change notification subscriptions as defined in clause 5.5.2.16. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription + + Subscriptions.Post: + description: | + 201 CREATED + The subscription has been created successfully. The response body shall contain a representation of the + created "Individual subscription" resource. The HTTP response shall include a "Location" HTTP header that points + to the created "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: The resource URI of the created VNF instance + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription + + IndividualSubscription.Get: + description: | + 200 OK + The operation has completed successfully. The response body shall contain a representation of the + "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription + + IndividualSubscription.Delete: + description: | + 204 NO CONTENT + The "Individual subscription" resource has been deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VnfInstanceCreateSnapshot.Post: + description: | + 202 ACCEPTED + Shall be returned when 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfInstanceRevertToSnapshot.Post: + description: | + 202 ACCEPTED + Shall be returned when 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: {} + + VnfSnapshots.Post: + description: | + 202 CREATED + Shall be returned when an individual VNF snapshot resource has been created successfully. + The response body shall contain a representation of the new individual VNF snapshot resource, as defined in + clause 5.5.2.21. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the + individual VNF snapshot resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + Used in redirection, or when a new resource has been created. This header field shall be present if the + response status code is 201 or 3xx. In the present document this header field is also used if the response + status code is 202 and a new resource was created. + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo + + VnfSnapshots.Get: + description: | + 200 OK + Shall be returned when information about zero or more VNF snapshots was queried successfully. + The response body shall contain in an array the representations of zero or more individual VNF + snapshot resources, as defined in clause 5.5.2.21. + + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo + + IndividualVnfSnapshot.Get: + description: | + Shall be returned when information about an individual VNF snapshot was read successfully. + The response body shall contain a representation of the individual VNF snapshot resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo + + IndividualVnfSnapshot.Delete: + description: | + 204 NO CONTENT + The "Individual subscription" resource has been deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml index 61385094147c5f0e2e2e68a0c4e08079aa9914e9..048d434e6906a1a0972271d97b0882740eae75a3 100644 --- a/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml +++ b/src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml @@ -13,7 +13,6 @@ definitions: - vnfProductName - vnfSoftwareVersion - vnfdVersion - - vnfPkgInfoId - instantiationState - _links properties: @@ -60,12 +59,6 @@ definitions: description: > Identifies the version of the VNFD. The value is copied from the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" - vnfPkgId: - description: > - Identifier of information held by the NFVO about the specific VNF - package on which the VNF is based. This identifier was allocated by the - NFVO. This attribute can be modified with the PATCHmethod. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfConfigurableProperties: description: > Additional VNF-specific attributes that provide the current values @@ -119,7 +112,6 @@ definitions: - flavourId - vnfState - extCpInfo - - _links properties: flavourId: description: > @@ -145,7 +137,9 @@ definitions: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo" extCpInfo: description: > - Information about the external CPs exposed by the VNF instance. + Information about the external CPs exposed by the VNF instance. When trunking is enabled, the list of + entries includes both, external CPs corresponding to parent ports of a trunk, and external CPs associated + to sub-ports of a trunk. type: array minItems: 1 items: @@ -159,9 +153,13 @@ definitions: extManagedVirtualLinkInfo: description: > External virtual links the VNF instance is connected to. + It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a + multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same + VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed + multi-site VL instance (refer to clause 5.5.3.5). type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo" + $ref: "#/definitions/ExtManagedVirtualLinkInfo" monitoringParameters: description: > Active monitoring parameters. @@ -182,20 +180,26 @@ definitions: by the VNFCs of the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo" - virtualLinkResourceInfo: + $ref: "#/definitions/VnfcResourceInfo" + vnfVirtualLinkResourceInfo: description: > Information about the virtualised network resources used by the VLs of the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo" - virtualStorageResourceInfo: + $ref: "#/definitions/VnfVirtualLinkResourceInfo" + vnfVirtualStorageResourceInfo: description: > Information on the virtualised storage resource(s) used as storage for the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo" + $ref: "#/definitions/VirtualStorageResourceInfo" + vnfcInfo: + description: > + Information about the VNFC instances. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo" metadata: description: > Additional VNF-specific attributes that provide metadata describing the VNF instance. @@ -306,6 +310,18 @@ definitions: operation is possible based on the current status of this VNF instance resource (i.e. VNF instance is in INSTANTIATED state). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + createSnapshot: + description: > + Link to the "Create VNF snapshot task" resource, if the related operation is + supported for this VNF instance and is possible based on the current status of + this VNF instance resource (i.e., VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + revertToSnapshot: + description: > + Link to the "Revert to VNF snapshot task" resource, if the related operation is + supported for this VNF instance and is possible based on the current status of this + VNF instance resource (i.e., VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" InstantiateVnfRequest: type: object @@ -331,9 +347,13 @@ definitions: extManagedVirtualLinks: description: > Information about external VLs to connect the VNF to. + The indication of externally-managed internal VLs is needed in case networks have been pre-configured for + use with certain VNFs, for instance to ensure that these networks have certain properties such as security + or acceleration features, or to address particular network topologies. The present document assumes that + externally-managed internal VLs are managed by the NFVO and created towards the VIM. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" + $ref: "#/definitions/ExtManagedVirtualLinkData" localizationLanguage: description: > Localization language of the VNF to be instantiated. The value shall @@ -347,18 +367,15 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" extensions: description: > - If present, this attribute provides values for the "extensions" attribute in "VnfInstance", - as defined in clause 5.5.2.2. If an entry with the same key exists in the VnfInstance data structure, - the VNFM shall replace its value with the value passed in the InstantiateVnfRequest data structure. + If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the + "extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling extensions + during the operation are defined in clause 5.4.4.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vnfConfigurableProperties: description: > - This parameter provides values for the VNF configurable - properties attribute in the "VnfInstance", as defined in - clause 5.5.2.2. If an entry with the same key exists in the - VnfInstance data structure, the VNFM shall replace its - value with the value passed in the InstantiateVnfRequest - data structure. + If present, this attribute provides modifications to the default values, as obtained from the VNFD, of the + “vnfConfigurableProperties” attribute in the "VnfInstance", as defined in clause 5.5.2.2. + Provisions for handling configurable properties during the operation are defined in clause 5.4.4.3.1. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ChangeVnfFlavourRequest: @@ -387,15 +404,31 @@ definitions: extManagedVirtualLinks: description: > Information about external VLs to connect the VNF to. + The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use + with certain VNFs, for instance to ensure that these networks have certain properties such as security or + acceleration features, or to address particular network topologies. The present document assumes that + externally-managed internal VLs are managed by the NFVO and created towards the VIM. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" + $ref: "#/definitions/ExtManagedVirtualLinkData" additionalParams: description: > Additional input parameters for the instantiation process, specific to the VNF being instantiated, as declared in the VNFD as part of "InstantiateVnfOpConfig". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance", + as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, are defined in clause + 5.4.7.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfConfigurableProperties: + description: > + If present, this attribute provides modifications to the values of the “vnfConfigurableProperties” attribute in + "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the + operation, are defined in clause 5.4.7.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" TerminateVnfRequest: type: object @@ -406,11 +439,24 @@ definitions: description: > Indicates the type of termination is requested. Permitted values: - * FORCEFUL: The VNFM will shut down the VNF and release the - resources immediately after accepting the request. + * FORCEFUL: The VNFM will shut down the VNF and release the resources immediately after accepting the request. + * GRACEFUL: The VNFM will first arrange to take the VNF out of service after accepting the request. Once the + operation of taking the VNF out of service finishes (irrespective of whether it has succeeded or failed) or + once the timer value specified in the "gracefulTerminationTimeout" attribute expires, the VNFM will shut down + the VNF and release the resources. type: string enum: - FORCEFUL + - GRACEFUL + gracefulTerminationTimeout: + description: > + This attribute is only applicable in case of graceful termination. It defines the time to wait for the VNF to be + taken out of service before shutting down the VNF and releasing the resources. + The unit is seconds. If not given and the "terminationType" attribute is set to "GRACEFUL", it is expected that + the VNFM waits for the successful taking out of service of the VNF, no matter how long it takes, before shutting + down the VNF and releasing the resources. + type: integer + additionalParams: description: > Additional parameters passed by the NFVO as input to the termination @@ -423,7 +469,9 @@ definitions: properties: vnfcInstanceId: description: > - List of VNFC instances requiring a healing action. + List of identifiers of VNFC instances for which a healing action is requested. Each identifier references the + "id" attribute in a "VnfcInfo" structure. Cardinality can be "0" to denote that the request applies to the + whole VNF and not a specific VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" @@ -452,8 +500,8 @@ definitions: properties: vnfcInstanceId: description: > - Identifier of VNFC instances. Cardinality can be "0" to denote - that the request applies to the whole VNF and not a specific VNFC instance. + List of identifiers of VNFC instances. Each identifier references the "id" attribute in a "VnfcInfo" structure. + Cardinality can be "0" to denote that the request applies to the whole VNF and not a specific VNFC instance. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" @@ -465,12 +513,27 @@ definitions: stopType: description: > It signals whether forceful or graceful stop is requested. - Ignored if changeStateTo=STARTED. - Permitted values: - FORCEFUL: The VNFM will stop down the VNF or the affected VNFCs immediately after accepting the request. + The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is + equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to + "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be + absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to + "FORCEFUL". The request shall be treated as if the "stopType" attribute has been set to "FORCEFUL", when the + "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent. type: string enum: - FORCEFUL + - GRACEFUL + gracefulStopTimeout: + description: > + The time interval (in seconds) to wait for the VNF to be taken out of service during graceful stop, + before stopping the VNF. + The "stopType" and "gracefulStopTimeout" attributes shall be absent, when the "changeStateTo" attribute is + equal to "STARTED". The "gracefulStopTimeout" attribute shall be present, when the "changeStateTo" is equal to + "STOPPED" and the "stopType" attribute is equal to "GRACEFUL". The "gracefulStopTimeout" attribute shall be + absent, when the "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is equal to + "FORCEFUL". The request shall be treated as if the "stopType" attribute has been set to "FORCEFUL", when the + "changeStateTo" attribute is equal to "STOPPED" and the "stopType" attribute is absent. + type: integer additionalParams: description: > Additional parameters passed by the NFVO as input to the process, @@ -500,6 +563,53 @@ definitions: "ChangeExtVnfConnectivityOpConfig".". $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + ChangeCurrentVnfPkgRequest: + description: > + This type represents request parameters for the "Change current VNF package" operation to replace the VNF package + on which a VNF instance is based. + type: object + required: + - vnfdId + properties: + vnfdId: + description: > + Identifier of the VNFD which defines the destination VNF Package for the change. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + extVirtualLinks: + description: > + Information about external VLs to connect the VNF to. Entries in the list that are unchanged need not be + supplied as part of this request. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + extManagedVirtualLinks: + description: > + Information about internal VLs that are managed by other entities than the VNFM. + The indication of externally-managed internal VLs is needed in case networks have been pre-configured for use + with certain VNFs, for instance to ensure that these networks have certain properties such as security or + acceleration features, or to address particular network topologies. The present document assumes that + externally-managed internal VLs are managed by the NFVO and created towards the VIM. + type: array + items: + $ref: "#/definitions/ExtManagedVirtualLinkData" + additionalParams: + description: > + Additional parameters passed by the EM as input to the process, specific to the VNF of which the underlying + VNF package is changed, as declared in the VNFD as part of "ChangeCurrentVnfPkgOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + descriptions: > + If present, this attribute provides modifications to the values of the "extensions" attribute in "VnfInstance", + as defined in clause 5.5.2.2. Provisions for handling extensions during the operation, and needed passed + parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfConfigurableProperties: + description: > + If present, this attribute provides modifications to the values of the “vnfConfigurableProperties” attribute + in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the + operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + VnfInfoModificationRequest: description: > This type represents attribute modifications for an "Individual VNF instance" resource, @@ -546,10 +656,1056 @@ definitions: type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications" - vnfcInfoModificationsDeleteIds: + + CreateVnfSnapshotRequest: + description: > + This type represents request parameters for the "Create VNF Snapshot" operation. + type: object + required: + - vnfSnapshotResId + properties: + vnfSnapshotInfoId: + description: > + Identifier of the individual VNF snapshot resource to which the VNF Snapshot is to be associated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcInstanceId: + description: > + Identifier of the VNFC instance to be snapshotted. Each identifier references the "id" attribute in a + "VnfcInfo" structure. If this attribute is provided, only a snapshot of the referred VNFC instance shall + be created. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + additionalParams: + description: > + Additional input parameters for the snapshot creation process, specific for the VNF being “snapshotted”, + as declared in the VNFD as part of "CreateSnapshotVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + userDefinedData: + description: > + User defined data for the VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + RevertToVnfSnapshotRequest: + description: > + This type represents request parameters for the "Revert-to VNF Snapshot" operation. + type: object + properties: + vnfSnapshotInfoId: + description: > + Identifier of the “individual VNF snapshot” resource with the information of the VNF snapshot to be reverted to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcInstanceId: + description: > + List of identifiers of the VNFC instance to be reverted. Each identifier references the "id" attribute in a + "VnfcInfo" structure. Shall be present if the request is for reverting a specific VNFC instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcSnapshotInfoId: + description: > + Identifier of the VNFC snapshot information with the information of the VNFC snapshot to be reverted to. + Shall only be present if the "vnfcInstanceId" is present. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + additionalParams: + description: > + Additional input parameters for the revert to VNF snapshot process, specific for the VNF being “reverted”, + as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + CreateVnfSnapshotInfoRequest: + description: | + This type represents request parameters for the creation of an "Individual VNF snapshot" resource which can be + populated with content obtained by invoking the "Create VNF snapshot" LCM operation or extracted from a VNF + snapshot package. It shall comply with the provisions defined in table 5.5.2.20-1. + type: object + properties: + vnfSnapshotPkgId: + description: | + Identifier of the VNF snapshot package information held by the NFVO. + The present attribute shall be provided if the "Individual VNF snapshot" resource is requested to be created + and be filled from a VNF snapshot package extraction. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + + VnfSnapshotInfo: + description: > + This type represents an individual VNF snapshot resource. + type: object + required: + - id + properties: + id: + description: > + Identifier of the individual VNF snapshot resource. This identifier is allocated by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshotPkgId: + description: | + Identifier of the VNF snapshot package information held by the EM. Shall be present when the + “Individual VNF snapshot" resource is created from a VNF snapshot package extraction. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshot: + description: > + Information about the VNF snapshot, content and/or references to its content. Shall be present when the + individual VNF snapshot resource is associated to a VNF snapshot created via the corresponding "Create VNF + snapshot" task resource or extracted from a VNF snapshot package. + $ref: '#/definitions/VnfSnapshot' + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + takenFrom: + description: > + Link to the VNF instance from which this snapshot was taken. Shall be present when the "Individual VNF + snapshot" resource is associated to a VNF snapshot created via the corresponding "Create VNF snapshot" + task resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + VnfSnapshot: + description: > + This type represents a VNF snapshot. + type: object + required: + - id + - vnfInstanceId + - triggeredAt + - vnfdId + - vnfInfo + - vnfcSnapshots + properties: + id: + description: > + Identifier of the VNF Snapshot. This identifier is allocated by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstanceId: + description: > + Identifier of the snapshotted VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + creationStartedAt: + description: > + Timestamp indicating when the VNF snapshot creation has been started by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + creationFinishedAt: + description: > + Timestamp indicating when the VNF snapshot has been completed by the VNFM. + Shall be present once the VNF snapshot creation has been completed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfdId: + description: > + Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstance: + description: > + VNF Instance information of the snapshotted VNF instance. This is a copy of the individual VNF instance resource. + $ref: '#/definitions/VnfInstance' + vnfcSnapshots: + description: > + Information about VNFC snapshots constituting this VNF snapshot. + type: array + items: + $ref: '#/definitions/VnfcSnapshotInfo' + userDefinedData: + description: > + User defined data for the VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfcSnapshotInfo: + description: > + This type represents a VNFC snapshot. + type: object + required: + - id + - vnfcInstanceId + - triggeredAt + - vnfcInfo + properties: + id: + description: > + Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by + the VNFM and is unique within the scope of a VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcInstanceId: + description: > + Identifier of the snapshotted VNFC instance. + The identifier references the "id" attribute in a "VnfcInfo" structure. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + creationStartedAt: + description: > + Timestamp indicating when the VNF snapshot creation has been started by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + creationFinishedAt: + description: > + Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot + creation has been completed by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfcResourceInfoId: + description: > + Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resources of + the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute of the + "VnfSnapshot" structure. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfo" + computeSnapshotResource: + description: > + Reference to a compute snapshot resource. The identifier of the compute snapshot resource is + assigned during creation of a VNFC snapshot being returned from the VIM as output data in the response message + of the individual resource operations. This attribute shall only be present for a VNFC snapshot that has been + newly created by the VNFM as a result of the "Create VNF snapshot task". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + storageSnapshotResources: + description: > + Mapping of the storage resources associated to the VNFC with the storage snapshot resources. + type: object + required: + - storageResourceId + properties: + storageResourceId: + description: > + Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure that represents + the virtual storage resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + storageSnapshotResource: + description: > + Reference to a storage snapshot resource. The identifier of the storage snapshot resource is assigned during + creation of a VNFC snapshot being returned from the VIM as output data in the response message of the individual + resource operations. This attribute shall only be present for a VNFC snapshot with an associated storage resource + and that has been newly created by the VNFM as a result of the "Create VNF snapshot task". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + userDefinedData: + description: > + User defined data for the VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + StopType: + description: > + The enumeration StopType. + * FORCEFUL: The VNFM will stop the VNF instance or VNFC instance(s) immediately after accepting the request. + * GRACEFUL: The VNFM will first arrange to take the VNF instance or VNFC instance(s) out of service after accepting + the request. Once that operation is successful or once the timer value specified in the "gracefulStopTimeout" + attribute expires, the VNFM will stop the VNF instance or VNFC instance(s). + type: string + enum: + - FORCEFUL + - GRACEFUL + + ExtManagedVirtualLinkData: + type: object + required: + - id + - virtualLinkDescId + - resourceId + properties: + id: + description: > + The identifier of the externally-managed internal VL instance. The + identifier is assigned by the NFV-MANO entity that manages this VL + instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfVirtualLinkDescId: + description: > + The identifier of the VLD in the VNFD for this VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vimConnectionId: + description: > + Identifier of the VIM connection to manage this resource. This + attribute shall only be supported and present if VNF-related + resource management in direct mode is applicable. + $ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003_def.yaml#/definitions/Identifier" + resourceId: + description: > + The identifier of the resource in the scope of the VIM or the + resource provider. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" + + ExtManagedVirtualLinkInfo: + type: object + required: + - id + - vnfVirtualLinkDescId + - networkResource + properties: + id: + description: > + Identifier of the externally-managed internal VL and the related + externally-managed VL information instance. + The identifier is assigned by the NFV-MANO entity that manages this + VL instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfVirtualLinkDescId: + description: > + Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + networkResource: + description: > + Reference to the VirtualNetwork resource providing this VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + vnfLinkPorts: + description: > + Link ports of this VL. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" + + VnfcResourceInfo: + description: > + This type represents the information on virtualised compute and storage + resources used by a VNFC in a VNF instance. + type: object + required: + - id + - vduId + - computeResource + - vnfcCpInfo + properties: + id: + description: > + Identifier of this VnfcResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vduId: + description: > + Reference to the applicable VDU in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + computeResource: + description: > + Reference to the VirtualCompute resource. + $ref: "../../../definitions/SOL002SOL003_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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcCpInfo: + description: > + All the CPs of the VNFC instance. + Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance + or is connected to an external CP of the VNF instance. + A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. + A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. + May be present otherwise. + type: array + items: + type: object + required: + - id + - cpdId + properties: + id: + description: > + Identifier of this VNFC CP instance and the associated array + entry. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + cpdId: + description: > + Identifier of the VDU CPD, cpdId, in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfExtCpId: + description: > + Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of + the VNF instance or connected to an external CP of the VNF instance (see note) and shall be absent otherwise. + + NOTE: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes + an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + cpProtocolInfo: + description: > + Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. + The information can be omitted because it is already available as part of the external CP information. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CpProtocolInfo" + vnfLinkPortId: + description: > + Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if + the CP is associated to a link port on an internal VL of the VNF instance and shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + metadata: + description: > + Metadata about this CP. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + Metadata about this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfVirtualLinkResourceInfo: + description: > + This type represents the information that allows addressing a virtualised + resource that is used by an internal VL instance in a VNF instance. + type: object + required: + - id + - vnfVirtualLinkDescId + - networkResource + - vnfLinkPorts + properties: + id: + description: > + Identifier of this VnfVirtualLinkResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfVirtualLinkDescId: + description: > + Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + networkResource: + description: > + Reference to the VirtualNetwork resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfLinkPorts: + description: > + Links ports of this VL. + Shall be present when the linkPort is used for external connectivity + by the VNF (refer to VnfLinkPortInfo). + May be present otherwise. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" + metadata: + description: > + Metadata about this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VirtualStorageResourceInfo: + description: > + This type represents the information that allows addressing a virtualised + resource that is used by a VNF instance. + type: object + required: + - id + - virtualStorageDescId + - storageResource + properties: + id: + description: > + Identifier of this VirtualStorageResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + virtualStorageDescId: + description: > + Identifier of the VirtualStorageDesc in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + storageResource: + description: > + Reference to the VirtualStorage resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + metadata: + description: > + Metadata about this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + AffectedVnfc: + description: > + This type provides information about added, deleted, modified and + temporary VNFCs. + type: object + required: + - id + - vduId + - changeType + - computeResource + properties: + id: + description: > + Identifier of the Vnfc instance, identifying the applicable + "vnfcResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vduId: + description: > + Identifier of the related VDU in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected VNFC instance is + associated to a VDU which is referred from the source or destination VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: + description: > + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + For a temporary resource, an AffectedVnfc structure exists as long + as the temporary resource exists. + type: string + enum: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + computeResource: + description: > + Reference to the VirtualCompute resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_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 VnfcResourceInfo structure. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + affectedVnfcCpIds: + description: > + Identifiers of CP(s) of the VNFC instance that were affected by the + change. + Shall be present for those affected CPs of the VNFC instance that + are associated to an external CP of the VNF instance. + May be present for further affected CPs of the VNFC instance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + addedStorageResourceIds: + description: > + References to VirtualStorage resources that have been added. Each + value refers to a VirtualStorageResourceInfo item in the + VnfInstance that was added to the VNFC. It shall be provided if at + least one storage resource was added to the VNFC. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + removedStorageResourceIds: + description: > + References to VirtualStorage resources that have been removed. + The value contains the identifier of a VirtualStorageResourceInfo + item that has been removed from the VNFC, and might no longer exist + in the VnfInstance. + It shall be provided if at least one storage resource was removed + from the VNFC. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + + AffectedVirtualLink: + description: > + This type provides information about added, deleted, modified and + temporary VLs, and added or removed VNF link ports. + type: object + required: + - id + - vnfVirtualLinkDescId + - changeType + - networkResource + properties: + id: + description: > + Identifier of the virtual link instance, identifying the applicable + "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfVirtualLinkDescId: + description: > + Identifier of the related VLD in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is + associated to a VLD which is referred from the source or destination VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: + description: > + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + * LINK_PORT_ADDED + * LINK_PORT_REMOVED + For a temporary resource, an AffectedVirtualLink structure exists as + long as the temporary resource exists. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the + "vnfLinkPortIds" attribute. + type: string + enum: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + - LINK_PORT_ADDED + - LINK_PORT_REMOVED + networkResource: + description: > + Reference to the VirtualNetwork resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in + the "vnfLinkPortIds" attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + vnfLinkPortIds: + description: > + Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change. + Each identifier references a "VnfLinkPortInfo" structure. + Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related + “VnfLinkPortInfo” structures are present (case "added") or have been present (case "removed") in the + “VnfVirtualLinkResourceInfo” or "ExtManagedVirtualLinkInfo" structures that are represented by the + "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the + "vnfLinkPortIds" attribute. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + 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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + AffectedVirtualStorage: + description: > + This type provides information about added, deleted, modified and + temporary virtual storage resources. + type: object + required: + - id + - virtualStorageDescId + - changeType + - storageResource + properties: + id: + description: > + Identifier of the storage instance, identifying the applicable + "virtualStorageResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + virtualStorageDescId: + description: > + Identifier of the related VirtualStorage descriptor in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage + instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: + description: > + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + For a temporary resource, an AffectedVirtualStorage structure exists + as long as the temporary resource exists. + type: string + enum: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + storageResource: + description: > + Reference to the VirtualStorage resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfLcmOpOcc: + description: > + This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id" + attribute in the "Grant" representing the associated "Individual Grant", if such grant exists. + type: object + oneOf: + - required: + - changedInfo + - required: + - modificationsTriggeredByVnfPkgChange + required: + - id + - operationState + - stateEnteredTime + - startTime + - vnfInstanceId + - operation + - isAutomaticInvocation + - isCancelPending + properties: + id: + description: > + Identifier of this VNF lifecycle management operation occurrence. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + operationState: + description: > + The state of the LCM operation. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" + stateEnteredTime: + description: > + Date-time when the current state has been entered. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + startTime: + description: > + Date-time of the start of the operation. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfInstanceId: + description: > + Identifier of the VNF instance to which the operation applies + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + grantId: + description: > + Identifier of the grant related to this VNF LCM operation + occurrence. Shall be set to the value of the "id" attribute + in the "Grant" representing the associated "Individual Grant", + if such grant exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + operation: + description: > + Type of the actual LCM operation represented by this VNF LCM + operation occurrence. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType" + isAutomaticInvocation: + description: > + Set to true if this VNF LCM operation occurrence has been triggered + by an automated procedure inside the VNFM (i.e. + ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf + triggered by auto-heal). Set to false otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + operationParams: + description: > + Input parameters of the LCM operation. This attribute shall be + formatted according to the request data type of the related LCM + operation. The following mapping between operationType and the + data type of this attribute shall apply: + * INSTANTIATE: InstantiateVnfRequest + * SCALE: ScaleVnfRequest + * SCALE_TO_LEVEL: ScaleVnfToLevelRequest + * CHANGE_FLAVOUR: ChangeVnfFlavourRequest + * OPERATE: OperateVnfRequest + * HEAL: HealVnfRequest + * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest + * TERMINATE: TerminateVnfRequest + * MODIFY_INFO: VnfInfoModifications + * CREATE_SNAPSHOT: CreateVnfSnapshotRequest + * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest + * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest + type: object + isCancelPending: + description: > + If the VNF LCM operation occurrence is in "STARTING", "PROCESSING" + or "ROLLING_BACK" state and the operation is being cancelled, this + attribute shall be set to true. Otherwise, it shall be set to false. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + cancelMode: + description: > + The mode of an ongoing cancellation. Shall be present when + isCancelPending=true, and shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeType" + error: + description: > + If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" + is "PROCESSING" or "ROLLING_BACK" and previous value of + "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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + resourceChanges: + description: > + This attribute contains information about the cumulative changes to + virtualised resources that were performed so far by the LCM + operation since its start, if applicable. + type: object + properties: + affectedVnfcs: + description: > + Information about VNFC instances that were affected during the + lifecycle operation. + This allows the API consumer to obtain the information contained in + the latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedVnfc" + affectedVirtualLinks: + description: > + Information about VL instances that were affected during the + lifecycle operation. + This allows the API consumer to obtain the information contained in + the latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + For a particular affected VL, there shall be as many "AffectedVirtualLink" + entries as needed for signalling the different types of changes, i.e., + one per virtual link and change type. For instance, in the case of + signaling affected VL instances involving the addition of a particular VL + instance with links ports, one "AffectedVirtualLink" entry signals the + addition of the VL by using the "changeType" attribute of "AffectedVirtualLink" + structure equal to "ADDED", and another "AffectedVirtualLink" entry signals + the addition of VNF link ports of the VL by using the "changeType" equal to + "LINK_PORT_ADDED". + type: array + items: + $ref: "#/definitions/AffectedVirtualLink" + affectedExtLinkPorts: + description: > + Information about external VNF link ports that were affected during the lifecycle operation. This allows + the API consumer to obtain the information contained in the latest "result" notification if it has not + received it due to an error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedExtLinkPort" + affectedVirtualStorages: + description: > + Information about virtualised storage instances that were affected + during the lifecycle operation. + This allows the API consumer to obtain the information contained + in the latest "result" notification if it has not received it due to + an error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedVirtualStorage" + changedInfo: + description: > + Information about the changed VNF instance information, including + VNF configurable properties, if applicable. + This allows the NFVO to obtain the information contained in the + latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + $ref: "#/definitions/VnfInfoModifications" + changedExtConnectivity: + description: > + Information about changed external connectivity, if applicable. + This allows the NFVO to obtain the information contained in the + latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" + modificationsTriggeredByVnfPkgChange: + description: > + Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package, + if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG". + This allows the API consumer to obtain the information contained in the latest "result" notification if it has + not received it due to an error or a wrongly configured subscription filter. + Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" + vnfSnapshotInfoId: + description: > + Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation, + i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + - vnfInstance + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + vnfInstance: + description: > + Link to the VNF instance that the operation applies to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + grant: + description: > + Link to the grant for this operation, if one exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + cancel: + description: > + Link to the task resource that represents the "cancel" operation + for this VNF LCM operation occurrence, if cancelling is + currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + retry: + description: > + Link to the task resource that represents the "retry" operation + for this VNF LCM operation occurrence, if retrying is currently + allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + rollback: + description: > + Link to the task resource that represents the "rollback" + operation for this VNF LCM operation occurrence, if rolling back + is currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + fail: + description: > + Link to the task resource that represents the "fail" operation + for this VNF LCM operation occurrence, if declaring as failed is + currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + vnfSnapshot: + description: > + Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot. + Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + AffectedExtLinkPort: + description: > + This type provides information about added and deleted external link ports (link ports attached to external virtual links). + type: object + required: + - id + - changeType + - extCpInstanceId + - resourceHandle + properties: + id: + description: > + Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data + type (see clause 5.5.3.2). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: + description: > + Signals the type of change. + Permitted values: + - ADDED + - REMOVED + type: string + enum: + - ADDED + - REMOVED + extCpInstanceId: + description: > + Identifier of the related external CP instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + resourceHandle: + description: > + Reference to the link port resource. + Detailed information is (for added resources) or has been (for removed resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + + VnfInfoModifications: + description: > + This type represents attribute modifications that were performed on an + "Individual VNF instance" resource. The attributes that can be included + consist of those requested to be modified explicitly in the + "VnfInfoModificationRequest" data structure, and additional attributes + of the "VnfInstance" data structure that were modified implicitly e.g. + when modifying the referenced VNF package. + type: object + properties: + vnfInstanceName: + description: > + If present, this attribute signals modifications of the + "vnfInstanceName" attribute in "VnfInstance". + type: string + vnfInstanceDescription: + description: > + If present, this attribute signals modifications of the + "vnfInstanceDescription" attribute in "VnfInstance". + type: string + vnfConfigurableProperties: + description: > + If present, this attribute signals modifications of the + "vnfConfigurableProperties" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + If present, this attribute signals modifications of the "metadata" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute signals modifications of the "extensions" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfdId: + description: > + If present, this attribute signals modifications of the "vnfdId" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfProvider: + description: > + If present, this attribute signals modifications of the + "vnfProvider" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfPkgId" attribute) was modified implicitly following a request to + modify the "vnfPkgId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfPkgId” attribute. + type: string + vnfProductName: + description: > + If present, this attribute signals modifications of the + "vnfProductName" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfPkgId" attribute) was modified implicitly following a request to + modify the "vnfPkgId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfPkgId” attribute. + type: string + vnfSoftwareVersion: + description: > + If present, this attribute signals modifications of the + "vnfSoftwareVersion" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + vnfdVersion: + description: > + If present, this attribute signals modifications of the + "vnfdVersion" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfdId" attribute) was modified implicitly following a request to + modify the "vnfdId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfdId” attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + vnfcInfoModifications: description: > - List of identifiers entries to be deleted from the 'vnfcInfoModifications" attribute array - to be used as "deleteIdList" as defined below this table. + If present, this attribute signals modifications of certain + entries in the "vnfcInfo" attribute array in the + "instantiatedVnfInfo" attribute of "VnfInstance", as defined + in clause 5.5.2.12 type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" \ No newline at end of file + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications" \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index f3c25abf74f7e5ddc5c1461d52b3b731c12a0dd8..b84db5bb94d7ac4fadbc812e095f23ca5d748369 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -1,447 +1,259 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Lifecycle Management Notification interface - description: > + description: | SOL002 - VNF Lifecycle Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification + it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group + Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /callback/v1 + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint VnfLcmOperationOccurrenceNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfLcmOperationOccurrenceNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfLcmOperationOccurrenceNotification: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfLcmOperationOccurrenceNotification - description: A notification about lifecycle changes triggered by a VNF LCM operation occurrence. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfLcmOperationOccurrenceNotification' responses: - 204: - description: > - 204 NO CONTENT - - The notification has been delivered successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierCreationNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during 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 + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification endpoint has been tested successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - ############################################################################### - # Notification endpoint VnfIdentifierCreationNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierCreationNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 post: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfIdentifierCreationNotification - description: > - A notification about the creation of a VNF identifier and the - related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierCreationNotification' responses: - 204: - description: > - 204 NO CONTENT - - The notification has been delivered successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + /URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierDeletionNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during 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 + description: | + The GET method allows the server to test the notification endpoint that is provided by the API consumer, + e.g. during subscription. responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification endpoint has been tested successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - ############################################################################### - # Notification endpoint VnfIdentifierDeletionNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIdentifierDeletionNotification': - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 post: - description: > + description: | Notify - The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: VnfIdentifierDeletionNotification - description: > - A notification about the deletion of a VNF identifier and the - related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierDeletionNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFLCMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - The notification has been delivered successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" +components: + requestBodies: + VnfLcmOperationOccurrenceNotification: + description: | + A notification about lifecycle changes triggered by a VNF LCM operation occurrence. + content: + application/json: + schema: + $ref: ./definitions/SOL002VNFLifecycleManagementNotification_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification + required: true - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the API consumer, e.g. during 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: > - No Content + VnfIdentifierCreationNotification: + description: | + A notification about lifecycle changes triggered by a VNF LCM operation occurrence. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification + required: true - The notification endpoint has been tested successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + VnfIdentifierDeletionNotification: + description: | + A notification about the deletion of a VNF identifier and the related "Individual VNF instance" resource. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification + required: true + + responses: + VNFLCMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFLCMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml b/src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml similarity index 77% rename from src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml rename to src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml index c425ca3b74a9e258355661e31397952c69c931d8..0d3f2600f0ee0824c8ce65cb347e8141a0e1f5cc 100644 --- a/src/SOL002/VNFLifecycleManagementNotification/definitions/VNFLifecycleManagementNotification_def.yaml +++ b/src/SOL002/VNFLifecycleManagementNotification/definitions/SOL002VNFLifecycleManagementNotification_def.yaml @@ -102,6 +102,12 @@ definitions: triggered by auto-heal). Set to false otherwise. type: boolean + verbosity: + description: > + This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL". + If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM + operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOpOccNotificationVerbosityType" vnfLcmOpOccId: description: > The identifier of the VNF lifecycle management operation occurrence @@ -119,7 +125,7 @@ definitions: handling procedures for that operation occurrence. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/AffectedVnfc" + $ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedVnfc" affectedVirtualLinks: description: > Information about VL instances that were affected during the @@ -132,7 +138,17 @@ definitions: handling procedures for that operation occurrence. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualLink" + $ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualLink" + affectedExtLinkPorts: + description: > + Information about external VNF link ports that were affected during the lifecycle operation. + Shall be present if the "notificationStatus" is set to "RESULT", the "verbosity" attribute is set to "FULL" + and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains + information about the cumulative changes to virtualised resources that were performed so far by the VNF LCM + operation occurrence and by any of the error handling procedures for that operation occurrence. + type: array + items: + $ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedExtLinkPort" affectedVirtualStorages: description: > Information about virtualised storage instances that were affected @@ -145,7 +161,7 @@ definitions: handling procedures for that operation occurrence. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualStorage" + $ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/AffectedVirtualStorage" changedInfo: description: > Information about the changed VNF instance information, including @@ -154,7 +170,7 @@ definitions: the operation has performed any changes to VNF instance information, including VNF configurable properties. Shall be absent otherwise. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications" + $ref: "../../VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications" changedExtConnectivity: description: > Information about changed external connectivity, if this @@ -166,6 +182,13 @@ definitions: type: array items: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" + modificationsTriggeredByVnfPkgChange: + description: > + Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package. + Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to + "CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to VNF + instance information, including VNF configurable properties. Shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" error: description: > Details of the latest error, if one has occurred during executing @@ -176,4 +199,4 @@ definitions: _links: description: > Links to resources related to this notification. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" \ No newline at end of file diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 143e76e2bb13c5d182d996533273486788b9f1c2..82129f94231545222fc5b58588697244b83f0ab7 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -1,1102 +1,877 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Perfomance Management interface - description: > - SOL002 - VNF Performance Management interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + description: | + SOL002 - VNF Performance Management interface IMPORTANT: Please note that this file might be not aligned to the + current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /vnfpm/v2 + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -schemes: - - http - - https - -consumes: - - application/json - -produces: - - application/json +servers: + - url: http://127.0.0.1/vnfpm/v2 + - url: https://127.0.0.1/vnfpm/v2 paths: - ############################################################################### - # API Versions # - ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions - ############################################################################### - # PM jobs # - ############################################################################### - '/pm_jobs': - #SOL003 location: 6.4.2 + /pm_jobs: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The client can use this method to retrieve information about PM jobs. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + "200": + $ref: '#/components/responses/PmJobs.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + post: - description: > - The POST method creates a PM job. - As the result of successful executing this method, a new - "Individual PM job" resource as defined in clause 6.4.3 shall - have been created. + description: | + The POST method creates a PM job. As the result of successful executing this method, a new "Individual PM job" + resource as defined in clause 6.4.3 shall have been created. parameters: - - name: CreatePmJobRequest - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/PmJobCreationRequest' responses: - 201: - description: > - 201 CREATED + "201": + $ref: '#/components/responses/PmJobs.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the PM job has been created successfully. - The response body shall contain a representation of the created - PM job resource. - The HTTP response shall include a "Location" HTTP header that - points to the created "Individual PM job" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created PM Job - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + /pm_jobs/{pmJobId}: + parameters: + - $ref: '#/components/parameters/PmJobId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method to retrieve information about PM jobs. + description: | + The client can use this method for reading an individual PM job. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. All attribute names that appear in the PmJob - and in data types referenced from it shall be supported by the VNFM in attribute-based filtering expression. - - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - - Request 1: - GET …/container + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + responses: + "200": + $ref: '#/components/responses/IndividualPmJob.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] + delete: + description: | + This method terminates an individual PM job. As the result of successfully executing this method, the + "Individual PM job" resource shall not exist any longer. + responses: + "204": + $ref: '#/components/responses/IndividualPmJob.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Request 2: - GET …/container?filter=(eq.weight,100) + patch: + description: | + This method allows to modify an "individual PM job" resource. This method shall follow the provisions specified + in the tables 6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters, request and response data structures, + and response codes. + requestBody: + $ref: '#/components/requestBodies/PmJobModificationRequest' + responses: + "200": + $ref: '#/components/responses/IndividualPmJob.Patch' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "412": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM shall support this parameter. - The following attributes shall be excluded from the PmJob structure in - the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - - reports - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports alternative 2 - (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - required: false - type: string + /pm_jobs/{pmJobId}/reports/{reportId}: + parameters: + - $ref: '#/components/parameters/PmJobId' + - $ref: '#/components/parameters/ReportId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The client can use this method for reading an individual performance report. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/IndividualPmJobReport.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about zero or more PM jobs was queried successfully. - The response body shall contain in an array the representations of zero or more PM jobs, - as defined in clause 6.5.2.7. - If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), - "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in - the request, the data in the response body shall have been transformed according to - the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of - ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this - response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual PM job # - ############################################################################### - '/pm_jobs/{pmJobId}': - #SOL002 location: 6.4.3 + /thresholds: parameters: - - name: pmJobId - description: > - Identifier of the PM job. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new PM job resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The client can use this method for reading an individual PM job. + description: | + The client can use this method to query information about thresholds. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: - 200: - description: > - 200 OK + "200": + $ref: '#/components/responses/Thresholds.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when information about an individual PM job has been - ueried successfully. - The response body shall contain a representation of the "Individual PM job" - resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - patch: - description: > - This method allows to modify an "individual PM job" resource. - This method shall follow the provisions specified in the tables 6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters, - request and response data structures, and response codes. + post: + description: | + The POST method can be used by the client to create a threshold. As the result of successfully executing this method, a new "Individual threshold" resource as defined in clause 6.4.6 shall have been created. parameters: - - name: PmJobModifications - description: Parameters for the PM job modification - required: true - in: body - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications" + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/ThresholdCreationRequest' responses: - 200: - description: > - 200 OK + "201": + $ref: '#/components/responses/Thresholds.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /thresholds/{thresholdId}: + parameters: + - $ref: '#/components/parameters/ThresholdId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The client can use this method for reading an individual threshold. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + responses: + "200": + $ref: '#/components/responses/IndividualThreshold.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the request has been - processed successfully. - The response body shall contain a data structure of - type "PmJobModifications". - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 412: - # description: > - # PRECONDITION FAILED - - # Shall be returned upon the following error - # A precondition given in an HTTP request header is - # not fulfilled. - # Typically, this is due to an ETag mismatch, - # indicating that the resource was modified by another - # entity. - # The response body should contain a ProblemDetails - # structure, in which the "detail" attribute should - # convey more information about the error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" delete: - description: > - This method terminates an individual PM job. - As the result of successfully executing this method, the "Individual PM job" - resource shall not exist any longer. + description: | + This method allows to delete a threshold. As the result of successfully executing this method, the + "Individual threshold" resource shall not exist any longer. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/IndividualThreshold.Delete' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - Shall be returned when the PM job has been deleted successfully. - The response body shall be empty. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + patch: + description: | + This method allows to modify an "Individual threshold" resource. This method shall follow the provisions + specified in the tables 6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters, request and response data + structures, and response codes. + requestBody: + $ref: '#/components/requestBodies/ThresholdModificationRequest' + responses: + "200": + $ref: '#/components/responses/IndividualThreshold.Patch' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "409": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + "412": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 + "416": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 - ############################################################################### - # Individual performance report # - ############################################################################### - '/pm_jobs/{pmJobId}/reports/{reportId}': - #SOL002 location: 6.4.4 - parameters: - - name: pmJobId - description: > - Identifier of the PM job. - in: path - type: string - required: true - - name: reportId - description: > - Identifier of the performance report. - in: path +components: + parameters: + PmJobId: + name: pmJobId + in: path + description: | + Identifier of the PM job. This identifier can be retrieved from the resource referenced by the "Location" HTTP + header in the response to a POST request creating a new PM job resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true + + ReportId: + name: reportId + in: path + description: | + Identifier of the performance report. + required: true + style: simple + explode: false + schema: type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false + + ThresholdId: + name: thresholdId + in: path + description: | + Identifier of the threshold. This identifier can be retrieved from the resource referenced by the "Location" + HTTP header in the response to a POST request creating a new threshold resource. It can also be retrieved from + the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: type: string - get: - description: > - The client can use this method for reading an individual performance - report. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - responses: - 200: - description: > - 200 OK - Shall be returned when information of an individual performance report - has been read successfully. - The response body shall contain a representation of the "Individual - performance report" resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 + requestBodies: + PmJobCreationRequest: + description: The VNF creation parameters + content: + application/json: schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Thresholds # - ############################################################################### - '/thresholds': - #SOL003 location: 6.4.5 - parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 - post: - description: > - The POST method can be used by the client to create a threshold. - As the result of successfully executing this method, a new - "Individual threshold" resource as defined in clause 6.4.6 shall - have been created. - parameters: - - name: CreateThresholdRequest - description: > - Request parameters to create a new "Individual threshold" resource. - in: body - required: true + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest + required: true + + PmJobModificationRequest: + description: Parameters for the PM job modification + content: + application/json: schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: - 201: - description: > - 201 CREATED + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications + required: true - Shall be returned when a threshold has been created successfully. - The response body shall contain a representation of the created - "Individual threshold" resource. - The HTTP response shall include a "Location" HTTP header that - contains the resource URI of the created resource. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created threshold - 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 + ThresholdCreationRequest: + description: | + Request parameters to create a new "Individual threshold" resource. + content: + application/json: schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - get: - description: > - The client can use this method to query information about thresholds. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The EM may supply this parameter. All attribute names that appear in the Thresholds - and in data types referenced from it shall be supported by the VNFM in attribute-based filtering expression. + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest + required: true - EXAMPLE - objects - obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} + ThresholdModificationRequest: + description: Parameters for the threshold modification. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications + required: true - Request 1: - GET …/container + responses: + PmJobs.Get: + description: | + 200 OK + Shall be returned when information about zero or more PM jobs was queried successfully. The response body + shall contain in an array the representations of zero or more PM jobs, as defined in clause 6.5.2.7. + If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" + (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response + body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of + ETSI GS NFV-SOL 013, respectively. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 + of ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this response shall follow + the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob - Response 1: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}, - {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]} - ] + PmJobs.Post: + description: | + 201 CREATED + Shall be returned when the PM job has been created successfully. The response body shall contain a + representation of the created PM job resource. The HTTP response shall include a "Location" HTTP header that + points to the created "Individual PM job" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: The resource URI of the created PM Job + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob - Request 2: - GET …/container?filter=(eq.weight,100) + IndividualPmJob.Get: + description: | + 200 OK + Shall be returned when information about an individual PM job has been ueried successfully. The response + body shall contain a representation of the "Individual PM job" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob - Response 2: - [ - {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]} - ] - #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports alternative 2 - (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for - this resource. - in: query - required: false - type: string - responses: - 200: - description: > - 200 OK + IndividualPmJob.Delete: + description: | + 204 NO CONTENT + Shall be returned when the PM job has been deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: {} + + IndividualPmJob.Patch: + description: | + 200 OK + Shall be returned when the request has been processed successfully. The response body shall contain a data + structure of type "PmJobModifications". + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications + + IndividualPmJobReport.Get: + description: | + 200 OK + Shall be returned when information of an individual performance report has been read successfully. + The response body shall contain a representation of the "Individual performance report" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport - Information about zero or more thresholds was queried - successfully. - - If the "filter" URI parameter was supplied in the request, - the data in the response body shall have been transformed - according to the rules specified in clause 5.2.2 of - ETSI GS NFV SOL 013. - The response body shall contain in an array the representations - of zero or more thresholds, as defined in clause 6.5.2.9. - If the VNFM supports alternative 2 (paging) according to - clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion - of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 - 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 + Thresholds.Get: + description: | + 200 OK + Information about zero or more thresholds was queried successfully. + If the "filter" URI parameter was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV SOL 013. The response body shall contain in an array the representations of zero or more thresholds, as defined in clause 6.5.2.9. If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: schema: type: array items: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - ############################################################################### - # Individual threshold # - ############################################################################### - '/thresholds/{thresholdId}': - #SOL003 location: 6.4.6 - parameters: - - name: thresholdId - description: > - Identifier of the threshold. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new threshold resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true - - name: Version - description: > - Version of the API requested to use when responding to this request. - 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 - get: - description: > - The client can use this method for reading an individual threshold. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - responses: - 200: - description: > - 200 OK + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold - Shall be returned when information about an individual threshold - has been queried successfully. - The response body shall contain a representation of the threshold. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 + Thresholds.Post: + description: | + 201 CREATED + Shall be returned when a threshold has been created successfully. The response body shall contain a representation of the created "Individual threshold" resource. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. + headers: + Version: + description: The used API version. + style: simple + explode: false schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - patch: - description: > - This method allows to modify an "Individual threshold" resource. - This method shall follow the provisions specified in the tables 6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters, - request and response data structures, and response codes. - parameters: - - name: ThresholdModifications - description: Parameters for the threshold modification. - required: true - in: body + type: string + 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. + style: simple + explode: false schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications" - responses: - 200: - description: > - 200 OK + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: The resource URI of the created threshold + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold - Shall be returned when the request has been - processed successfully. - The response body shall contain a data structure of - type "ThresholdModifications". - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 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 + IndividualThreshold.Get: + description: | + 200 OK + Shall be returned when information about an individual threshold has been queried successfully. + The response body shall contain a representation of the threshold. + headers: + Version: + description: The used API version. + style: simple + explode: false schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications" - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" - 412: - # description: > - # PRECONDITION FAILED - - # Shall be returned upon the following error - # A precondition given in an HTTP request header is - # not fulfilled. - # Typically, this is due to an ETag mismatch, - # indicating that the resource was modified by - # another entity. - # The response body should contain a - # ProblemDetails structure, in which the "detail" - # attribute should convey more information about the - # error. - # schema: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" - delete: - description: > - This method allows to delete a threshold. - As the result of successfully executing this method, the - "Individual threshold" resource shall not exist any longer. - parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - type: string - responses: - 204: - description: > - 204 NO CONTENT + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold + + IndividualThreshold.Delete: + description: | + 204 NO CONTENT + Shall be returned when the threshold was deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} - Shall be returned when the threshold was deleted successfully. - The response body shall be empty. - headers: - Version: - description: The used API version. - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" - 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" - 429: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + IndividualThreshold.Patch: + description: | + 200 OK + Shall be returned when the request has been processed successfully. The response body shall contain a data + structure of type "ThresholdModifications". + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications \ No newline at end of file diff --git a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index 030a04b3644a65af20cd3feba39c3424eacb311c..f176a80b7be0e3332f181bcff0ff63423c67ea27 100644 --- a/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -1,295 +1,198 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL002 - VNF Performance Management Notification interface - description: > + description: | SOL002 - VNF Performance Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current - version of the ETSI Group Specification it refers to and has not been - approved by the ETSI NFV ISG. In case of discrepancies the published ETSI - Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + IMPORTANT: Please note that this file might be not + aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the + ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: NFV-SOL WG + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 002 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf - -basePath: /callback/v1 - -schemes: - - http - - https - -consumes: - - application/json + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/03.03.01_60/gs_NFV-SOL002v030301p.pdf -produces: - - application/json +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: - ############################################################################### - # Notification endpoint PerformanceInformationAvailableNotification # - ############################################################################### '/URI-is-provided-by-the-client-when-creating-the-subscription_PerformanceInformationAvailableNotification': + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + responses: + "204": + $ref: '#/components/responses/VNFPMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + post: - description: > + description: | Notify - - The POST method delivers a notification regarding a performance - management event from API producer to an API consumer. The API consumer - shall have previously created an "Individual subscription" resource with - a matching filter. + The POST method delivers a notification regarding a performance management event from API producer to an API + consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. parameters: - - name: PerformanceInformationAvailableNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/PerformanceInformationAvailableNotification' responses: - 204: - description: > - No Content + "204": + $ref: '#/components/responses/VNFPMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + /URI-is-provided-by-the-client-when-creating-the-subscription_ThresholdCrossedNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during 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 + description: | + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. responses: - 204: - description: > - No Content + "204": + $ref: '#/components/responses/VNFPMNotification.Get' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned to indicate that the notification endpoint has been - tested successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - ############################################################################### - # Notification endpoint ThresholdCrossedNotification # - ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription_ThresholdCrossedNotification': post: - description: > + description: | Notify - - The POST method delivers a notification regarding a performance - management event from API producer to an API consumer. The API consumer - shall have previously created an "Individual subscription" resource with - a matching filter. + The POST method delivers a notification regarding a performance management event from API producer to an API + consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching + filter. parameters: - - name: ThresholdCrossedNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/ThresholdCrossedNotification' responses: - 204: - description: > - 204 NO CONTENT + "204": + $ref: '#/components/responses/VNFPMNotification.Post' + "400": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "405": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "500": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 - Shall be returned when the notification has been delivered successfully. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" - get: - description: > - The GET method allows the server to test the notification endpoint - that is provided by the client, e.g. during 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: > - 204 NO CONTENT +components: + requestBodies: + PerformanceInformationAvailableNotification: + description: | + Notification about performance information availability. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification + required: true - Shall be returned to indicate that the notification endpoint has been - tested successfully. - The response body shall be empty. - headers: - 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 - 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" - 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" - 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" - 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" - 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" - 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" - 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + ThresholdCrossedNotification: + description: | + Notification about crossed threshold. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification + required: true + + responses: + VNFPMNotification.Get: + description: | + 201 NO CONTENT + Shall be returned to indicate the notification endpoint has been tested successfully. The response body + shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} + + VNFPMNotification.Post: + description: | + 204 NO CONTENT + Shall be returned when the notification has been delivered successfully. The response body shall be empty. + headers: + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL003/APIVersion/APIVersion.yaml b/src/SOL003/APIVersion/APIVersion.yaml index 5076f848e0622c32616c01d48f9bf7b010ec7b05..ea0a9cc4a7a49be8aa4f86f520d885b8f5ba5426 100644 --- a/src/SOL003/APIVersion/APIVersion.yaml +++ b/src/SOL003/APIVersion/APIVersion.yaml @@ -1,50 +1,47 @@ -swagger: "2.0" +openapi: 3.0.2 + info: - version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" - title: "SOL003 - API version interface" + + title: SOL003 - API version interface description: > SOL003 - API version Interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - contact: - name: "NFV-SOL WG" + version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" + externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf -schemes: - - http - - https -consumes: - - application/json -produces: - - application/json + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + paths: - ############################################################################### - # API Versions # - ############################################################################### - '/vrqan/api_versions': + /vrqan/api_versions: + $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + + /vnffm/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/vnffm/api_versions': + /vnfind/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/vnfind/api_versions': + /vnflcm/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/vnflcm/api_versions': + /vnfpm/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/vnfpm/api_versions': + /grant/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/grant/api_versions': + /vnfpkgm/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' - '/vnfpkgm/api_versions': + /vnfsnapshotpkgm/api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' \ No newline at end of file diff --git a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml index 62292e434679aae34d93f2b77a6e4ba68c9029ed..f05b5c103f4a2331cb8a5a2d5912e9be4c0fb456 100644 --- a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml @@ -1,471 +1,227 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Fault Management interface - description: > + description: | SOL003 - VNF Fault Management interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -basePath: "/vnffm/v1" - -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/vnffm/v1 + - url: https://127.0.0.1/vnffm/v1 paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions ############################################################################### # Alarms # ############################################################################### - '/alarms': + /alarms: #SOL003 location: 7.4.2 get: - description: > + description: | Get Alarm List. The API consumer can use this method to retrieve information about the alarm list. This method shall follow the provisions specified in the tables 7.4.2.3.2-1 and 7.4.2.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - The following attribute names shall be supported by the VNFM in - the attribute-based filtering expression: id, managedObjectId, - rootCauseFaultyResource/faultyResourceType, eventType, - perceivedSeverity, probableCause. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported by the - VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more alarms has been queried successfully. - The response body shall contain in an array the representations of zero or more alarms as - defined in clause 7.5.2.4. - If the "filter" URI parameter was supplied in the request, the data in the response body - shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm" + $ref: '#/components/responses/Alarms.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Individual alarm # ############################################################################### - '/alarms/{alarmId}': + /alarms/{alarmId}: #SOL003 location: 7.4.3 parameters: - - name: alarmId - description: > - Identifier of the alarm. - This identifier can be retrieved from the "id" attribute of the - "alarm" attribute in the AlarmNotification or - AlarmClearedNotification. It can also be retrieved from the "id" - attribute of the applicable array element in the payload body of the - response to a GET request to the "Alarms" resource. - in: path - type: string - required: true + - $ref: '#/components/parameters/AlarmId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | The API consumer can use this method to read an individual alarm. This method shall follow the provisions specified in the tables 7.4.3.3.2-1 and 7.4.3.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. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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: > - 200 OK - - Shall be returned when information about an individual alarm has been read successfully. - The response body shall contain a representation of the individual alarm - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/Alarm" + $ref: '#/components/responses/IndividualAlarm.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 patch: - description: > + description: | Acknowledge Alarm. - This method modifies an individual alarm resource. + This method modifies an "Individual alarm" resource. This method shall follow the provisions specified in the tables 7.4.3.3.4-1 and 7.4.3.3.4-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: AlarmModifications - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" - - 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 Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - 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 + requestBody: + $ref: '#/components/requestBodies/IndividualAlarmRequest' responses: 200: - description: > - 200 OK - - Shall be returned when the request has been accepted and completed. - The response body shall contain attribute modifications for an "Individual alarm" - resource (see clause 7.5.2.4). - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" + $ref: '#/components/responses/IndividualAlarm.Patch.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 409: -# description: > -# 409 CONFLICT -# -# Shall be returned upon the following error: The operation cannot be executed currently, -# due to a conflict with the state of the "Individual alarm" resource. -# Typically, this is due to the fact that the alarm is already in the state that is -# requested to be set (such as trying to acknowledge an already-acknowledged alarm). - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + # description: | + # 409 CONFLICT + # + # Shall be returned upon the following error: The operation cannot be executed currently, + # due to a conflict with the state of the "Individual alarm" resource. + # Typically, this is due to the fact that the alarm is already in the state that is + # requested to be set (such as trying to acknowledge an already-acknowledged alarm). + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Subscriptions # ############################################################################### - '/subscriptions': + /subscriptions: #SOL003 location: 7.4.4 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables 7.4.4.3.1-1 and 7.4.4.3.1-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, a new "Individual subscription" resource as defined in clause 7.4.5 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and the same filter + Creation of two "Individual subscription" resources with the same callback URI and the same filter can result in performance degradation and will provide duplicates of notifications to the NFVO, and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating a new "Individual subscription" resource if another "Individual subscription" resource with the - same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), + same filter and callback URI already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource with the - same filter and callbackUri). - parameters: - - name: FmSubscriptionRequest - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest" - - 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 + same filter and callback URI). + requestBody: + $ref: '#/components/requestBodies/FmSubscriptionRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location:"" HTTP header that points to the created - "Individual subscription" resource. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - Location: - description: > - The resource URI of the created subscription resource. - type: string - format: url - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + $ref: '#/components/responses/Subscriptions.Post.200' 303: -# description: > -# 303 SEE OTHER -# -# Shall be returned when a subscription with the -# same callbackURI and the same filter already exists -# and the policy of the VNFM is to not create -# redundant subscriptions. -# The HTTP response shall include a "Location" -# HTTP header that contains the resource URI of the -# existing "Individual subscription" resource. -# The response body shall be empty. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" + # description: | + # 303 SEE OTHER + # + # Shall be returned when a subscription with the + # same callback URI and the same filter already exists + # and the policy of the VNFM is to not create + # redundant subscriptions. + # The HTTP response shall include a "Location" + # HTTP header that contains the resource URI of the + # existing "Individual subscription" resource. + # The response body shall be empty. + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 get: - description: > + description: | Query Subscription Information @@ -473,224 +229,77 @@ paths: subscriptions for VNF alarms subscribed by the API consumer. It can be used e.g. for resynchronization after error situations. 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 - of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the FmSubscription and in - data types referenced from it shall be supported by the VNFM - in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - The list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active subscriptions - of the functional block that invokes the method, i.e. zero or more representations of - FM subscriptions as defined in clause 7.5.2.3. - If the "filter" URI parameter was supplied in the request, the data in the response body shall - have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + $ref: '#/components/responses/Subscriptions.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Individual subscription # ############################################################################### - '/subscriptions/{subscriptionId}': + /subscriptions/{subscriptionId}: #SOL003 location: 7.4.5 parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual subscription" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > + description: | Query Subscription Information. The API consumer can use this method for reading an individual subscription for VNF alarms subscribed by the API consumer. This method shall follow the provisions specified in the tables 7.4.5.3.2-1 and 7.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. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType responses: 200: - description: > - 200 OK - - The operation has completed successfully. - The response body shall contain a representation of the - subscription resource. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + $ref: '#/components/responses/IndividualSubscription.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 delete: - description: > + description: | Terminate Subscription. This method terminates an individual subscription. This method shall follow the provisions specified in the tables 7.4.5.3.5-1 and 7.4.5.3.5-2 @@ -701,59 +310,322 @@ paths: NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. - 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: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + +components: + parameters: + AlarmId: + name: alarmId + in: path + description: | + Identifier of the alarm. + This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or + AlarmClearedNotification. It can also be retrieved from the "id" attribute of the applicable array element in + the payload body of the response to a GET request to the "Alarms" resource. + required: true + style: simple + explode: false + schema: + type: string + + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual subscription" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + IndividualAlarmRequest: + description: The VNF creation parameters + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications + required: true + + FmSubscriptionRequest: + description: The VNF creation parameters + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest + required: true + + responses: + Alarms.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more alarms has been queried successfully. + The response body shall contain in an array the representations of zero or more alarms as + defined in clause 7.5.2.4. + If the "filter" URI parameter was supplied in the request, the data in the response body + shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm" + + IndividualAlarm.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual alarm has been read successfully. + The response body shall contain a representation of the individual alarm + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFFaultManagement_def.yaml#/definitions/Alarm" + + IndividualAlarm.Patch.200: + description: | + 200 OK + + Shall be returned when the request has been accepted and completed. + The response body shall contain attribute modifications for an "Individual alarm" + resource (see clause 7.5.2.4). + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications" + + Subscriptions.Get.200: + description: | + 200 OK + + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain in an array the representations of all active subscriptions + of the functional block that invokes the method, i.e. zero or more representations of + FM subscriptions as defined in clause 7.5.2.3. + If the "filter" URI parameter was supplied in the request, the data in the response body shall + have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + + Subscriptions.Post.200: + description: | + 201 CREATED + + Shall be returned when the subscription has been created successfully. + The response body shall contain a representation of the created "Individual subscription" resource. + The HTTP response shall include a "Location:"" HTTP header that points to the created + "Individual subscription" resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + + IndividualSubscription.Get.200: + description: | + 200 OK + + The operation has completed successfully. + The response body shall contain a representation of the + subscription resource. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription" + + IndividualSubscription.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the "Individual subscription" resource has been deleted successfully. + The response body shall be empty. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + content: {} \ No newline at end of file diff --git a/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml b/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml new file mode 100644 index 0000000000000000000000000000000000000000..7f8204552283ad22b2941377305a090c028f937a --- /dev/null +++ b/src/SOL003/VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml @@ -0,0 +1,169 @@ +definitions: + Alarm: + description: > + The alarm data type encapsulates information about an alarm. + type: object + required: + - id + - managedObjectId + - alarmRaisedTime + - ackState + - perceivedSeverity + - eventTime + - eventType + - probableCause + - isRootCause + - _links + properties: + id: + description: > + Identifier of this Alarm information element. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + managedObjectId: + description: > + Identifier of the affected VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + rootCauseFaultyResource: + description: > + The virtualised resources that are causing the VNF fault. + Shall be present if the alarm affects virtualised resources. + $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FaultyResourceInfo" + alarmRaisedTime: + description: > + Time stamp indicating when the alarm is raised by the managed + object. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + alarmChangedTime: + description: > + Time stamp indicating when the alarm was last changed. It shall be + present if the alarm has been updated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + alarmClearedTime: + description: > + Time stamp indicating when the alarm was cleared. It shall be + present if the alarm has been cleared. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + alarmAcknowledgedTime: + description: > + Time stamp indicating when the alarm was acknowledged. + It shall be present if the alarm has been acknowledged. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + ackState: + description: > + Acknowledgement state of the alarm. + Permitted values: + * UNACKNOWLEDGED + * ACKNOWLEDGED. + type: string + enum: + - UNACKNOWLEDGED + - ACKNOWLEDGED + perceivedSeverity: + description: > + Perceived severity of the managed object failure. + $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityType" + eventTime: + description: > + Time stamp indicating when the fault was observed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + eventType: + description: > + Type of event. + $ref: "../../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/EventType" + faultType: + description: > + Additional information to clarify the type of the fault. + type: string + probableCause: + description: > + Information about the probable cause of the fault. + type: string + isRootCause: + description: > + Attribute indicating if this fault is the root for other correlated + alarms. If true, then the alarms listed in the attribute + "correlatedAlarmIds" are caused by this fault. + type: boolean + correlatedAlarmIds: + description: > + List of identifiers of other alarms correlated to this fault. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + faultDetails: + description: > + Provides additional information about the fault. + type: array + items: + type: string + _links: + description: > + Links for this resource. + type: object + required: + - self + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + objectInstance: + description: > + Link to the resource representing the VNF instance to which the + notified alarm is correlated. Shall be present if the VNF + instance information is accessible as a resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + AlarmNotification: + description: > + This type represents an alarm notification about VNF faults. + This notification shall be triggered by the VNFM when: + * An alarm has been created. + * An alarm has been updated, e.g. if the severity of the alarm has + changed. + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - alarm + - _links + properties: + id: + description: > + Identifier of this notification. If a notification is sent multiple + times due to multiple subscriptions, the "id" attribute of all these + notifications shall have the same value. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + notificationType: + description: > + Discriminator for the different notification types. Shall be set to + "AlarmNotification" for this notification type. + type: string + enum: + - AlarmNotification + subscriptionId: + description: > + Identifier of the subscription that this notification relates to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + timeStamp: + description: > + Date-time of the generation of the notification. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + alarm: + description: > + Information about an alarm including AlarmId, affected VNF + identifier, and FaultDetails. + $ref: "#/definitions/Alarm" + _links: + description: > + Links to resources related to this notification. + type: object + required: + - subscription + properties: + subscription: + description: > + Link to the related subscription. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" \ No newline at end of file diff --git a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index bf184d75c0b5fef4108e02c5472d186d0afc54e7..8e4c1d60d96b18a76e650c0fca3ac659cf5e5072 100644 --- a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -1,445 +1,375 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Fault Management Notification interface - description: > + description: | SOL003 - VNF Fault Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/callback/v1" + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: ############################################################################### # Notification endpoint AlarmNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification: #SOL003 location: 7.4.6 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have previously created an "Individual subscription resource" with a matching filter. This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: AlarmNotification - description: > - Information of a VNF alarm. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification" - - 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 - "application/merge-patch+json" according to - IETF RFC 7396. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, + description: | + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint AlarmClearedNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification: #SOL003 location: 7.4.6 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have previously created an "Individual subscription resource" with a matching filter. This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: AlarmClearedNotification - description: > - Information of the clearance of a VNF alarm - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification" - - 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 - "application/merge-patch+json" according to - IETF RFC 7396. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmClearedNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmClearedNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, + description: | + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmClearedNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint AlarmListRebuiltNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification: #SOL003 location: 7.4.6 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have previously created an "Individual subscription resource" with a matching filter. This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: AlarmListRebuiltNotification - description: > - Information that the alarm list has been rebuilt by the VNFM - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" - - 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 - "application/merge-patch+json" according to - IETF RFC 7396. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/AlarmListRebuiltNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmListRebuiltNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, + description: | + The GET method allows the API producer to test the notification endpoint that is provided by the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/AlarmListRebuiltNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + +components: + requestBodies: + AlarmNotification: + description: Information of a VNF alarm. + content: + application/json: + schema: + $ref: "../VNFFaultManagement/definitions/SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification" + required: true + + AlarmClearedNotification: + description: Information of the clearance of a VNF alarm + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification" + required: true + + AlarmListRebuiltNotification: + description: Information that the alarm list has been rebuilt by the VNFM + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification" + required: true + + responses: + AlarmNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + AlarmNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + AlarmClearedNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + AlarmClearedNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + AlarmListRebuiltNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + AlarmListRebuiltNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFIndicator/VNFIndicator.yaml b/src/SOL003/VNFIndicator/VNFIndicator.yaml index 13e161d62d9c7f8a43cf8cd9e12bfa5a9c5727a1..e75d6e494dd8279ce0780dc6d7abd0668ee87b29 100644 --- a/src/SOL003/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL003/VNFIndicator/VNFIndicator.yaml @@ -1,757 +1,308 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Indicator interface - description: > + description: | SOL003 - VNF Indicator interface + IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/vnfind/v1" + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -schemes: - - https +servers: + - url: http://127.0.0.1/vnfind/v1 + - url: https://127.0.0.1/vnfind/v1 -consumes: - - "application/json" -produces: - - "application/json" paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions ############################################################################### # VNF indicators # ############################################################################### - '/indicators': + /indicators: #SOL003 location: 8.4.2 get: - description: > + description: | Get Indicator Value. The GET method queries multiple VNF indicators. This method shall follow the provisions specified in the tables 8.4.2.3.2-1 and 8.4.2.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the VnfIndicator and in - data types referenced from it shall be supported by the VNFM - in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more VNF indicators has been queried successfully. - The response body shall contain in an array the representations of all VNF indicators that match - the attribute filter, i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. - If the "filter" URI parameter was supplied in the request, the data in the response body shall have - been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" + $ref: '#/components/responses/Indicators.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # VNF indicators related to a VNF instance # ############################################################################### - '/indicators/{vnfInstanceId}': + /indicators/{vnfInstanceId}: #SOL003 location: 8.4.3 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to which the VNF indicator applies. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual VNF instance" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' get: - description: > + description: | Get Indicator Value. The GET method queries multiple VNF indicators related to a VNF instance. This method shall follow the provisions specified in the tables 8.4.3.3.2-1 and 8.4.3.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. - Reference: IETF RFC 7231 - in: header - required: true - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the VnfIndicator and in - data types referenced from it shall be supported by the VNFM - in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more VNF indicators has been queried successfully. - The response body shall contain in an array the representations of all VNF indicators that are related - to the particular VNF instance and that match the attribute filter, i.e. zero or more representations - of VNF indicators as defined in clause 8.5.2.2. - If the "filter" URI parameter was supplied in the request, the data in the response body shall have been - transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" + $ref: '#/components/responses/VnfInstanceIndicators.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Individual VNF indicator # ############################################################################### - '/indicators/{vnfInstanceId}/{indicatorId}': + /indicators/{vnfInstanceId}/{indicatorId}: #SOL003 location: 8.4.4 parameters: - - name: indicatorId - description: > - Identifier of the VNF indicator. - This identifier can be retrieved from the resource referenced by the - payload body in the response to a POST request creating a new "Individual VNF - instance" resource. - in: path - type: string - required: true - - name: vnfInstanceId - description: > - Identifier of the VNF instance to which the VNF indicator applies. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual VNF instance" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/IndicatorId' + - $ref: '#/components/parameters/VnfInstanceId' get: - description: > + description: | Get Indicator Value. The GET method reads a VNF indicator. This method shall follow the provisions specified in the tables 8.4.4.3.2-1 and 8.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. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - Shall be returned when the VNF indicator has been read successfully. - The response body shall contain the representation of the VNF indicator. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator" + $ref: '#/components/responses/VnfInstanceIndividualIndicator.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Subscriptions # ############################################################################### - '/subscriptions': + /subscriptions: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Subscribe. The POST method creates a new subscription. As the result of successfully executing this method, a new "Individual subscription" resource as defined in clause 8.4.6 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and the same filter + Creation of two "Individual subscription" resources with the same callback URI and the same filter can result in performance degradation and will provide duplicates of notifications to the NFVO, and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating a new "Individual subscription" resource if another "Individual subscription" resource with the - same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), + same filter and callback URI already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource with the same - filter and callbackUri). + filter and callback URI). This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: VnfIndicatorSubscriptionRequest - description: Details of the subscription to be created. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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 + requestBody: + $ref: '#/components/requestBodies/VnfIndicatorSubscriptionRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location" HTTP header that points to the created resource. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created VNF 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: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" + $ref: '#/components/responses/Subscriptions.Post.201' 303: -# description: > -# 303 SEE OTHER -# -# Shall be returned when a subscription with the -# same callbackURI and the same filter already -# exists and the policy of the VNFM is to not create -# redundant subscriptions. -# The HTTP response shall include a "Location" -# HTTP header that contains the resource URI of -# the existing "Individual subscription" resource. -# The response body shall be empty. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" + # description: | + # 303 SEE OTHER + # + # Shall be returned when a subscription with the + # same callback URI and the same filter already + # exists and the policy of the VNFM is to not create + # redundant subscriptions. + # The HTTP response shall include a "Location" + # HTTP header that contains the resource URI of + # the existing "Individual subscription" resource. + # The response body shall be empty. + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 get: - description: > + description: | Query Subscription Information. 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 8.4.5.3.2-1 and 8.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. - Reference: IETF RFC 7231 - in: header - required: true - 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: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the VnfIndicatorSubscription - and in data types referenced from it shall be supported by the - VNFM in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active - subscriptions of the functional block that invokes the method which match the attribute filter, - i.e. zero or more representations of VNF indicator subscriptions as defined in clause 8.5.2.4. - If the "filter" URI parameter was supplied in the request, the data in the response body shall - have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - Location: - description: The resource URI of the created VNF 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" + $ref: '#/components/responses/Subscriptions.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 ############################################################################### # Individual subscription # ############################################################################### - '/indicators/subscriptions/{subscriptionId}': + /indicators/subscriptions/{subscriptionId}: #SOL003 location: 8.4.6 parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual subscription" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query Subscription Information. The GET method reads an individual subscription. This method shall follow the provisions specified in the tables 8.4.6.3.2-1 and 8.4.6.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. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has been read successfully. - The response body shall contain a representation of the "Individual subscription" resource. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription" + $ref: '#/components/responses/IndividualSubscription.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 delete: - description: > + description: | Terminate Subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 8.4.6.3.5-1 and 8.4.6.3.5-2 @@ -762,66 +313,325 @@ paths: NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. - parameters: - - 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: 204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + +components: + parameters: + VnfInstanceId: + name: vnfInstanceId + in: path + description: | + Identifier of the VNF instance to which the VNF indicator applies. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual VNF instance" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + IndicatorId: + name: indicatorId + in: path + description: | + Identifier of the VNF indicator. + This identifier can be retrieved from the resource referenced by the + payload body in the response to a POST request creating a new "Individual VNF + instance" resource. + required: true + style: simple + explode: false + schema: + type: string + + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual subscription" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + VnfIndicatorSubscriptionRequest: + description: Details of the subscription to be created. + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest + required: true + + responses: + Indicators.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF indicators has been queried successfully. + The response body shall contain in an array the representations of all VNF indicators that match + the attribute filter, i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. + If the "filter" URI parameter was supplied in the request, the data in the response body shall have + been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + VnfInstanceIndicators.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF indicators has been queried successfully. + The response body shall contain in an array the representations of all VNF indicators that are related + to the particular VNF instance and that match the attribute filter, i.e. zero or more representations + of VNF indicators as defined in clause 8.5.2.2. + If the "filter" URI parameter was supplied in the request, the data in the response body shall have been + transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + VnfInstanceIndividualIndicator.Get.200: + description: | + 200 OK + Shall be returned when the VNF indicator has been read successfully. + The response body shall contain the representation of the VNF indicator. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator + + Subscriptions.Post.201: + description: | + 201 CREATED + + Shall be returned when the subscription has been created successfully. + The response body shall contain a representation of the created "Individual subscription" resource. + The HTTP response shall include a "Location" HTTP header that points to the created resource. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + Subscriptions.Get.200: + description: | + 200 OK + + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain in an array the representations of all active + subscriptions of the functional block that invokes the method which match the attribute filter, + i.e. zero or more representations of VNF indicator subscriptions as defined in clause 8.5.2.4. + If the "filter" URI parameter was supplied in the request, the data in the response body shall + have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + IndividualSubscription.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual subscription has been read successfully. + The response body shall contain a representation of the "Individual subscription" resource. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription + + IndividualSubscription.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the "Individual subscription" resource has been deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml index e93597ed469b92ee6425e19c583d9e08ca436a48..f9539740d27e9bc34e7f3452ff6705b52fccb273 100644 --- a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -1,166 +1,146 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" - title: SOL003 - VNF Indicator interface - description: > - SOL003 - VNF Indicator interface - + title: SOL003 - VNF Indicator Notification interface + description: | + SOL003 - VNF Indicator Notification interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/callback/v1" + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: ############################################################################### # Notification endpoint VnfIndicatorValueChangeNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification: #SOL003 location: 8.4.7 post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription resource" with a matching filter. This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: AlarmListRebuiltNotification - description: > - Information that the alarm list has been rebuilt by the VNFM - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/AlarmListRebuiltNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VNFINDNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. + description: | + The GET method allows the API producer to test the notification endpoint that is provided by + the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2 for URI query parameters, request and response data structures, and response codes. 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 204: - description: > - 204 NO CONTENT - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VNFINDNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + +components: + + requestBodies: + AlarmListRebuiltNotification: + description: Information that the alarm list has been rebuilt by the VNFM. + content: + application/json: + schema: + oneOf: + - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification + - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/SupportedIndicatorsChangeNotification + required: true + + responses: + VNFINDNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VNFINDNotification.Get.204: + description: | + 204 NO CONTENT + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 5c0768f102e574456b510ec4641905ef03dcfb5d..773a58bc46480d42452bd8060a6693cbac798516 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -1,59 +1,50 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Lifecycle Management interface - description: > - SOL003 - VNF Lifecycle Management interface definition - + description: | + SOL003 - VNF Lifecycle Management interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/vnflcm/v1" + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/vnflcm/v1 + - url: https://127.0.0.1/vnflcm/v1 paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': - $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + /api_versions: + $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions ############################################################################### # VNF instances # ############################################################################### - '/vnf_instances': + /vnf_instances: #SOL003 location: 5.4.2 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > - Create VNF Identifier. - The POST method creates a new VNF instance resource. + description: | + The POST method creates a new VNF instance resource based on a VNF package that is onboarded and in + "ENABLED" state. This method shall follow the provisions specified in the tables 5.4.2.3.1-1 and 5.4.2.3.1-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, a new "Individual VNF instance" @@ -61,350 +52,122 @@ paths: "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification of type VnfIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 5.5.2.18. - parameters: - - name: createVnfRequest - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest" - - 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 + When initiating the creation of a VNF instance resource, the passed metadata values can differ from + the default values for metadata, if any, declared in the VNFD. + The VNFM shall apply the "metadata" attributes in the "CreateVnfRequest" data structure in the payload + body to the "metadata" attribute in the "VnfInstance" data structure on top of the default values that + were obtained from the VNFD according to the rules of JSON Merge Patch (see IETF RFC 7396). + For all metadata keys defined in the VNFD, the VNFM shall ensure that the content of the resulting + "metadata" attributes is valid against the data type definitions in the VNFD. The absence of a metadata + item that is marked "required" in the VNFD shall not be treated as an error. In case a "metadata" child + attribute is not defined in the VNFD, the VNFM shall consider it valid in case it is a valid JSON structure. + In case of an error, the operation shall be rejected with a "422 Unprocessable Entity" error. + requestBody: + $ref: '#/components/requestBodies/CreateVnfRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when a new "Individual VNF instance" resource and - the associated VNF instance identifier washas been created successfully. - The response body shall contain a representation of the created VNF instance, - as defined in clause 5.5.2.2. - The HTTP response shall include a "Location" HTTP header that contains the resource - URI of the created VNF instance. - 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 VNF instance. - type: string - format: url - 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/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: '#/components/responses/VNFInstances.Post.201' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query VNF. The GET method queries information about multiple VNF instances. 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The NFVO may supply this parameter. - All attribute names that appear in the VnfInstance and in data types referenced from - it shall be supported by the VNFM in the filter expression. - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. - The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the VnfInstance structure - in the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - - vnfConfigurableProperties - - vimConnectionInfo - - instantiatedVnfInfo - - metadata - - extensions - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported by the - VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of - ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more VNF instances has been queried successfully. - The response body shall contain in an array the representations of zero or more VNF instances, - as defined in clause 5.5.2.2. - If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" - (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response - body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of - ETSI GS NFV-SOL 013, respectively. - If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - type: array - items: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: '#/components/responses/VNFInstances.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual VNF instance # ############################################################################### - '/vnf_instances/{vnfInstanceId}': + /vnf_instances/{vnfInstanceId}: #SOL003 location: 5.4.3.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the response - to a POST request creating a new VNF instance resource. It can also - be retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true - + - $ref: '#/components/parameters/VnfInstanceId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query VNF. The GET method retrieves information about a VNF instance by reading an "Individual VNF instance" resource. This method shall follow the provisions specified in the tables 5.4.3.3.2-1 and 5.4.3.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. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual VNF instance has been read successfully. - The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2. - 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/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: '#/components/responses/IndividualVnfInstance.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" patch: #SOL003 location: 5.4.3.3.4 - description: > + description: | Modify VNF Information. This method modifies an "Individual VNF instance" resource. Changes to the VNF configurable properties are applied to the configuration in the VNF instance, @@ -415,99 +178,72 @@ paths: for URI query parameters, request and response data structures, and response codes. The steps and conditions that apply as the result of successfully executing this method are specified in clause 5.4.1.2. - parameters: - - name: VnfInfoModificationRequest - description: > - Parameters for the VNF modification, as defined in clause 5.5.2.12. - The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396. - required: true - in: body - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" - - 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 - "application/merge-patch+json" according to IETF RFC 7396. - in: header - required: true - 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 + + The VNFM shall apply the "metadata", "extensions" and "vnfConfigurableProperties" attributes in the + "VnfInfoModificationRequest" data structure in the payload body to the existing "extensions" and + "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the + rules of JSON Merge Patch (see IETF RFC 7396). + The VNFM shall ensure that the content of the child attributes of the resulting "metadata", "extensions" + and "vnfConfigurableProperties" attributes is valid against the data types definitions of these child + attributes in the VNFD. + + In case a "metadata" child attribute is not defined in the VNFD, the VNFM shall consider it valid in + case it is a valid JSON structure. + + NOTE: "Extensions" and "vnfConfigurableProperties" child attributes are always declared in the VNFD. + + If the VNF instance is in the "INSTANTIATED" state, the validation shall also include + ensuring the presence of all "extensions" and "vnfConfigurableProperties" child attributes that are + marked as "required" in the VNFD. + + NOTE: This allows to build the set of "extensions" and "vnfConfigurableProperties" incrementally + prior VNF instantiation but ensures their completeness for an instantiated VNF instance. + + The absence of a metadata item that is marked "required" in the VNFD shall not be treated as an error. + + In case of an error during validation, the operation shall be automatically rolled back, and + appropriate error information shall be provided in the "VnfLcmOperationOccurrenceNotification" + message and the "VnfLcmOpOcc" data structure. + The processing of changes to the "metadata" / "extensions" / "vnfConfigurableProperties" attributes + shall be performed in the "PROCESSING" phase of the LCM operation. The change shall be atomic, i.e. the + result of intermediate stages shall not be visible in the API. In case of successful completion of the + processing and validation, the attributes shall be provided in the "VnfInstance" data structure and + the operation shall proceed towards successful completion. + requestBody: + $ref: '#/components/requestBodies/VnfInfoModificationRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - On success, the HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "Individual VNF LCM operation occurrence" - resource corresponding to the operation. - The response body shall be empty. - 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 VNF instance - type: string - format: url - 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/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + $ref: '#/components/responses/IndividualVnfInstance.Patch.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, #due to a conflict with the state of the "Individual VNF instance" resource. #Typically, this is due to the fact that another LCM operation is ongoing. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" delete: #SOL003 location: 5.4.3.3.5 - description: > + description: | Delete VNF Identifier. This method deletes an "Individual VNF instance" resource. This method shall follow the provisions specified in the tables 5.4.3.3.5-1 and 5.4.3.3.5-2 @@ -516,89 +252,46 @@ paths: shall not exist any longer. A notification of type "VnfIdentifierDeletionNotification" shall be triggered as part of successfully executing this method as defined in clause 5.5.2.19. - 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: > - 204 NO CONTENT - - Shall be returned when the "Individual VNF instance" resource and the associated - VNF identifier were deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualVnfInstance.Delete.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following 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 "Individual VNF instance" resource is in INSTANTIATED state. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Instantiate VNF task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/instantiate': + /vnf_instances/{vnfInstanceId}/instantiate: #SOL003 location: 5.4.4.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the response - to a POST request creating a new VNF instance resource. It can also - be retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: #SOL003 location: 5.4.4.3.1 - description: > + description: | Instantiate VNF. The POST method instantiates a VNF instance. This method shall follow the provisions specified in the tables 5.4.4.3.1-1 and 5.4.4.3.1-2 @@ -608,85 +301,46 @@ paths: In addition, once the VNFM has successfully completed the underlying VNF LCM operation occurrence, it shall set the "instantiationState" attribute to the value "INSTANTIATED" and the "vnfState" attribute to the value "STARTED" in the representation of the "Individual VNF instance" resource. + + When instantiating a VNF instance, the values of the extensions and/or VNF configurable properties + passed in the instantiation request can differ from the values in the "VnfInstance" data structure + that were initialized from default values, if any, declared in the VNFD. + The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the + "InstantiateVnfRequest" data structure in the payload body to the existing "extensions" and + "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules + of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting + "extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (including the + presence of all child attributes that are marked as "required" in the VNFD). In case of an error + during validation, the operation shall be automatically rolled back, and appropriate error information + shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc" + data structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes + shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e. + the result of intermediate stages shall not be visible in the API. In case of successful completion + of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure + and the operation shall proceed to obtain the grant. parameters: - - name: InstantiateVnfRequest - description: Parameters for the VNF instantiation. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/InstantiateVnfRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "Individual VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/InstantiateVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -694,35 +348,26 @@ paths: #Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state, #or that a required child attribute of the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Scale VNF task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/scale': + /vnf_instances/{vnfInstanceId}/scale: #SOL003 location: 5.4.5.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be scaled. This identifier can be - retrieved from the resource referenced by the "Location" HTTP header - in the response to a POST request creating a new "Individual VNF instance" - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: #SOL003 location: 5.4.5.3.1 - description: > + description: | Scale VNF. The POST method requests to scale a VNF instance resource incrementally. This method shall follow the provisions specified in the tables 5.4.5.3.1-1 and 5.4.5.3.1-2 @@ -733,78 +378,22 @@ paths: it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute in the representation of the "Individual VNF instance" resource. parameters: - - name: ScaleVnfRequest - description: Parameters for the scale VNF operation. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/ScaleVnfRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/ScaleVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -814,13 +403,13 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if #the task is not supported for the VNF instance represented by the parent resource, which means that the #task resource consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -829,33 +418,24 @@ paths: #NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing, or that #a required child attribute of the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Scale VNF to Level task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/scale_to_level': + /vnf_instances/{vnfInstanceId}/scale_to_level: #SOL003 location: 5.4.6.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be scaled to a target level. This - identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual VNF instance" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: #SOL003 location: 5.4.6.3.1 - description: > + description: | Scale VNF to Level. The POST method requests to scale a VNF instance resource to a target level. This method shall follow the provisions specified in the tables 5.4.6.3.1-1 and 5.4.6.3.1-2 @@ -866,78 +446,22 @@ paths: it shall reflect the result of scaling the VNF instance by updating the "scaleStatus" attribute in the representation of the "Individual VNF instance" resource. parameters: - - name: ScaleVnfToLevelRequest - description: Parameters for the scale VNF to Level operation. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/ScaleVnfToLevelRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/ScaleToLevelVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -947,13 +471,13 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if the task #is not supported for the VNF instance represented by the parent resource, which means that the task resource #consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -962,33 +486,23 @@ paths: #that another lifecycle management operation is ongoing, or that a required child attribute of #the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Change VNF Flavour task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/change_flavour': + /vnf_instances/{vnfInstanceId}/change_flavour: #SOL003 location: 5.4.7.2 parameters: - - name: vnfInstanceId - description: > - The identifier of the VNF instance of which the deployment flavour - is requested to be changed. This identifier can be retrieved from - the resource referenced by the "Location" HTTP header in the - response to a POST request creating a new "Individual VNF instance" resource. It - can also be retrieved from the "id" attribute in the payload body of - that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: - description: > + description: | Change VNF Flavour. This method shall follow the provisions specified in the tables 5.4.7.3.1-1 and 5.4.7.3.1-2 for URI query parameters, request and response data structures, and response codes. @@ -998,79 +512,39 @@ paths: it shall set the "flavourId" attribute in the representation of the "Individual VNF instance" resource to the value of the "newFlavourId" attribute passed in the "ChangeVnfFlavourRequest" data in the POST request. + + When initiating a change of the current VNF flavour, the values of the extensions and/or VNF + configurable properties, can differ between the new flavour and the old flavour of the VNF instance. + The VNFM shall apply the "extensions" and "vnfConfigurableProperties" attributes in the + "ChangeVnfFlavourRequest" data structure in the payload body to the existing "extensions" and + "vnfConfigurableProperties" attributes from the "VnfInstance" data structure according to the rules + of JSON Merge Patch (see IETF RFC 7396). The VNFM shall ensure that the content of the resulting + "extensions" and "vnfConfigurableProperties" attributes is valid against the VNFD (which includes + ensuring the presence of all child attributes that are marked as "required" in the VNFD). In case + of an error, the operation shall be automatically rolled back, and appropriate error information + shall be provided in the "VnfLcmOperationOccurrenceNotification" message and the "VnfLcmOpOcc" data + structure. The processing of changes to the "extensions" / "vnfConfigurableProperties" attributes + shall be performed in the "STARTING" phase of the LCM operation. The change shall be atomic, i.e. + the result of intermediate stages shall not be visible in the API. In case of successful completion + of the processing and validation, the attributes shall be provided in the "VnfInstance" data structure + and the operation shall proceed to obtain the grant. parameters: - - name: ChangeVnfFlavourRequest - description: Parameters for the Change VNF Flavour operation. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/ChangeVnfFlavourRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/ChangeFlavourVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -1080,13 +554,13 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if the task #is not supported for the VNF instance represented by the parent resource, which means that the task resource #consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -1095,32 +569,23 @@ paths: #that another lifecycle management operation is ongoing, or that a required child attribute of #the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Terminate VNF task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/terminate': + /vnf_instances/{vnfInstanceId}/terminate: #SOL003 location: 5.4.8.2 parameters: - - name: vnfInstanceId - description: > - The identifier of the VNF instance to be terminated. This identifier - can be retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new "Individual VNF instance" - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: - description: > + description: | Terminate VNF. The POST method triggers the VNFM to terminate a VNF instance and to request to the VIM the release of its used virtualised resources. @@ -1132,84 +597,28 @@ paths: it shall set the "instantiationState" attribute in the representation of the "Individual VNF instance" resource to the value "NOT_INSTANTIATED". parameters: - - name: TerminateVnfRequest - description: Parameters for the VNF termination. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/TerminateVnfRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/TerminateVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -1218,32 +627,23 @@ paths: #that another lifecycle management operation is ongoing, or that a required child attribute of #the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Heal VNF task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/heal': + /vnf_instances/{vnfInstanceId}/heal: #SOL003 location: 5.4.9.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be healed. This identifier can be - retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new "Individual VNF instance" - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: - description: > + description: | Heal VNF. The POST method requests to heal a VNF instance. This method shall follow the provisions specified in the tables 5.4.9.3.1-1 and 5.4.9.3.1-2 @@ -1251,78 +651,22 @@ paths: The steps and conditions that apply as the result of successfully executing this method are specified in clause 5.4.1.2. parameters: - - name: HealVnfRequest - description: Parameters for the Heal VNF operation. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/HealVnfRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/HealVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -1332,13 +676,13 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if the task is #not supported for the VNF instance represented by the parent resource, which means that the task resource #consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -1347,32 +691,23 @@ paths: #that another lifecycle management operation is ongoing, or that a required child attribute of #the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Operate VNF task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/operate': - #SOL003 location: 5.4.9.2 + /vnf_instances/{vnfInstanceId}/operate: + #SOL003 location: 5.4.10.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance to be operated. This identifier can - be retrieved from the resource referenced by the "Location" HTTP - header in the response to a POST request creating a new "Individual VNF instance" - resource. It can also be retrieved from the "id" attribute in the - payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: - description: > + description: | Operate VNF. The POST method changes the operational state of a VNF instance resource. This method shall follow the provisions specified in the tables 5.4.10.3.1-1 and 5.4.10.3.1-2 @@ -1383,78 +718,22 @@ paths: it shall set the "vnfState" attribute in the representation of the "Individual VNF instance" resource to the value of the "changeStateTo" attribute passed in the "OperateVnfRequest" data in the POST request. parameters: - - name: OperateVnfRequest - description: Parameters for the Operate VNF operation. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/OperateVnfRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/OperateVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -1464,13 +743,13 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if the task is #not supported for the VNF instance represented by the parent resource, which means that the task resource #consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -1479,33 +758,23 @@ paths: #that another lifecycle management operation is ongoing, or that a required child attribute of #the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Change external VNF connectivity task # ############################################################################### - '/vnf_instances/{vnfInstanceId}/change_ext_conn': - #SOL003 location: 5.4.9.2 + /vnf_instances/{vnfInstanceId}/change_ext_conn: + #SOL003 location: 5.4.11.2 parameters: - - name: vnfInstanceId - description: > - Identifier of the VNF instance of which the external connectivity is - requested to be changed. This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a POST request creating a new "Individual VNF instance" resource. It can also be - retrieved from the "id" attribute in the payload body of that - response. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfInstanceId' post: - description: > + description: | Change External VNF Connectivity. The POST method changes the external connectivity of a VNF instance. This method shall follow the provisions specified in the tables 5.4.11.3.1-1 and 5.4.11.3.1-2 @@ -1513,85 +782,28 @@ paths: The steps and conditions that apply as the result of successfully executing this method are specified in clause 5.4.1.2. parameters: - - name: ChangeExtVnfConnectivityRequest - description: > - Parameters for the Change external VNF connectivity operation. - in: body - required: true - schema: - $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/ChangeExtVnfConnectivityRequest' responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that - contains the URI of the newly-created "VNF LCM operation - occurrence" resource corresponding to the operation. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - 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 + $ref: '#/components/responses/ChangeExtConnVnfInstance.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, @@ -1599,277 +811,163 @@ paths: #Typically, this is due to the fact that another lifecycle management operation is ongoing, #or that a required child attribute of the "extensions" attribute has not been set. #Those attributes are marked as "required" in the VNFD. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + ############################################################################### + # Change current VNF package task # + ############################################################################### + /vnf_instances/{vnfInstanceId}/change_vnfpkg: + #SOL003 location: 5.4.11a.2 + parameters: + - $ref: '#/components/parameters/VnfInstanceId' + post: + description: | + The POST method changes the current VNF package on which the VNF instance is based. + This method shall follow the provisions specified in the tables 5.4.11a.3.1-1 and + 5.4.11a.3.1-2 for URI query parameters, request and response data structures, and + response codes. + The steps and conditions that apply as the result of successfully executing this method + are specified in clause 5.4.1.2. + During a change of the current VNF package, the allowed and required extensions and/or + VNF configurable properties and their data types, as well as the metadata data types, + can differ between the source and the destination VNFD. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/ChangeCurrentVnfPkgRequest' + responses: + 202: + $ref: '#/components/responses/ChangeVnfpkgVnfInstance.Post.202' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + #description: | + #409 CONFLICT + + #Shall be returned upon the following 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 another lifecycle management operation is ongoing, + #or that a required child attribute of the "extensions" attribute has not been set. + #Those attributes are marked as "required" in the VNFD. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # VNF LCM operation occurrences # ############################################################################### - '/vnf_lcm_op_occs': + /vnf_lcm_op_occs: #SOL003 location: 5.4.12 get: - description: > + description: | Get Operation Status. The API consumer can use this method to query status information about multiple VNF lifecycle management operation occurrences. This method shall follow the provisions specified in the tables 5.4.12.3.2-1 and 5.4.12.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The NFVO may supply this parameter. - All attribute names that appear in the VnfLcmOpOcc and in data types referenced from it - shall be supported by the VNFM in the filter expression. - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the VnfLcmOpOcc structure - in the response body if this parameter is provided, or none of the parameters - "all_fields," "fields", "exclude_fields", "exclude_default" are provided: - - vnfConfigurableProperties - - vimConnectionInfo - - instantiatedVnfInfo - - metadata - - extensions - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported by the - VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when status information for zero or more VNF lifecycle management - operation occurrences has been queried successfully. - The response body shall contain in an array the status information about zero or more - VNF lifecycle operation occurrences, as defined in clause 5.5.2.13. - If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), - "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request, - the data in the response body shall have been transformed according to the rules specified - in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: '#/components/responses/VnfLcmOpOccs.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual VNF LCM operation occurrence # ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}': + /vnf_lcm_op_occs/{vnfLcmOpOccId}: #SOL003 location: 5.4.13 parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a PATCH or POST request - triggering a VNF LCM operation. It can also be retrieved from the - "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' get: - description: > + description: | Get Operation Status. The API consumer can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an "Individual VNF LCM operation occurrence" resource. This method shall follow the provisions specified in the tables 5.4.13.3.2-1 and 5.4.13.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information about a VNF LCM operation occurrence washas been read successfully. - The response body shall contain status information about a VNF lifecycle management operation occurrence - (see clause 5.5.2.13). - 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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: '#/components/responses/IndividualVnfLcmOpOcc.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Retry operation task # ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry': + /vnf_lcm_op_occs/{vnfLcmOpOccId}/retry: #SOL003 location: 5.4.14 parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - retried. This identifier can be retrieved from the resource - referenced by the "Location" HTTP header in the response to a PATCH - or POST request triggering a VNF LCM operation. It can also be - retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' post: - description: > + description: | The POST method initiates retrying a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. @@ -1880,48 +978,19 @@ paths: "start" notification according to clause 5.6.2.2 shall be emitted to indicate that the underlying VNF LCM operation occurrence proceeds. 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response shall have an empty payload body. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 + $ref: '#/components/responses/RetryVnfLcmOpOcc.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -1931,46 +1000,36 @@ paths: #Specifically in case of this task resource, the response code 404 shall also be returned if the task #is not supported for the VNF LCM operation occurrence represented by the parent resource, #which means that the task resource consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, #due to a conflict with the state of the VNF LCM operation occurrence. #Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, #or another error handling action is starting, such as rollback or fail. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Rollback operation task # ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback': + /vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback: #SOL003 location: 5.4.15 parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be rolled back. This identifier can be retrieved from the resource - referenced by the "Location" HTTP header in the response to a PATCH - or POST request triggering a VNF LCM operation. It can also be - retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' post: - description: > + description: | The POST method initiates rolling back a VNF lifecycle operation if that operation has experienced a temporary failure, i.e. the related "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" state. @@ -1985,48 +1044,19 @@ paths: "start" notification according to clause 5.6.2.2 shall be emitted to indicate that rollback of the underlying VNF LCM operation occurrence is attempted. 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response shall have an empty payload body. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 + $ref: '#/components/responses/RollbackVnfLcmOpOcc.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -2036,46 +1066,36 @@ paths: #Specifically in case of this task resource, the response code 404 shall also be returned if the task #is not supported for the VNF LCM operation occurrence represented by the parent resource, #which means that the task resource consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, #due to a conflict with the state of the VNF LCM operation occurrence. #Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, #or another error handling action is starting, such as rollback or fail. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Fail operation task # ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail': + /vnf_lcm_op_occs/{vnfLcmOpOccId}/fail: #SOL003 location: 5.4.16 parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be marked as "failed". This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a PATCH or POST request triggering a VNF LCM operation. It can also - be retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' post: - description: > + description: | The POST method marks a VNF lifecycle management operation occurrence as "finally failed" if that operation occurrence is in "FAILED_TEMP" state. This method shall follow the provisions specified in the tables 5.4.16.3.1-1 and 5.4.16.3.1-2 @@ -2085,64 +1105,20 @@ paths: shall be emitted to indicate that the execution of the underlying VNF LCM operation occurrence has finally and unrecoverably failed. 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the state of the VNF lifecycle management operation occurrence - has been changed successfully. - The response shall include a representation of the "Individual VNF lifecycle operation occurrence" resource. - 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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + $ref: '#/components/responses/FailVnfLcmOpOcc.Post.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - #description: > + #description: | #404 NOT FOUND #Shall be returned upon the following error: The API producer did not find a current representation @@ -2152,46 +1128,36 @@ paths: #Specifically in case of this task resource, the response code 404 shall also returned if the task #is not supported for the VNF LCM operation occurrence represented by the parent resource, which means #that the task resource consequently does not exist. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict #with the state of the VNF LCM operation occurrence. #Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state, #or another error handling action is starting, such as retry or rollback. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Cancel operation task # ############################################################################### - '/vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel': + /vnf_lcm_op_occs/{vnfLcmOpOccId}/cancel: #SOL003 location: 5.4.17 parameters: - - name: vnfLcmOpOccId - description: > - Identifier of a VNF lifecycle management operation occurrence to be - be cancelled. This identifier can be retrieved from the - resource referenced by the "Location" HTTP header in the response to - a PATCH or POST request triggering a VNF LCM operation. It can also - be retrieved from the "vnfLcmOpOccId" attribute in the - VnfLcmOperationOccurrenceNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfLcmOpOccId' post: - description: > + description: | The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled back, i.e. the related "Individual VNF LCM operation occurrence" resource is either in "STARTING" or "PROCESSING" or "ROLLING_BACK" state. @@ -2217,389 +1183,171 @@ paths: still succeed, in which case the "operationState" attribute in the representation of the parent resource shall represent the result of that operation, rather than the result of the cancellation. 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing. - The response shall have an empty payload body. - headers: - WWW-Authenticate: - description: > - Challenge if the corresponding HTTP request has not provided - authorization, or error details if the corresponding HTTP - request has provided an invalid authorization token. - type: string - maximum: 1 - minimum: 0 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 + $ref: '#/components/responses/CancelVnfLcmOpOcc.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - #description: > + #description: | #409 CONFLICT #Shall be returned upon the following error: The operation cannot be executed currently, #due to a conflict with the state of the VNF LCM operation occurrence. #Typically, this is due to the fact that the operation occurrence is not in STARTING, #PROCESSING or ROLLING_BACK state. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Subscriptions # ############################################################################### - '/subscriptions': + /subscriptions: #SOL003 location: 5.4.18 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables 5.4.18.3.1-1 and 5.4.18.3.1-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, a new "Individual subscription" resource as defined in clause 5.4.3 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and the same filter + Creation of two "Individual subscription" resources with the same callback URI and the same filter can result in performance degradation and will provide duplicates of notifications to the NFVO, and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating an "Individual subscription" resource if another "Individual subscription" resource with the same - filter and callbackUri already exists (in which case it shall return the "201 Created" response code), + filter and callback URI already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource - with the same filter and callbackUri). - parameters: - - name: LccnSubscriptionRequest - description: > - Details of the subscription to be created. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest" - - 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 + with the same filter and callback URI). + requestBody: + $ref: '#/components/requestBodies/LccnSubscriptionRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location" HTTP header that points to the created - "Individual subscription" resource. - 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 VNF 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: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + $ref: '#/components/responses/Subscriptions.Post.201' 303: - #description: > + #description: | #303 SEE OTHER - #Shall be returned if a subscription with the same callbackURI and the same filter already exists + #Shall be returned if a subscription with the same callback URI and the same filter already exists #and the policy of the VNFM is to not create redundant subscriptions. #The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing #"Individual subscription" resource. #The response body shall be empty. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303" 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query Subscription Information. 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. 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: filter - description: > - Attribute-based filtering expression according to clause 4.3.2. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the LccnSubscription and in - data types referenced from it shall be supported by the VNFM - in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 4.7.2.1 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active subscriptions of - the functional block that invokes the method, i.e. zero or more representations of lifecycle change - notification subscriptions as defined in clause 5.5.2.16. - If the "filter" URI parameter was supplied in the request, the data in the response body shall have been - transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + $ref: '#/components/responses/Subscriptions.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual subscription # ############################################################################### - '/subscriptions/{subscriptionId}': + /subscriptions/{subscriptionId}: #SOL003 location: 5.4.19 parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by - the "Location" HTTP header in the response to a POST request - creating a new subscription resource. It can also be retrieved from - the "id" attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query Subscription Information. The GET method retrieves information about a subscription by reading an "Individual subscription" resource. This method shall follow the provisions specified in the tables 5.4.19.3.2-1 and 5.4.19.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has been read successfully. - The response body shall contain a representation of the "Individual subscription" resource. - 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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + $ref: '#/components/responses/IndividualSubscription.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: - description: > + description: | Terminate Subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 5.4.19.3.5-1 and 5.4.19.3.5-2 @@ -2611,57 +1359,1789 @@ paths: NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. + responses: + 204: + $ref: '#/components/responses/IndividualSubscription.Delete.204' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + ############################################################################### + # Create VNF snapshot task # + ############################################################################### + /vnf_instances/{vnfInstanceId}/create_snapshot: + #SOL003 location: 5.4.21.2 + parameters: + - $ref: '#/components/parameters/VnfInstanceId' + post: + description: | + The POST method requests taking a snapshot a VNF instance and populating a + previously created VNF snapshot resource (refer to clause 5.4.23.3.1) with + the snapshot content. + The steps and conditions that apply as the result of successfully executing + this method are specified in clause 5.4.1.2. + In addition, once the VNFM has successfully completed the underlying VNF LCM + operation occurrence, it shall reflect the result of the VNF snapshot creation + by updating the corresponding "Individual VNF snapshot" resource indicated by + the "vnfSnapshotInfoId" attribute of the "CreateVnfSnapshotRequest" that is + included in the payload body of the request. + This method shall follow the provisions specified in the tables 5.4.21.3.1-1 + and 5.4.21.3.1-2 for URI query parameters, request and response data structures, + and response codes. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/CreateVnfSnapshotRequest' + responses: + 202: + $ref: '#/components/responses/CreateVnfSnapshotTask.Post.202' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + #description: | + #404 NOT FOUND + + #Shall be returned upon the following error: The API producer did not find a current representation + #for the target resource or is not willing to disclose that one exists. + #The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, + #including rules for the presence of the response body. + #Specifically in case of this task resource, the response code 404 shall also be returned if the task + #is not supported for the VNF instance represented by the parent resource, which means that the task + #resource consequently does not exist. + #In this case, the response body shall be present, and shall contain a ProblemDetails structure, in + #which the "detail" attribute shall convey more information about the error. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + #description: | + #409 CONFLICT + + #Shall be returned upon the following 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 VNF 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 + #shall convey more information about the error. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + ############################################################################### + # Revert to VNF snapshot task # + ############################################################################### + /vnf_instances/{vnfInstanceId}/revert_to_snapshot: + #SOL003 location: 5.4.22.2 + parameters: + - $ref: '#/components/parameters/VnfInstanceId' + post: + description: | + The POST method requests reverting a VNF instance to a VNF snapshot. + This method shall follow the provisions specified in the tables 5.4.22.3.1-1 + and 5.4.22.3.1-2 for URI query parameters, request and response data structures, + and response codes. 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/RevertToVnfSnapshotRequest' + responses: + 202: + $ref: '#/components/responses/RevertToVnfSnapshotTask.Post.202' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + #description: | + #404 NOT FOUND + + #Shall be returned upon the following error: The API producer did not find a current representation + #for the target resource or is not willing to disclose that one exists. + #The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, + #including rules for the presence of the response body. + #Specifically in case of this task resource, the response code 404 shall also be returned if the task + #is not supported for the VNF instance represented by the parent resource, which means that the task + #resource consequently does not exist. + #In this case, the response body shall be present, and shall contain a ProblemDetails structure, in + #which the "detail" attribute shall convey more information about the error. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + #description: | + #409 CONFLICT + + #Shall be returned upon the following 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 VNF 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 + #shall convey more information about the error. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + ############################################################################### + # VNF snapshots # + ############################################################################### + /vnf_snapshots: + #SOL003 location: 5.4.23.2 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + post: + description: | + The POST method creates a new "Individual VNF snapshot" resource. + + As a result of successfully executing this method, a new "Individual VNF snapshot" + resource as defined in clause 5.4.24 shall have been created. + + The creation of an "Individual VNF snapshot" resource can be performed for two reasons: + - To create an "Individual VNF snapshot" resources that can later be populated by a + new VNF snapshot taken from a VNF instance (refer to clause 5.4.21.3.1). + - To create an "Individual VNF snapshot" resource that can be populated with information + gathered from a VNF snapshot package extraction. In this case, the API consumer indicates + the source of the VNF snapshot package in the payload body of the POST request to the + present resource. + + In the second case, for a successful execution of the operation, the values in the + "VnfSnapshotInfo" data structure representing the "Individual VNF snapshot" resource + shall be applied as follows: + - If the request (refer to clause 5.5.2.20) includes the "vnfSnapshot" attribute, + the VNFM shall apply the "VnfSnapshotInfo" with such provided information. + - If the request (refer to clause 5.5.2.20) does not include the "vnfSnapshot" + attribute, the VNFM shall first fetch the VNF snapshot record from the source VNF + snapshot package signalled by the "vnfSnapshotPkgId" attribute in the request and + then apply the "VnfSnapshotInfo" from the fetched VNF snapshot record. + + This method shall follow the provisions specified in the tables 5.4.23.3.1-1 + and 5.4.23.3.1-2 for URI query parameters, request and response data structures, + and response codes. + requestBody: + $ref: '#/components/requestBodies/CreateVnfSnapshotInfoRequest' + responses: + 201: + $ref: '#/components/responses/VnfSnapshots.Post.201' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + get: + description: > + The GET method queries information about multiple VNF snapshots. + This method shall follow the provisions specified in the tables 5.4.23.3.2-1 + and 5.4.23.3.2-2 for URI query parameters, request and response data structures, + and response codes. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + 200: + $ref: '#/components/responses/VnfSnapshots.Get.200' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + ############################################################################### + # Individual VNF snapshot # + ############################################################################### + /vnf_snapshots/{vnfSnapshotInfoId}: + #SOL003 location: 5.4.24.2 + parameters: + - $ref: '#/components/parameters/VnfSnapshotInfoId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + get: + #SOL003 location: 5.4.24.3.2 + description: | + The GET method retrieves information about a VNF snapshot by reading an "Individual VNF snapshot" + resource. + This method shall follow the provisions specified in the tables 5.4.24.3.2-1 and 5.4.24.3.2-2 + for URI query parameters, request and response data structures, and response codes. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + responses: + 200: + $ref: '#/components/responses/IndividualVnfSnapshot.Get.200' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + patch: + #SOL003 location: 5.4.24.3.4 + description: | + This method modifies an "Individual VNF snapshot" resource. + + Changes are applied to the VNF snapshot information managed by the VNFM and are reflected in the + representation of this resource. The VNFM shall reject the modification request if the "vnfSnapshot" + attribute in the "VnfSnapshotInfo" structure representing the "Individual VNF snapshot" resource + is not empty, or the resource is associated to an ongoing VNF snapshot operation (e.g., a VNF + snapshot creation process has started). + + This method shall follow the provisions specified in the tables 5.4.24.3.4-1 and 5.4.24.3.4-2 + for URI query parameters, request and response data structures, and response codes. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfSnapshotInfoModificationRequest' + responses: + 200: + $ref: '#/components/responses/IndividualVnfSnapshot.Patch.200' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 412: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + delete: + #SOL003 location: 5.4.24.3.5 + description: | + This method deletes an "Individual VNF snapshot" resource and the associated VNF snapshot + information managed by the VNFM, and any resource associated to the VNF snapshot managed + by the VIM. + As the result of successfully executing this method, the "Individual VNF snapshot" resource + shall not exist any longer. + This method shall follow the provisions specified in the tables 5.4.24.3.5-1 and 5.4.24.3.5-2 + for URI query parameters, request and response data structures, and response codes. responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualVnfSnapshot.Delete.204' + 400: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" + 401: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" + 403: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" + 405: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" + 406: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + #description: | + #409 CONFLICT + + #Shall be returned upon the following 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 VNF snapshot is in use by some operation such + #as reverting a VNF instance to a VNF snapshot or creating a VNF snapshot package. + #The response body shall contain a ProblemDetails structure, in which the "detail" attribute + #shall convey more information about the error. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 412: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" + 500: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" + 503: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + + /vnf_snapshots/{vnfSnapshotInfoId}/vnf_state_snapshot: + #SOL003 location: 5.4.25.2 + parameters: + - $ref: '#/components/parameters/VnfSnapshotInfoId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + + get: + #SOL003 location: 5.4.25.3.2 + description: | + The GET method fetches the content of the VNF state snapshot. + This method shall follow the provisions specified in the tables 5.4.25.3.2-1 and 5.4.25.3.2-2 + for URI query parameters, request and response data structures, and response codes. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: '#/components/parameters/Range' + responses: + 200: + $ref: '#/components/responses/IndividualVnfSnapshotState.Get.200' + 206: + $ref: '#/components/responses/IndividualVnfSnapshotState.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" + 409: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + +components: + parameters: + VnfInstanceId: + name: vnfInstanceId + in: path + description: | + Identifier of the VNF instance for the VNF snapshot to be reverted to. This identifier can be retrieved from the resource + referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual VNF instance" resource. + It can also be retrieved from the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + VnfLcmOpOccId: + name: vnfLcmOpOccId + in: path + description: | + Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource + referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. + It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification. + required: true + style: simple + explode: false + schema: + type: string + + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" + HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from + the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + VnfSnapshotInfoId: + name: vnfSnapshotInfoId + in: path + description: | + Identifier of the "Individual VNF snapshot" resource. This identifier can be retrieved + from the resource referenced by the "Location" HTTP header in the response to a POST request + creating a new VNF snapshot resource. It can also be retrieved from the "id" attribute in + the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + Range: + name: Range + in: header + description: | + The request may contain a "Range" HTTP header to obtain single + range of bytes from a VNF state snapshot file. This can be used to + continue an aborted transmission. + If the "Range" header is present in the request and the VNFM + does not support responding to range requests with a 206 + response, it shall return a 200 OK response instead. + schema: + type: string + + requestBodies: + CreateVnfRequest: + description: The VNF creation parameters + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest" + required: true + + VnfInfoModificationRequest: + description: | + Parameters for the VNF modification, as defined in clause 5.5.2.12. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest" + required: true + + InstantiateVnfRequest: + description: Parameters for the VNF instantiation. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest" + required: true + + ScaleVnfRequest: + description: Parameters for the scale VNF operation. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest" + required: true + + ScaleVnfToLevelRequest: + description: Parameters for the scale VNF to Level operation. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest" + required: true + + ChangeVnfFlavourRequest: + description: Parameters for the Change VNF Flavour operation. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest" + required: true + + TerminateVnfRequest: + description: Parameters for the VNF termination. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest" + required: true + + HealVnfRequest: + description: Parameters for the Heal VNF operation. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest" + required: true + + OperateVnfRequest: + description: Parameters for the Operate VNF operation. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest" + required: true + + ChangeExtVnfConnectivityRequest: + description: | + Parameters for the Change external VNF connectivity operation. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest" + required: true + + ChangeCurrentVnfPkgRequest: + description: | + Parameters for the Change current VNF package operation, as defined in clause 5.5.2.11a. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest" + required: true + + LccnSubscriptionRequest: + description: | + Details of the subscription to be created. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest" + required: true + + CreateVnfSnapshotRequest: + description: | + Parameters for the "Create VNF Snapshot" operation, as defined in clause 5.5.2.21. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotRequest" + required: true + + RevertToVnfSnapshotRequest: + description: | + Parameters for the Revert to VNF snapshot operation, as defined in clause 5.5.2.26. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/RevertToVnfSnapshotRequest" + required: true + + CreateVnfSnapshotInfoRequest: + description: | + The VNF snapshot resource creation parameters, as defined in clause 5.5.2.20. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfSnapshotInfoRequest" + required: true + + VnfSnapshotInfoModificationRequest: + description: | + Parameters for the VNF snapshot information modification, as defined in clause 5.5.2.24. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModificationRequest" + required: true + + responses: + VNFInstances.Post.201: + description: | + 201 CREATED + + Shall be returned when a new "Individual VNF instance" resource and + the associated VNF instance identifier washas been created successfully. + The response body shall contain a representation of the created VNF instance, + as defined in clause 5.5.2.2. + The HTTP response shall include a "Location" HTTP header that contains the resource + URI of the created VNF instance. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + + VNFInstances.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF instances has been queried successfully. + The response body shall contain in an array the representations of zero or more VNF instances, + as defined in clause 5.5.2.2. + If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" + (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response + body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of + ETSI GS NFV-SOL 013, respectively. + If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + + IndividualVnfInstance.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual VNF instance has been read successfully. + The response body shall contain a representation of the VNF instance, as defined in clause 5.5.2.2. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + + IndividualVnfInstance.Patch.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + On success, the HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "Individual VNF LCM operation occurrence" + resource corresponding to the operation. + The response body shall be empty. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance" + + IndividualVnfInstance.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the "Individual VNF instance" resource and the associated + VNF identifier were deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + InstantiateVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "Individual VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ScaleVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ScaleToLevelVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ChangeFlavourVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + TerminateVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + HealVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + OperateVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ChangeExtConnVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that + contains the URI of the newly-created "VNF LCM operation + occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ChangeVnfpkgVnfInstance.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that contains the URI of + the newly-created "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfLcmOpOccs.Get.200: + description: | + 200 OK + + Shall be returned when status information for zero or more VNF lifecycle management + operation occurrences has been queried successfully. + The response body shall contain in an array the status information about zero or more + VNF lifecycle operation occurrences, as defined in clause 5.5.2.13. + If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), + "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request, + the data in the response body shall have been transformed according to the rules specified + in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + + IndividualVnfLcmOpOcc.Get.200: + description: | + 200 OK + + Shall be returned when information about a VNF LCM operation occurrence washas been read successfully. + The response body shall contain status information about a VNF lifecycle management operation occurrence + (see clause 5.5.2.13). + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + + RollbackVnfLcmOpOcc.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response shall have an empty payload body. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + RetryVnfLcmOpOcc.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response shall have an empty payload body. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + FailVnfLcmOpOcc.Post.200: + description: | + 200 OK + + Shall be returned when the state of the VNF lifecycle management operation occurrence + has been changed successfully. + The response bofyshall include a representation of the "Individual VNF lifecycle operation occurrence" + resource. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc" + + CancelVnfLcmOpOcc.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing. + The response shall have an empty payload body. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + Subscriptions.Post.201: + description: | + 201 CREATED + + Shall be returned when the subscription has been created successfully. + The response body shall contain a representation of the created "Individual subscription" resource. + The HTTP response shall include a "Location" HTTP header that points to the created + "Individual subscription" resource. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + + Subscriptions.Get.200: + description: | + 200 OK + + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain in an array the representations of all active subscriptions of + the functional block that invokes the method, i.e. zero or more representations of lifecycle change + notification subscriptions as defined in clause 5.5.2.16. + If the "filter" URI parameter was supplied in the request, the data in the response body shall have been + transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.7.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 4.7.2.3.5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + + IndividualSubscription.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual subscription has been read successfully. + The response body shall contain a representation of the "Individual subscription" resource. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription" + + IndividualSubscription.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the "Individual subscription" resource has been deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + CreateVnfSnapshotTask.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + RevertToVnfSnapshotTask.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when 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 "VNF LCM operation occurrence" resource corresponding to the operation. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfSnapshots.Post.201: + description: | + 201 CREATED + + Shall be returned when an "Individual VNF snapshot" resource has been created + successfully. + The response body shall contain a representation of the new "Individual VNF snapshot" + resource, as defined in clause 5.5.2.22. + The HTTP response shall include a "Location" HTTP header that contains the resource URI + of the "Individual VNF snapshot" resource. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo" + + VnfSnapshots.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF snapshots was queried successfully. + The response body shall contain in an array the representations of zero or more + "Individual VNF snapshot" resources, as defined in clause 5.5.2.22. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo" + + IndividualVnfSnapshot.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual VNF snapshot was read successfully. + The response body shall contain a representation of the "Individual VNF snapshot" resource, + as defined in clause 5.5.2.22. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo" + + IndividualVnfSnapshot.Patch.200: + description: | + 200 OK + + Shall be returned when the modification of VNF snapshot information has been accepted and completed. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModifications" + + IndividualVnfSnapshot.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the VNF snapshot resource and the associated VNF snapshot were + deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfSnapshotState.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the VNF state snapshot file has been read successfully. + + The payload body shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP + header shall be set according to the content type of the VNF state snapshot file. If the VNF state + snapshot content is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193). + + If the content type cannot be determined, the header shall be set to the value "application/octet-stream". + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + content: + application/*: + schema: + type: string + format: binary + + IndividualVnfSnapshotState.Get.206: + description: | + 206 PARTIAL CONTENT + + If the VNFM supports range requests, this response shall be returned when a single consecutive byte + range from the content of the VNF state snapshot file has been read successfully according to the request. + + The response body shall contain the requested part of the VNF state snapshot file. The "Content-Type" HTTP + header shall be set according to the content type of the VNF state snapshot file. If the content type cannot + be determined, the header shall be set to the value "application/octet-stream". + + The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Content-Range: + required : true + style: simple + explode: false + schema: + type: string + content: + application/*: + schema: + type: string + format: binary diff --git a/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml index 11b3331c90d11d634763f3a224167914fa8b3b62..31dd81a1d47a33a676f0c0d31dbb7583e7cdbfa8 100644 --- a/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml +++ b/src/SOL003/VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml @@ -2,6 +2,654 @@ # https://forge.etsi.org/etsi-forge-copyright-notice.txt definitions: + InstantiateVnfRequest: + #SOL003 location: 5.5.2.4 + type: object + required: + - flavourId + properties: + flavourId: + description: > + Identifier of the VNF deployment flavour to be instantiated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + 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 VNFD is instantiated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + extVirtualLinks: + description: > + Information about external VLs to connect the VNF to. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + extManagedVirtualLinks: + description: > + Information about internal VLs that are managed by the NFVO. + + NOTES: + The indication of externally-managed internal VLs is needed in case networks have been pre-configured + for use with certain VNFs, for instance to ensure that these networks have certain properties such as + security or acceleration features, or to address particular network topologies. The present document + assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. + + It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a + multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same + VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed + multi-site VL instance (refer to clause 4.4.1.12). + type: array + items: + $ref: "#/definitions/ExtManagedVirtualLinkData" + vimConnectionInfo: + description: > + Information about VIM connections to be used for managing the resources for the VNF instance, or refer to + external / externally-managed virtual links. This attribute shall only be supported and may be present if + VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this + attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch + (see IETF RFC 7396). + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + + localizationLanguage: + description: > + Localization language of the VNF to be instantiated. The value shall + comply with the format defined in IETF RFC 5646. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + additionalParams: + description: > + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "InstantiateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute provides modifications to the default values, + as obtained from the VNFD, of the "extensions" attribute in "VnfInstance", + as defined in clause 5.5.2.2. Provisions for handling extensions during the + operation are defined in clause 5.4.4.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfConfigurableProperties: + description: > + If present, this attribute provides modifications to the default values, as obtained from the VNFD, of + the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for + handling configurable properties during the operation are defined in clause 5.4.4.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + ExtManagedVirtualLinkData: + type: object + required: + - id + - vnfVirtualLinkDescId + - resourceId + properties: + id: + description: > + The identifier of the externally-managed internal VL instance. The + identifier is assigned by the NFV-MANO entity that manages this VL + instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfVirtualLinkDescId: + description: > + The identifier of the VLD in the VNFD for this VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vimConnectionId: + description: > + Identifier of the VIM connection to manage this resource. This + attribute shall only be supported and present if VNF-related + resource management in direct mode is applicable. + $ref: "../../../definitions/SOL002SOL003_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/SOL002SOL003_def.yaml#/definitions/Identifier" + resourceId: + description: > + The identifier of the resource in the scope of the VIM or the + resource provider. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" + vnfLinkPort: + description: > + Externally provided link ports to be used to connect VNFC connection points to this externally-managed VL + on this network resource. If this attribute is not present, the VNFM shall create the link ports on the + externally-managed VL. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VnfLinkPortData" + extManagedMultisiteVirtualLinkId: + description: > + Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO + entity that manages the externally managed multi-site VL instance. It shall be present when the present + externally-managed internal VL (indicated by extManagedVirtualLinkId) is part of a multi-site VL, e.g., + in support of multi-site VNF spanning several VIMs. All externally-managed internal VL instances + corresponding to an internal VL created based on the same virtualLinkDescId shall refer to the same + extManagedMultisiteVirtualLinkId. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + + ChangeVnfFlavourRequest: + #SOL003 location: 5.5.2.7 + description: > + This type represents request parameters for the "Change VNF flavour" operation. + type: object + required: + - newFlavourId + properties: + newFlavourId: + description: > + Identifier of the VNF deployment flavour to be instantiated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + 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 VNFD is instantiated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + extVirtualLinks: + description: > + Information about external VLs to connect the VNF to. + Entries in the list of external VLs that are unchanged need not be supplied as part of this request. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + extManagedVirtualLinks: + description: > + Information about internal VLs that are managed by the NFVO. + + NOTES: + The indication of externally-managed internal VLs is needed in case networks have been pre-configured + for use with certain VNFs, for instance to ensure that these networks have certain properties such as + security or acceleration features, or to address particular network topologies. The present document + assumes that externally-managed internal VLs are managed by the NFVO and created towards the VIM. + + It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a + multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same + VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed + multi-site VL instance (refer to clause 4.4.1.12). + type: array + items: + $ref: "#/definitions/ExtManagedVirtualLinkData" + vimConnectionInfo: + description: > + Information about VIM connections to be used for managing the resources for the VNF instance, or refer to + external / externally-managed virtual links. This attribute shall only be supported and may be present if + VNF-related resource management in direct mode is applicable. The VNFM shall apply the content of this + attribute to the "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch + (see IETF RFC 7396). + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + additionalParams: + description: > + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "InstantiateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute provides modifications to the values of the "extensions" + attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling + extensions during the operation, are defined in clause 5.4.7.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfConfigurableProperties: + description: > + If present, this attribute provides modifications to the values of the "vnfConfigurableProperties" attribute + in "VnfInstance", as defined in clause 5.5.2.2. + Provisions for handling VNF configurable properties during the operation, are defined in clause 5.4.7.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + TerminateVnfRequest: + type: object + required: + - terminationType + properties: + terminationType: + description: > + Indicates whether forceful or graceful termination is requested. + Permitted values: + * FORCEFUL: The VNFM will shut down the VNF and release the + resources immediately after accepting the request. + * GRACEFUL: The VNFM will first arrange to take the VNF out of + service after accepting the request. Once the operation of taking + the VNF out of service finishes (irrespective of whether it has + succeeded or failed) or once the timer value specified in the + "gracefulTerminationTimeout" attribute expires, the VNFM will shut + down the VNF and release the resources. + type: string + enum: + - FORCEFUL + - GRACEFUL + gracefulTerminationTimeout: + description: > + This attribute is only applicable in case of graceful termination. + It defines the time to wait for the VNF to be taken out of service + before shutting down the VNF and releasing the resources. + The unit is seconds. + If not given and the "terminationType" attribute is set to + "GRACEFUL", it is expected that the VNFM waits for the successful + taking out of service of the VNF, no matter how long it takes, + before shutting down the VNF and releasing the resources. + type: integer + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the termination + process, specific to the VNF being terminated, as declared in the + VNFD as part of "TerminateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + HealVnfRequest: + type: object + properties: + cause: + description: > + Indicates the reason why a healing procedure is required. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + additionalParams: + 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". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + OperateVnfRequest: + description: > + This type represents request parameters for the "Operate VNF" operation. + type: object + required: + - changeStateTo + properties: + changeStateTo: + description: > + The desired operational state (i.e. started or stopped) to change + the VNF to. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType" + stopType: + description: > + It signals whether forceful or graceful stop is requested. + The “stopType” and “gracefulStopTimeout” attributes shall be absent, + when the “changeStateTo” attribute is equal to “STARTED”. The + “gracefulStopTimeout” attribute shall be present, when the + “changeStateTo” is equal to “STOPPED” and the “stopType” attribute + is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be + absent, when the “changeStateTo” attribute is equal to “STOPPED” and + the “stopType” attribute is equal to “FORCEFUL”. The request shall + be treated as if the “stopType” attribute was set to ”FORCEFUL”, when + the “changeStateTo” attribute is equal to “STOPPED” and the + “stopType” attribute is absent. + $ref: "#/definitions/StopType" + gracefulStopTimeout: + description: > + The time interval (in seconds) to wait for the VNF to be taken out + of service during graceful stop, before stopping the VNF. + The “stopType” and “gracefulStopTimeout” attributes shall be absent, + when the “changeStateTo” attribute is equal to “STARTED”. The + “gracefulStopTimeout” attribute shall be present, when the + “changeStateTo” is equal to “STOPPED” and the “stopType” attribute + is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be + absent, when the “changeStateTo” attribute is equal to “STOPPED” and + the “stopType” attribute is equal to “FORCEFUL”. The request shall + be treated as if the “stopType” attribute was set to ”FORCEFUL”, when + the “changeStateTo” attribute is equal to “STOPPED” and the + “stopType” attribute is absent. + type: integer + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the process, + specific to the VNF of which the operation status is changed, as + declared in the VNFD as part of "OperateVnfOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + ChangeExtVnfConnectivityRequest: + #SOL003 location: 5.5.2.11 + description: > + This type represents request parameters for the + "Change external VNF connectivity" operation to modify the external + connectivity of a VNF instance. + type: object + required: + - extVirtualLinks + properties: + extVirtualLinks: + description: > + Information about external VLs to change (e.g. connect the VNF to). + Entries in the list of external VLs that are unchanged need not be supplied as part of this request. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + vimConnectionInfo: + description: > + Information about VIM connections to be used for managing the resources for the VNF instance, or refer to + external virtual links. This attribute shall only be supported and may be present if VNF-related resource + management in direct mode is applicable. The VNFM shall apply the content of this attribute to the + "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + additionalParams: + description: > + Additional input parameters for the instantiation process, specific + to the VNF being instantiated, as declared in the VNFD as part of + "ChangeExtVnfConnectivityOpConfig".". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + ChangeCurrentVnfPkgRequest: + #SOL003 location: 5.5.2.11a + description: > + This type represents request parameters for the "Change current VNF package" + operation to replace the VNF package on which a VNF instance is based. + type: object + required: + - vnfdId + properties: + vnfdId: + description: > + Identifier of the VNFD which defines the destination VNF Package for the + change. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + extVirtualLinks: + description: > + Information about external VLs to connect the VNF to. Entries in the list + that are unchanged need not be supplied as part of this request. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" + extManagedVirtualLinks: + description: > + Information about internal VLs that are managed by the NFVO. + + NOTES: + The indication of externally-managed internal VLs is needed in case networks have been pre-configured for + use with certain VNFs, for instance to ensure that these networks have certain properties such as security or + acceleration features, or to address particular network topologies. The present document assumes that + externally-managed internal VLs are managed by the NFVO and created towards the VIM. + It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site + VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal + VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL + instance (refer to clause 4.4.1.12). + type: array + items: + $ref: "#/definitions/ExtManagedVirtualLinkData" + vimConnectionInfo: + description: > + Information about VIM connections to be used for managing the resources for the VNF instance, or refer to + external virtual links. This attribute shall only be supported and may be present if VNF-related resource + management in direct mode is applicable. The VNFM shall apply the content of this attribute to the + "vimConnectionInfo" attribute of "VnfInstance" according to the rules of JSON Merge Patch (see IETF RFC 7396). + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + additionalParams: + description: > + Additional parameters passed by the NFVO as input to the process, specific + to the VNF of which the underlying VNF package is changed, as declared in + the VNFD as part of "ChangeCurrentVnfPkgOpConfig". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute provides modifications to the values of the + "extensions" attribute in "VnfInstance", as defined in clause 5.5.2.2. + Provisions for handling extensions during the operation, and needed passed + parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfConfigurableProperties: + description: > + If present, this attribute provides modifications to the values of the "vnfConfigurableProperties" attribute + in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling VNF configurable properties during the + operation, and needed passed parameter values in case of conflicts, are defined in clause 5.4.11a.3.1. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfInfoModificationRequest: + description: > + This type represents attribute modifications for an + "Individual VNF instance" resource, i.e. modifications to a resource + representation based on the "VnfInstance" data type. + type: object + properties: + vnfInstanceName: + description: > + New value of the "vnfInstanceName" attribute in "VnfInstance", or + "null" to remove the attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfInstanceDescription: + description: > + New value of the "vnfInstanceDescription" attribute in + "VnfInstance", or "null" to remove the attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfPkgId: + description: > + New value of the "vnfPkgId" attribute in "VnfInstance". + The value "null" is not permitted. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfConfigurableProperties: + description: > + Modifications of the "vnfConfigurableProperties" attribute in + "VnfInstance". If present, these modifications shall be applied + according to the rules of JSON Merge Patch (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + Modifications of the "metadata" attribute in "VnfInstance". If + present, these modifications shall be applied according to the rules + of JSON Merge Patch (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + Modifications of the "extensions" attribute in "VnfInstance". If + present, these modifications shall be applied according to the rules + of JSON Merge Patch (see IETF RFC 7396). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vimConnectionInfo: + description: > + Modifications of the "vimConnectionInfo" attribute. If present, these + modifications shall be applied according to the rules of + JSON Merge Patch (see IETF RFC 7396 ). + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + + VnfInfoModifications: + description: > + This type represents attribute modifications that were performed on an + "Individual VNF instance" resource. The attributes that can be included + consist of those requested to be modified explicitly in the + "VnfInfoModificationRequest" data structure, and additional attributes + of the "VnfInstance" data structure that were modified implicitly e.g. + when modifying the referenced VNF package. + type: object + properties: + vnfInstanceName: + description: > + If present, this attribute signals modifications of the + "vnfInstanceName" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfInstanceDescription: + description: > + If present, this attribute signals modifications of the + "vnfInstanceDescription" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfConfigurableProperties: + description: > + If present, this attribute signals modifications of the + "vnfConfigurableProperties" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + If present, this attribute signals modifications of the "metadata" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + If present, this attribute signals modifications of the "extensions" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vimConnectionInfo: + description: > + If present, this attribute signals modifications the "vimConnectionInfo" + attribute array in "VnfInstance". + type: object + additionalProperties: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" + vnfdId: + description: > + If present, this attribute signals modifications of the "vnfdId" + attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfProvider: + description: > + If present, this attribute signals modifications of the + "vnfProvider" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfPkgId" attribute) was modified implicitly following a request to + modify the "vnfPkgId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfPkgId” attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfProductName: + description: > + If present, this attribute signals modifications of the + "vnfProductName" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfPkgId" attribute) was modified implicitly following a request to + modify the "vnfPkgId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfPkgId” attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + vnfSoftwareVersion: + description: > + If present, this attribute signals modifications of the + "vnfSoftwareVersion" attribute in "VnfInstance". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + vnfdVersion: + description: > + If present, this attribute signals modifications of the + "vnfdVersion" attribute in "VnfInstance". + If present, this attribute (which depends on the value of the + "vnfPkgId" attribute) was modified implicitly following a request to + modify the "vnfPkgId" attribute, by copying the value of this + attribute from the VNFD in the VNF Package identified by the + "vnfPkgId” attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + + StopType: + description: > + * FORCEFUL: The VNFM will stop the VNF instance immediately after accepting + the request. + * GRACEFUL: The VNFM instance will first arrange to take the VNF out of + service after accepting the request. Once that operation is successful + or once the timer value specified in the "gracefulStopTimeout" attribute + expires, the VNFM will stop the VNF instance. + type: string + enum: + - FORCEFUL + - GRACEFUL + + CreateVnfSnapshotRequest: + description: > + This type represents request parameters for the "Create VNF Snapshot" + LCM operation which takes a snapshot of a VNF instance and populates + a previously-created "Individual VNF snapshot" resource with the content + of the snapshot. + It shall comply with the provisions defined in table 5.5.2.21-1. + type: object + required: + - vnfSnapshotResId + properties: + vnfSnapshotInfoId: + description: > + Identifier of the "Individual VNF snapshot" resource to which the + VNF snapshot is to be associated. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + additionalParams: + description: > + Additional input parameters for the snapshot creation process, specific + for the VNF being “snapshotted”, as declared in the VNFD as part of + “CreateSnapshotVnfOpConfig”. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + userDefinedData: + description: > + User defined data for the VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + CreateVnfSnapshotInfoRequest: + description: | + This type represents request parameters for the creation of an "Individual VNF snapshot" resource which can be + populated with content obtained by invoking the "Create VNF snapshot" LCM operation or extracted from a + VNF snapshot package. It shall comply with the provisions defined in table 5.5.2.20-1. + type: object + properties: + vnfSnapshotPkgId: + description: | + Identifier of the VNF snapshot package information held by the NFVO. + + The present attribute shall be provided if the "Individual VNF snapshot" resource is requested to be created + as part of a VNF snapshot package extraction. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshot: + description: | + Information about the VNF snapshot, content and/or reference to its content. + $ref: "#/definitions/VnfSnapshot" + + RevertToVnfSnapshotRequest: + description: > + This type represents request parameters for the "Revert to VNF Snapshot" operation. + type: object + required: + - vnfSnapshotInfoId + properties: + vnfSnapshotInfoId: + description: > + Identifier of the "Individual VNF snapshot" resource with the information of the VNF snapshot + to be reverted to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + additionalParams: + description: > + Additional input parameters for the revert to VNF snapshot process, specific for the VNF being + “reverted”, as declared in the VNFD as part of “RevertToSnapshotVnfOpConfig”. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfSnapshotInfoModificationRequest: + description: | + This type represents attribute modifications for an "Individual VNF snapshot" resource, i.e. modifications + to a resource representation based on the "VnfSnapshotInfo" data type. The attributes of "VnfSnapshotInfo" + that can be modified according to the provisions in clause 5.5.2.22 are included in the + "VnfSnapshotInfoModificationRequest" data type. The "VnfSnapshotInfoModificationRequest" data type shall + comply with the provisions defined in table 5.5.2.24-1. + type: object + properties: + vnfSnapshotPkgId: + description: | + New value of the "vnfSnapshotPkgId" attribute in "VnfSnapshotInfo". + The value "null" is not permitted. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshot: + description: | + New value of the "vnfSnapshot" attribute in "VnfSnapshotInfo". + The value "null" is not permitted. + $ref: "#/definitions/VnfSnapshot" + + VnfSnapshotInfoModifications: + description: | + This type represents attribute modifications that were performed on an "Individual VNF snapshot" + resource. The attributes that can be included consist of those requested to be modified explicitly + in the "VnfSnapshotInfoModificationRequest" data structure, and additional attributes of the + "VnfSnapshotInfo" data structure that were modified implicitly. The "VnfSnapshotInfoModifications" + data type shall comply with the provisions defined in table 5.5.2.25-1. + type: object + properties: + vnfSnapshotPkgId: + description: | + If present, this attribute signals modifications of the "vnfSnapshotPkgId" attribute in + "VnfSnapshotInfo" as defined in clause 5.5.2.22. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshot: + description: | + If present, this attribute signals modifications of the "vnfSnapshot" attribute in + "VnfSnapshotInfo" as defined in clause 5.5.2.22. + $ref: "#/definitions/VnfSnapshot" + VnfInstance: description: > This type represents a VNF instance. @@ -56,7 +704,7 @@ definitions: vnfdVersion: description: > Identifies the version of the VNFD. The value is copied from the VNFD. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" + $ref: "../../..//definitions/SOL002SOL003_def.yaml#/definitions/Version" vnfConfigurableProperties: description: > Current values of the configurable properties of the VNF instance. @@ -82,22 +730,33 @@ definitions: set to true, auto-healing is currently enabled. If set to false, auto-healing is currently disabled. These configurable properties can be initialized with default values - from the VNFD (see note 4) or with values passed in the InstantiateVnfRequest - structure (see clause 5.5.2.4). - Configurable properties initialized with default values from the VNFD can be - updated with values passed in the InstantiateVnfRequest structure. + from the VNFD. + Configurable properties can be modified with values passed in the request + structures of certain LCM operations, such as the InstantiateVnfRequest + structure. Further, these configurable properties can be created, modified or deleted with the PATCH method. + + NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes + of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined + initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", + obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" + and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent + with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion + request. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" vimConnectionInfo: description: > Information about VIM connections to be used for managing the - resources for the VNF instance. This attribute shall only be - supported and present if VNF-related resource management in direct - mode is applicable. + resources for the VNF instance. The keys of the map, each of + which identifies information about a particular VIM connection, + are managed by the NFVO and referenced from other data structures + via the "vimConnectionId" attribute. This attribute shall only + be supported and present if VNF-related resource management in + direct mode is pplicable. This attribute can be modified with the PATCH method. - type: array - items: + type: object + additionalProperties: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" instantiationState: description: > @@ -142,7 +801,9 @@ definitions: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleInfo" extCpInfo: description: > - Information about the external CPs exposed by the VNF instance. + Information about the external CPs exposed by the VNF instance. When trunking is enabled, + the list of entries includes both, external CPs corresponding to parent ports of a trunk, + and external CPs associated to sub-ports of a trunk. type: array minItems: 1 items: @@ -155,10 +816,16 @@ definitions: $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" extManagedVirtualLinkInfo: description: > - External virtual links the VNF instance is connected to. + Information about the externally-managed internal VLs of the VNF instance. + + NOTE: It is possible to have several ExtManagedVirtualLinkInfo for the same + VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of + ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL shall indicate + so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site + VL instance (refer to clause 5.5.3.3). type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkInfo" + $ref: "#/definitions/ExtManagedVirtualLinkInfo" monitoringParameters: description: > Active monitoring parameters. @@ -179,20 +846,20 @@ definitions: by the VNFCs of the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcResourceInfo" + $ref: "#/definitions/VnfcResourceInfo" virtualLinkResourceInfo: description: > Information about the virtualised network resources used by the VLs of the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfVirtualLinkResourceInfo" + $ref: "#/definitions/VnfVirtualLinkResourceInfo" virtualStorageResourceInfo: description: > Information on the virtualised storage resource(s) used as storage for the VNF instance. type: array items: - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VirtualStorageResourceInfo" + $ref: "#/definitions/VirtualStorageResourceInfo" metadata: description: > Additional VNF-specific attributes that provide metadata describing the VNF instance. @@ -205,7 +872,7 @@ definitions: The declaration of metadata in the VNFD can optionally contain the specification of initial values. The VNFM shall accept requests to write metadata that are not declared in the VNFD. These attributes can be initialized with default values from the VNFD or with values - passed in the CreateVnfRequest structure (see clause 5.5.2.3). + passed in the CreateVnfRequest structure (see clause 5.4.2.3.1). This attributeThese attributes can be created, modified or removed with the PATCH method. ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. @@ -229,17 +896,403 @@ definitions: Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified attribute values can be considered during subsequent VNF lifecycle management operations, which means that the modified values can indirectly affect the configuration of the VNF instance. - These attributes can be initialized with default values from the VNFD or with values passed in the - InstantiateVnfRequest structure (see clause 5.5.2.4). - Attributes initialized with default values from the VNFD can be updated with values passed in the - InstantiateVnfRequest structure. + These attributes can be initialized with default values from the VNFD. + These attributes can be modified with values passed in the request structures of certain LCM operations, + such as the InstantiateVnfRequest structure. Further, these attributes can be created, modified or deleted with the PATCH method. - Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes - of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with - a defined initial value. Child attributes of "vnfConfigurableProperties", "metadata" and "extensions" - that have no declared initial value shall not be created, in order to be consistent with the semantics - of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request. + NOTE: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes + of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined + initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata", + obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata" + and "extensions" that have no defineddeclared initial value shall not be created, in order to be consistent + with the semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion + request. + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + description: URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + indicators: + description: Indicators related to this VNF instance, if applicable. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + instantiate: + description: > + Link to the "Instantiate VNF task" resource, if the related operation + is possible based on the current status of this VNF instance + resource (i.e. VNF instance in NOT_INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + terminate: + description: > + Link to the "Terminate VNF task" resource, if the related operation + is possible based on the current status of this VNF instance + resource (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + scale: + description: > + Link to the "Scale VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource (i.e. VNF instance + is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + scaleToLevel: + description: > + Link to the "Scale VNF to level task" resource, if the related + operation is supported for this VNF instance, and is possible + based on the current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + changeFlavour: + description: > + Link to the "Change VNF flavour task" resource, if the related + operation is supported for this VNF instance, and is possible + based on the current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + heal: + description: > + Link to the "Heal VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + operate: + description: > + Link to the "Operate VNF task" resource, if the related operation is + supported for this VNF instance, and is possible based on the + current status of this VNF instance resource + (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + changeExtConn: + description: > + Link to the "Change external VNF connectivity task" resource, if the related + operation is possible based on the current status of this VNF + instance resource (i.e. VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + createSnapshot: + description: > + Link to the "Create VNF snapshot task" resource, if the related operation is + supported for this VNF instance and is possible based on the current status of + this VNF instance resource (i.e., VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + revertToSnapshot: + description: > + Link to the "Revert to VNF snapshot task" resource, if the related operation is + supported for this VNF instance and is possible based on the current status of + this VNF instance resource (i.e., VNF instance is in INSTANTIATED state). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + ExtManagedVirtualLinkInfo: + type: object + required: + - id + - vnfVirtualLinkDescId + - networkResource + properties: + id: + description: > + Identifier of the externally-managed internal VL and the related + externally-managed VL information instance. + The identifier is assigned by the NFV-MANO entity that manages this + VL instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfVirtualLinkDescId: + description: > + Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + networkResource: + description: > + Reference to the VirtualNetwork resource providing this VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + vnfLinkPorts: + description: > + Link ports of this VL. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" + extManagedMultisiteVirtualLinkId: + description: > + Identifier of the externally-managed multi-site VL instance. The identifier is assigned by the NFVMANO entity + that manages the externally managed multi-site VL instance. It shall be present when the externally-managed + internal VL is part of a multi-site VL, e.g., in support of multi-site VNF spanning several VIMs. + All externally-managed internal VL instances corresponding to an internal VL created based on the same + virtualLinkDescId shall refer to the same extManagedMultisiteVirtualLinkId. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + + VirtualStorageResourceInfo: + description: > + This type represents the information that allows addressing a virtualised + resource that is used by a VNF instance. + type: object + required: + - id + - virtualStorageDescId + - storageResource + properties: + id: + description: > + Identifier of this VirtualStorageResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + virtualStorageDescId: + description: > + Identifier of the VirtualStorageDesc in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + storageResource: + description: > + Reference to the VirtualStorage resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + zoneId: + description: > + The identifier of the resource zone, as managed by the resource + management layer (typically, the VIM), where the referenced + VirtualStorage resource is placed. Shall be provided if this + information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + metadata: + description: > + Metadata about this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfcResourceInfo: + description: > + This type represents the information on virtualised compute and storage + resources used by a VNFC in a VNF instance. + type: object + required: + - id + - vduId + - computeResource + properties: + id: + description: > + Identifier of this VnfcResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vduId: + description: > + Reference to the applicable VDU in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + computeResource: + description: > + Reference to the VirtualCompute resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + zoneId: + description: > + The identifier of the resource zone, as managed by the + resource management layer (typically, the VIM), where + the referenced VirtualCompute resource is placed. + Shall be provided if this information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + storageResourceIds: + description: > + References to the VirtualStorage resources. The value refers to a + VirtualStorageResourceInfo item in the VnfInstance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcCpInfo: + description: > + All the CPs of the VNFC instance. + Shall be present when that particular CP of the VNFC instance is exposed as an external CP of the VNF instance + or is connected to an external CP of the VNF instance. + A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes an external CP. + A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. + May be present otherwise. + type: array + items: + type: object + required: + - id + - cpdId + properties: + id: + description: > + Identifier of this VNFC CP instance and the associated array + entry. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + cpdId: + description: > + Identifier of the VDU CPD, cpdId, in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfExtCpId: + description: > + Identifier of the related external CP. Shall be present when the VNFC CP is exposed as an external CP of + the VNF instance or connected to an external CP of the VNF instance (see note) and shall be absent otherwise. + + NOTE: A VNFC CP is "connected to" an external CP if the VNFC CP is connected to an internal VL that exposes + an external CP. A VNFC CP is "exposed as" an external CP if it is connected directly to an external VL. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + cpProtocolInfo: + description: > + Network protocol information for this CP. May be omitted if the VNFC CP is exposed as an external CP. + The information can be omitted because it is already available as part of the external CP information. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CpProtocolInfo" + vnfLinkPortId: + description: > + Identifier of the "VnfLinkPortInfo" structure in the "VnfVirtualLinkResourceInfo" structure. Shall be present if + the CP is associated to a link port on an internal VL of the VNF instance and shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + metadata: + description: > + Metadata about this CP. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + Metadata about this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfSnapshotInfo: + description: > + This type represents an "Individual VNF snapshot" resource. + It shall comply with the provisions defined in table 5.5.2.22-1. + type: object + required: + - id + - _links + properties: + id: + description: > + Identifier of the "Individual VNF snapshot" resource. This identifier is allocated by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshotPkgId: + description: > + Identifier of the VNF snapshot package information held by the NFVO. Shall be present when the + “Individual VNF snapshot" resource is created from a VNF snapshot package extraction. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshot: + description: > + Information about the VNF snapshot, content and/or references to its content. Shall be present + when the "Individual VNF snapshot" resource is associated to a VNF snapshot created via the + corresponding "Create VNF Snapshot" task resource or extracted from a VNF snapshot package. + $ref: "#/definitions/VnfSnapshot" + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + takenFrom: + description: > + Link to the VNF instance from which this snapshot was taken. Shall be present when the + "Individual VNF snapshot" resource is associated to a VNF snapshot created via the + corresponding "Create VNF snapshot" task resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + VnfStateSnapshotInfo: + description: > + This type represents information about VNF-specific state snapshot data. + type: object + required: + - checksum + - isEncrypted + properties: + checksum: + description: > + Checksum of the VNF state snapshot file. Hash algorithms applicable to VNF snapshot package artifacts + are defined in ETSI GS NFV-SOL 010. + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the VNF state snapshot content is encrypted (true) or not (false). + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + metadata: + description: > + The metadata with additional information such as content type, size, creation date, etc. + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfSnapshot: + description: > + This type represents a VNF snapshot. + It shall comply with the provisions defined in table 5.5.2.23-1. + type: object + required: + - id + - vnfInstanceId + - triggeredAt + - vnfdId + - vnfInfo + - vnfcSnapshots + properties: + id: + description: > + Identifier of the VNF Snapshot. This identifier is allocated by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstanceId: + description: > + Identifier of the snapshotted VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + creationStartedAt: + description: > + Timestamp indicating when the VNF snapshot creation has been started by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + creationFinishedAt: + description: > + Timestamp indicating when the VNF snapshot has been completed by the VNFM. + Shall be present once the VNF snapshot creation has been completed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfdId: + description: > + Identifier of the VNFD in use at the time the snapshot of the VNF instance has been created. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfInstance: + description: > + VNF Instance information of the snapshotted VNF instance. This is a copy of the "ndividual VNF instance" resource. + $ref: '#/definitions/VnfInstance' + vnfcSnapshots: + description: > + Information about VNFC snapshots constituting this VNF snapshot. + type: array + items: + $ref: '#/definitions/VnfcSnapshotInfo' + vnfStateSnapshotInfo: + description: > + Information about VNF-specific state snapshot data. + This attribute shall not be present before the VNF snapshot has been completed. + Otherwise, this attribute shall be present if the VNF snapshot has associated + additional VNF-specific state data. + $ref: '#/definitions/VnfStateSnapshotInfo' + userDefinedData: + description: > + User defined data for the VNF snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" _links: description: > @@ -249,467 +1302,903 @@ definitions: - self properties: self: - description: URI of this resource. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - indicators: - description: Indicators related to this VNF instance, if applicable. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - instantiate: - description: > - Link to the "Instantiate VNF task" resource, if the related operation - is possible based on the current status of this VNF instance - resource (i.e. VNF instance in NOT_INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - terminate: - description: > - Link to the "Terminate VNF task" resource, if the related operation - is possible based on the current status of this VNF instance - resource (i.e. VNF instance is in INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - scale: - description: > - Link to the "Scale VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource (i.e. VNF instance - is in INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - scaleToLevel: - description: > - Link to the "Scale VNF to level task" resource, if the related - operation is supported for this VNF instance, and is possible - based on the current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - changeFlavour: - description: > - Link to the "Change VNF flavour task" resource, if the related - operation is supported for this VNF instance, and is possible - based on the current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - heal: - description: > - Link to the "Heal VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - operate: description: > - Link to the "Operate VNF task" resource, if the related operation is - supported for this VNF instance, and is possible based on the - current status of this VNF instance resource - (i.e. VNF instance is in INSTANTIATED state). + URI of this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - changeExtConn: + vnfStateSnapshot: description: > - Link to the "Change external VNF connectivity task" resource, if the related - operation is possible based on the current status of this VNF - instance resource (i.e. VNF instance is in INSTANTIATED state). + Link to the "VNF state snapshot" resource. This attribute shall not be + present before the VNF snapshot has been completed. Otherwise, this + attribute shall be present if the VNF snapshot has associated additional + VNFspecific state data. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - InstantiateVnfRequest: - #SOL003 location: 5.5.2.4 + VnfcSnapshotInfo: + description: > + This type represents a VNFC snapshot. type: object required: - - flavourId + - id + - vnfcInstanceId + - triggeredAt + - vnfcResourceId properties: - flavourId: - description: > - Identifier of the VNF deployment flavour to be instantiated. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - instantiationLevelId: + id: description: > - Identifier of the instantiation level of the deployment flavour to be - instantiated. If not present, the default instantiation level as - declared in the VNFD is instantiated. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - extVirtualLinks: + Identifier of the information held by the VNFM about a specific VNFC snapshot. This identifier is allocated by + the VNFM and is unique within the scope of a VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + vnfcInstanceId: description: > - Information about external VLs to connect the VNF to. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" - extManagedVirtualLinks: + Identifier of the snapshotted VNFC instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + creationStartedAt: description: > - Information about internal VLs that are managed by the NFVO. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" - vimConnectionInfo: + Timestamp indicating when the VNF snapshot creation has been started by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + creationFinishedAt: description: > - Information about VIM connections to be used for managing the - resources for the VNF instance, or refer to - external / externally-managed virtual links. This attribute shall - only be supported and may be present if VNF-related resource - management in direct mode is applicable. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - localizationLanguage: + Timestamp indicating when the VNFC snapshot has been completed. Shall be present once the VNFC snapshot + creation has been completed by the VNFM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfcResourceInfoId: description: > - Localization language of the VNF to be instantiated. The value shall - comply with the format defined in IETF RFC 5646. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - additionalParams: + Reference to the "VnfcResourceInfo" structure in the "VnfInstance" structure that represents the resource + of the snapshotted VNFC instance. A snapshot of that structure is available in the "vnfInstance" attribute + of the "VnfSnapshot" structure. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + computeSnapshotResource: description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "InstantiateVnfOpConfig". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: + Reference to a compute snapshot resource. + The identifier of the compute snapshot resource is assigned during creation of a VNFC snapshot + being returned from the VIM as output data in the response message of the individual resource operations. + This attribute shall only be present for a VNFC snapshot that has been newly created by the VNFM as a result o + f the "Create VNF snapshot task". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + storageSnapshotResources: description: > - If present, this attribute provides values for the "extensions" attribute - in "VnfInstance", as defined in clause 5.5.2.2. If an entry with the same - key exists in the VnfInstance data structure, the VNFM shall replace its - value with the value passed in the InstantiateVnfRequest data structure. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vnfConfigurableProperties: + Mapping of the storage resources associated to the VNFC with the storage snapshot resources. + type: array + items: + type: object + required: + - storageResourceId + properties: + storageResourceId: + description: > + Reference to the "VirtualStorageResourceInfo" structure in the "VnfInstance" structure + that represents the virtual storage resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + storageSnapshotResource: + description: > + Reference to a storage snapshot resource. + The identifier of the storage snapshot resource is assigned during creation of a VNFC + snapshot being returned from the VIM as output data in the response message of the + individual resource operations. This attribute shall only be present for a VNFC snapshot + with an associated storage resource and that has been newly created by the VNFM as a + result of the "Create VNF snapshot task". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + userDefinedData: description: > - This parameter provides values for the VNF configurable properties - attribute in the "VnfInstance", as defined in clause 5.5.2.2. - If an entry with the same key exists in the VnfInstance data structure, - the VNFM shall replace its value with the value passed in the - InstantiateVnfRequest data structure. + User defined data for the VNFC snapshot. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - ChangeVnfFlavourRequest: - #SOL003 location: 5.5.2.7 + VnfVirtualLinkResourceInfo: description: > - This type represents request parameters for the "Change VNF flavour" operation. + This type represents the information that allows addressing a virtualised + resource that is used by an internal VL instance in a VNF instance. type: object required: - - newFlavourId + - id + - vnfVirtualLinkDescId + - networkResource properties: - newFlavourId: + id: description: > - Identifier of the VNF deployment flavour to be instantiated. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - instantiationLevelId: + Identifier of this VnfVirtualLinkResourceInfo instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfVirtualLinkDescId: description: > - Identifier of the instantiation level of the deployment flavour to - be instantiated. If not present, the default instantiation level as - declared in the VNFD is instantiated. + Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - extVirtualLinks: + vnfdId: description: > - Information about external VLs to connect the VNF to. - Entries in the list of external VLs that are unchanged need not be supplied as part of this request. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" - extManagedVirtualLinks: + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + networkResource: description: > - Information about internal VLs that are managed by the NFVO. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" - vimConnectionInfo: + Reference to the VirtualNetwork resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + zoneId: description: > - Information about VIM connections to be used for managing the - resources for the VNF instance, or refer to - external / externally-managed virtual links. This attribute shall - only be supported and may be present if VNF-related resource - management in direct mode is applicable. + The identifier of the resource zone, as managed by the resource + management layer (typically, the VIM), where the referenced + VirtualNetwork resource is placed. Shall be provided if this + information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + reservationId: + description: > + The reservation identifier applicable to the resource. It shall be + present when an applicable reservation exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfLinkPorts: + description: > + Links ports of this VL. + Shall be present when the linkPort is used for external connectivity + by the VNF (refer to VnfLinkPortInfo). + May be present otherwise. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - additionalParams: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLinkPortInfo" + metadata: description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "InstantiateVnfOpConfig". + Metadata about this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - TerminateVnfRequest: + AffectedVnfc: + description: > + This type provides information about added, deleted, modified and + temporary VNFCs. type: object required: - - terminationType + - id + - vduId + - changeType + - computeResource properties: - terminationType: + id: description: > - Indicates whether forceful or graceful termination is requested. - Permitted values: - * FORCEFUL: The VNFM will shut down the VNF and release the - resources immediately after accepting the request. - * GRACEFUL: The VNFM will first arrange to take the VNF out of - service after accepting the request. Once the operation of taking - the VNF out of service finishes (irrespective of whether it has - succeeded or failed) or once the timer value specified in the - "gracefulTerminationTimeout" attribute expires, the VNFM will shut - down the VNF and release the resources. + Identifier of the Vnfc instance, identifying the applicable + "vnfcResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vduId: + description: > + Identifier of the related VDU in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected VNFC instance is + associated to a VDU which is referred from the source or destination VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: + description: > + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + For a temporary resource, an AffectedVnfc structure exists as long + as the temporary resource exists. type: string enum: - - FORCEFUL - - GRACEFUL - gracefulTerminationTimeout: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + computeResource: description: > - This attribute is only applicable in case of graceful termination. - It defines the time to wait for the VNF to be taken out of service - before shutting down the VNF and releasing the resources. - The unit is seconds. - If not given and the "terminationType" attribute is set to - "GRACEFUL", it is expected that the VNFM waits for the successful - taking out of service of the VNF, no matter how long it takes, - before shutting down the VNF and releasing the resources. - type: integer - additionalParams: + Reference to the VirtualCompute resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + resourceDefinitionId: description: > - Additional parameters passed by the NFVO as input to the termination - process, specific to the VNF being terminated, as declared in the - VNFD as part of "TerminateVnfOpConfig". + The identifier of the "ResourceDefinition" in the granting exchange + related to the LCM operation occurrence. It shall be present when + an applicable GrantInfo for thegranted resource exists. See note. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + zoneId: + description: > + The identifier of the resource zone, as managed by the resource management + layer (typically, the VIM), where the referenced VirtualCompute resource is placed. + Shall be provided if this information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + metadata: + description: > + Metadata about this resource. + The content of this attribute shall be a copy of the content of the + "metadata" attribute of the VnfcResourceInfo structure. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + affectedVnfcCpIds: + description: > + Identifiers of CP(s) of the VNFC instance that were affected by the + change. + Shall be present for those affected CPs of the VNFC instance that + are associated to an external CP of the VNF instance. + May be present for further affected CPs of the VNFC instance. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + addedStorageResourceIds: + description: > + References to VirtualStorage resources that have been added. Each + value refers to a VirtualStorageResourceInfo item in the + VnfInstance that was added to the VNFC. It shall be provided if at + least one storage resource was added to the VNFC. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + removedStorageResourceIds: + description: > + References to VirtualStorage resources that have been removed. + The value contains the identifier of a VirtualStorageResourceInfo + item that has been removed from the VNFC, and might no longer exist + in the VnfInstance. + It shall be provided if at least one storage resource was removed + from the VNFC. + type: array + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - HealVnfRequest: + VnfLcmOpOcc: + description: > + This type represents a VNF lifecycle management operation occurrence. Shall be set to the value of the "id" + attribute in the "Grant" representing the associated "Individual Grant", if such grant exists. type: object + oneOf: + - required: + - changedInfo + - required: + - modificationsTriggeredByVnfPkgChange + required: + - id + - operationState + - stateEnteredTime + - startTime + - vnfInstanceId + - operation + - isAutomaticInvocation + - isCancelPending properties: - cause: + id: + description: > + Identifier of this VNF lifecycle management operation occurrence. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + operationState: + description: > + The state of the LCM operation. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" + stateEnteredTime: + description: > + Date-time when the current state has been entered. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + startTime: + description: > + Date-time of the start of the operation. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfInstanceId: + description: > + Identifier of the VNF instance to which the operation applies + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + grantId: + description: > + Identifier of the grant related to this VNF LCM operation + occurrence. Shall be set to the value of the "id" attribute + in the "Grant" representing the associated "Individual Grant", + if such grant exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + operation: + description: > + Type of the actual LCM operation represented by this VNF LCM + operation occurrence. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType" + isAutomaticInvocation: + description: > + Set to true if this VNF LCM operation occurrence has been triggered + by an automated procedure inside the VNFM (i.e. + ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf + triggered by auto-heal). Set to false otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + operationParams: + description: > + Input parameters of the LCM operation. This attribute shall be + formatted according to the request data type of the related LCM + operation. The following mapping between operationType and the + data type of this attribute shall apply: + * INSTANTIATE: InstantiateVnfRequest + * SCALE: ScaleVnfRequest + * SCALE_TO_LEVEL: ScaleVnfToLevelRequest + * CHANGE_FLAVOUR: ChangeVnfFlavourRequest + * OPERATE: OperateVnfRequest + * HEAL: HealVnfRequest + * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest + * TERMINATE: TerminateVnfRequest + * MODIFY_INFO: VnfInfoModifications + * CREATE_SNAPSHOT: CreateVnfSnapshotRequest + * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest + * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest + type: object + isCancelPending: + description: > + If the VNF LCM operation occurrence is in "STARTING", "PROCESSING" + or "ROLLING_BACK" state and the operation is being cancelled, this + attribute shall be set to true. Otherwise, it shall be set to false. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + cancelMode: + description: > + The mode of an ongoing cancellation. Shall be present when + isCancelPending=true, and shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeType" + error: + description: > + If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" + is "PROCESSING" or "ROLLING_BACK" and previous value of + "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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + resourceChanges: + description: > + This attribute contains information about the cumulative changes to + virtualised resources that were performed so far by the LCM + operation since its start, if applicable. + type: object + properties: + affectedVnfcs: + description: > + Information about VNFC instances that were affected during the + lifecycle operation. + This allows the API consumer to obtain the information contained in + the latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedVnfc" + affectedVirtualLinks: + description: > + Information about VL instances that were affected during the + lifecycle operation. + This allows the API consumer to obtain the information contained in + the latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + For a particular affected VL, there shall be as many "AffectedVirtualLink" + entries as needed for signalling the different types of changes, i.e., + one per virtual link and change type. For instance, in the case of + signaling affected VL instances involving the addition of a particular VL + instance with links ports, one "AffectedVirtualLink" entry signals the + addition of the VL by using the "changeType" attribute of "AffectedVirtualLink" + structure equal to "ADDED", and another "AffectedVirtualLink" entry signals + the addition of VNF link ports of the VL by using the "changeType" equal to + "LINK_PORT_ADDED". + type: array + items: + $ref: "#/definitions/AffectedVirtualLink" + affectedExtLinkPorts: + description: > + Information about external VNF link ports that were affected during the lifecycle operation. This allows + the API consumer to obtain the information contained in the latest "result" notification if it has not + received it due to an error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedExtLinkPort" + affectedVirtualStorages: + description: > + Information about virtualised storage instances that were affected + during the lifecycle operation. + This allows the API consumer to obtain the information contained + in the latest "result" notification if it has not received it due to + an error or a wrongly configured subscription filter. + type: array + items: + $ref: "#/definitions/AffectedVirtualStorage" + changedInfo: + description: > + Information about the changed VNF instance information, including + VNF configurable properties, if applicable. + This allows the NFVO to obtain the information contained in the + latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + $ref: "#/definitions/VnfInfoModifications" + changedExtConnectivity: + description: > + Information about changed external connectivity, if applicable. + This allows the NFVO to obtain the information contained in the + latest "result" notification if it has not received it due to an + error or a wrongly configured subscription filter. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" + modificationsTriggeredByVnfPkgChange: + description: > + Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package, + if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG". + This allows the API consumer to obtain the information contained in the latest "result" notification if it has + not received it due to an error or a wrongly configured subscription filter. + Not more than one of changedInfo and modificationsTriggeredByVnfPkgChange shall be present. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" + vnfSnapshotInfoId: description: > - Indicates the reason why a healing procedure is required. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - additionalParams: + Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation, + i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + _links: 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". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + Links to resources related to this resource. + type: object + required: + - self + - vnfInstance + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + vnfInstance: + description: > + Link to the VNF instance that the operation applies to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + grant: + description: > + Link to the grant for this operation, if one exists. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + cancel: + description: > + Link to the task resource that represents the "cancel" operation + for this VNF LCM operation occurrence, if cancelling is + currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + retry: + description: > + Link to the task resource that represents the "retry" operation + for this VNF LCM operation occurrence, if retrying is currently + allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + rollback: + description: > + Link to the task resource that represents the "rollback" + operation for this VNF LCM operation occurrence, if rolling back + is currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + fail: + description: > + Link to the task resource that represents the "fail" operation + for this VNF LCM operation occurrence, if declaring as failed is + currently allowed. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + vnfSnapshot: + description: > + Link to the VNF snapshot resource, if the VNF LCM operation occurrence is related to a VNF snapshot. + Shall be present if operation="CREATE_SNAPSHOT" or operation="REVERT_TO_SNAPSHOT". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" - OperateVnfRequest: + AffectedExtLinkPort: description: > - This type represents request parameters for the "Operate VNF" operation. + This type provides information about added and deleted external link ports (link ports attached to external virtual links). type: object required: - - changeStateTo + - id + - changeType + - extCpInstanceId + - resourceHandle properties: - changeStateTo: + id: description: > - The desired operational state (i.e. started or stopped) to change - the VNF to. - $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfOperationalStateType" - stopType: + Identifier of the link port, identifying the applicable "extLinkPorts" entry in the "ExtVirtualLinkInfo" data + type (see clause 5.5.3.2). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: description: > - It signals whether forceful or graceful stop is requested. - The “stopType” and “gracefulStopTimeout” attributes shall be absent, - when the “changeStateTo” attribute is equal to “STARTED”. The - “gracefulStopTimeout” attribute shall be present, when the - “changeStateTo” is equal to “STOPPED” and the “stopType” attribute - is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be - absent, when the “changeStateTo” attribute is equal to “STOPPED” and - the “stopType” attribute is equal to “FORCEFUL”. The request shall - be treated as if the “stopType” attribute was set to ”FORCEFUL”, when - the “changeStateTo” attribute is equal to “STOPPED” and the - “stopType” attribute is absent. - $ref: "#/definitions/StopType" - gracefulStopTimeout: + Signals the type of change. + Permitted values: + - ADDED + - REMOVED + type: string + enum: + - ADDED + - REMOVED + extCpInstanceId: description: > - The time interval (in seconds) to wait for the VNF to be taken out - of service during graceful stop, before stopping the VNF. - The “stopType” and “gracefulStopTimeout” attributes shall be absent, - when the “changeStateTo” attribute is equal to “STARTED”. The - “gracefulStopTimeout” attribute shall be present, when the - “changeStateTo” is equal to “STOPPED” and the “stopType” attribute - is equal to “GRACEFUL”. The “gracefulStopTimeout” attribute shall be - absent, when the “changeStateTo” attribute is equal to “STOPPED” and - the “stopType” attribute is equal to “FORCEFUL”. The request shall - be treated as if the “stopType” attribute was set to ”FORCEFUL”, when - the “changeStateTo” attribute is equal to “STOPPED” and the - “stopType” attribute is absent. - type: integer - additionalParams: + Identifier of the related external CP instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + resourceHandle: description: > - Additional parameters passed by the NFVO as input to the process, - specific to the VNF of which the operation status is changed, as - declared in the VNFD as part of "OperateVnfOpConfig". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + Reference to the link port resource. + Detailed information is (for added resources) or has been (for removed resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + resourceDefinitionId: + description: > + The identifier of the "ResourceDefinition" in the granting exchange related to the LCM operation occurrence. + It shall be present when an applicable GrantInfo for the granted resource exists. + The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist in + correlating the resource changes performed during the LCM operation with the granted resources in a + specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle + management operation occurrence" and the "id" in the "Individual Grant". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" - ChangeExtVnfConnectivityRequest: - #SOL003 location: 5.5.2.11 + VnfLcmOperationOccurrenceNotification: description: > - This type represents request parameters for the - "Change external VNF connectivity" operation to modify the external - connectivity of a VNF instance. + This type represents a VNF lifecycle management operation occurrence + notification, which informs the receiver of changes in the VNF + lifecycle caused by a VNF LCM operation occurrence. The support of the + notification is mandatory. + This notification shall be triggered by the VNFM when there is a change in the state of a + VNF LCM operation occurrence that changes the VNF lifecycle, includingwhich represents an + occurrence of one the following LCM operations: + * Instantiation of the VNF + * Scaling of the VNF instance (including auto-scaling) + * Healing of the VNF instance (including auto-healing) + * Change of the state of the VNF instance (i.e. Operate VNF) + * Change of the deployment flavour of the VNF instance + * Change of the external connectivity of the VNF instance + * Termination of the VNF instance + * Modification of VNF instance information and/or VNF configurable + properties through the "PATCH" method on the "Individual VNF instance" + resource + * Creation of a VNF snapshot + * Reversion of the VNF instance to a VNF snapshot. + Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence, + and also specifies details of the notifications to be emitted at each state transition. + If this is the initial notification about the start of a VNF LCM operation occurrence, + it is assumed that the notification is sent by the VNFM before any action (including sending the grant request) + is taken as part of the LCM operation. Due to possible race conditions, the "start" notification, + the grant request and the LCM operation acknowledgment (i.e. the "202 Accepted" response) + can arrive in any order at the NFVO, and the NFVO shall be able to handle such a situation. + If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence, + the notification shall be sent after all related actions of the LCM operation that led + to this state have been executed. + The new state shall be set in the "Individual VNF LCM operation occurrence" resource before + the notification about the state change is sent. + See clause 5.6.2.2 for further provisions regarding sending this notification, including + in cases of handling LCM operation errors. type: object required: - - extVirtualLinks + - id + - notificationType + - subscriptionId + - timeStamp + - notificationStatus + - operationState + - vnfInstanceId + - operation + - isAutomaticInvocation + - vnfLcmOpOccId + - _links properties: - extVirtualLinks: + id: description: > - Information about external VLs to change (e.g. connect the VNF to). - Entries in the list of external VLs that are unchanged need not be supplied as part of this request. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" - vimConnectionInfo: + Identifier of this notification. If a notification is sent multiple + times due to multiple subscriptions, the "id" attribute of all these + notifications shall have the same value. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + notificationType: description: > - Information about VIM connections to be used for managing the - resources for the VNF instance, or refer to external virtual - links. This attribute shall only be supported and may be present - if VNF-related resource management in direct mode is applicable. - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - additionalParams: + Discriminator for the different notification types. Shall be set to + "VnfLcmOperationOccurrenceNotification" for this notification type. + type: string + enum: + - VnfLcmOperationOccurrenceNotification + subscriptionId: description: > - Additional input parameters for the instantiation process, specific - to the VNF being instantiated, as declared in the VNFD as part of - "ChangeExtVnfConnectivityOpConfig".". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - VnfInfoModificationRequest: - description: > - This type represents attribute modifications for an - "Individual VNF instance" resource, i.e. modifications to a resource - representation based on the "VnfInstance" data type. - type: object - properties: - vnfInstanceName: + Identifier of the subscription that this notification relates to.Shall be set to the value of the "id" attribute + of the "LccnSubscription" representing the associated "Individual subscription" resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + timeStamp: description: > - New value of the "vnfInstanceName" attribute in "VnfInstance", or - "null" to remove the attribute. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfInstanceDescription: + Date-time of the generation of the notification. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + notificationStatus: description: > - New value of the "vnfInstanceDescription" attribute in - "VnfInstance", or "null" to remove the attribute. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfPkgId: + Indicates whether this notification reports about the start of a + lifecycle operation or the result of a lifecycle operation. + Permitted values: + * START: Informs about the start of the VNF LCM operation + occurrence. + * RESULT: Informs about the final or intermediate result of the VNF + LCM operation occurrence. + type: string + enum: + - START + - RESULT + operationState: description: > - New value of the "vnfPkgId" attribute in "VnfInstance". - The value "null" is not permitted. + The state of the VNF LCM operation occurrence. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" + vnfInstanceId: + description: > + The identifier of the VNF instance affected. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - vnfConfigurableProperties: + operation: description: > - Modifications of the "vnfConfigurableProperties" attribute in - "VnfInstance". If present, these modifications shall be applied - according to the rules of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - metadata: + The lifecycle management operation. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/LcmOperationType" + isAutomaticInvocation: description: > - Modifications of the "metadata" attribute in "VnfInstance". If - present, these modifications shall be applied according to the rules - of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: + Set to true if this VNF LCM operation occurrence has been triggered + by an automated procedure inside the VNFM + (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf + triggered by auto-heal). + Set to false otherwise. + type: boolean + verbosity: description: > - Modifications of the "extensions" attribute in "VnfInstance". If - present, these modifications shall be applied according to the rules - of JSON Merge PATCH (see IETF RFC 7396). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vimConnectionInfo: + This attribute signals the verbosity of the notification. If it is not present, it shall default to the value "FULL". + If the value is "SHORT", full change details can be obtained by performing a GET request on the "Individual LCM + operation occurrence" resource that is signalled by the "vnfLcmOpOcc" child attribute of the "_links" attribute. + $ref: '../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOpOccNotificationVerbosityType' + vnfLcmOpOccId: + description: > + The identifier of the VNF lifecycle management operation occurrence associated to the notification. Shall be + set to the value of the "id" attribute of the "VnfLcmOpOcc" representing the associate "Individual VNF lifecycle + management operation occurrence" resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + affectedVnfcs: description: > - New content of certain entries in the "vimConnectionInfo" attribute - array in "VnfInstance", as defined below this table. + Information about VNFC instances that were affected during the + lifecycle operation. + Shall be present if the "notificationStatus" is set to "RESULT", + the "verbosity" attribute is set to "FULL" and the operation has + performed any resource modification. Shall be absent otherwise. + This attribute contains information about the cumulative changes + to virtualised resources that were performed so far by the VNF LCM + operation occurrence and by any of the error handling procedures + for that operation occurrence. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - vimConnectionInfoDeleteIds: + $ref: "#/definitions/AffectedVnfc" + affectedVirtualLinks: description: > - List of identifiers entries to be deleted from the "vimConnectionInfo" - attribute array in "VnfInstance", to be used as "deleteIdList" as defined - below this table. + Information about VL instances that were affected during the + lifecycle operation. + Shall be present if the "notificationStatus" is set to "RESULT" and + the operation has performed any resource modification. Shall be + absent otherwise. This attribute contains information about the + cumulative changes to virtualised resources that were performed so + far by the VNF LCM operation occurrence and by any of the error + handling procedures for that operation occurrence. + For a particular affected VL, there shall be as many "AffectedVirtualLink" + entries as needed for signalling the different types of changes, i.e., + one per virtual link and change type. For instance, in the case of signaling + affected VL instances involving the addition of a particular VL instance with + links ports, one "AffectedVirtualLink" entry signals the addition of the VL by + using the "changeType" attribute of "AffectedVirtualLink" structure equal to + "ADDED", and another "AffectedVirtualLink" entry signals the addition of VNF + link ports of the VL by using the "changeType" equal to "LINK_PORT_ADDED". type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + $ref: "#/definitions/AffectedVirtualLink" + affectedExtLinkPorts: + description: > + Information about external VNF link ports that were affected during + the lifecycle operation. + Shall be present if the "notificationStatus" is set to "RESULT", + the "verbosity" attribute is set to "FULL" and the operation has + performed any resource modification. Shall be absent otherwise. + This attribute contains information about the cumulative changes + to virtualised resources that were performed so far by the VNF LCM + operation occurrence and by any of the error handling procedures + for that operation occurrence. + type: array + items: + $ref: "#/definitions/AffectedExtLinkPort" + affectedVirtualStorages: + description: > + Information about virtualised storage instances that were affected + during the lifecycle operation. + Shall be present if the "notificationStatus" is set to "RESULT" and + the operation has performed any resource modification. Shall be + absent otherwise. This attribute contains information about the + cumulative changes to virtualised resources that were performed so + far by the VNF LCM operation occurrence and by any of the error + handling procedures for that operation occurrence. + type: array + items: + $ref: "#/definitions/AffectedVirtualStorage" + changedInfo: + description: > + Information about the changed VNF instance information, including + changed VNF configurable properties. + Shall be present if the "notificationStatus" is set to "RESULT", + the "operation" attribute is not equal to "CHANGE_VNFPKG", the + "verbosity" attribute is set to "FULL" and the operation has performed + any changes to VNF instance information, including VNF configurable + properties. Shall be absent otherwise. + $ref: "#/definitions/VnfInfoModifications" + changedExtConnectivity: + description: > + Information about changed external connectivity, if this notification + represents the result of a lifecycle operation occurrence. + Shall be present if the "notificationStatus" is set to "RESULT", + the "verbosity" attribute is set to "FULL" and the operation has made + any changes to the external connectivity of the VNF instance. Shall be + absent otherwise. Only information about external VL instances that + have been added or modified shall be provided. + type: array + items: + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtVirtualLinkInfo" + modificationsTriggeredByVnfPkgChange: + description: > + Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package. + Shall be present if the "notificationStatus" is set to "RESULT", the "operation" attribute is equal to + "CHANGE_VNFPKG", the "verbosity" attribute is set to "FULL" and the operation has performed any changes to VNF + instance information, including VNF configurable properties. Shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ModificationsTriggeredByVnfPkgChange" + error: + description: > + Details of the latest error, if one has occurred during executing + the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013). + Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED" + or "ROLLED_BACK" and shall be absent otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + _links: + description: > + Links to resources related to this notification. + The link URIs in this structure shall be set to point to the + resources identified by the corresponding identifier attributes + in this notification. + $ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnLinks" - VnfInfoModifications: + AffectedVirtualLink: description: > - This type represents attribute modifications that were performed on an - "Individual VNF instance" resource. The attributes that can be included - consist of those requested to be modified explicitly in the - "VnfInfoModificationRequest" data structure, and additional attributes - of the "VnfInstance" data structure that were modified implicitly e.g. - when modifying the referenced VNF package. + This type provides information about added, deleted, modified and + temporary VLs, and added or removed VNF link ports. type: object + required: + - id + - vnfVirtualLinkDescId + - changeType + - networkResource properties: - vnfInstanceName: + id: description: > - If present, this attribute signals modifications of the - "vnfInstanceName" attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfInstanceDescription: + Identifier of the virtual link instance, identifying the applicable + "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfVirtualLinkDescId: description: > - If present, this attribute signals modifications of the - "vnfInstanceDescription" attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfConfigurableProperties: + Identifier of the related VLD in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: description: > - If present, this attribute signals modifications of the - "vnfConfigurableProperties" attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - metadata: + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected VL instance is + associated to a VLD which is referred from the source or destination VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + changeType: description: > - If present, this attribute signals modifications of the "metadata" - attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + * LINK_PORT_ADDED + * LINK_PORT_REMOVED + For a temporary resource, an AffectedVirtualLink structure exists as + long as the temporary resource exists. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the + "vnfLinkPortIds" attribute. + type: string + enum: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + - LINK_PORT_ADDED + - LINK_PORT_REMOVED + networkResource: description: > - If present, this attribute signals modifications of the "extensions" - attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vimConnectionInfo: + Reference to the VirtualNetwork resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in + the "vnfLinkPortIds" attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + vnfLinkPortIds: description: > - If present, this attribute signals modifications of certain entries - in the "vimConnectionInfo" attribute array in "VnfInstance". + Identifiers of the link ports of the affected VL (reference to the vnfLinkPortInfo) related to the change. + Each identifier references a "VnfLinkPortInfo" structure. + Shall be set when changeType is equal to "LINK_PORT_ADDED" or "LINK_PORT_REMOVED", and the related + “VnfLinkPortInfo” structures are present (case "added") or have been present (case "removed") in the + “VnfVirtualLinkResourceInfo” or "ExtManagedVirtualLinkInfo" structures that are represented by the + "vnfVirtualLinkResourceInfo" or "extManagedVirtualLinkInfo" attribute in the "VnfInstance" structure. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the + "vnfLinkPortIds" attribute. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" - vimConnectionInfoDeleteIds: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + resourceDefinitionId: description: > - If present, this attribute signals the deletion of certain entries - in the "vimConnectionInfo" attribute array in "VnfInstance". - type: array - items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + The identifier of the "ResourceDefinition" in the granting exchange + related to the LCM operation occurrence. It shall be present when an + applicable GrantInfo for the granted resource exists. + When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports, the + "networkResource" attribute refers to the affected virtual link instance, not the link port instance. + The resource handles of the affected VNF link ports can be found by dereferencing the identifiers in the + "vnfLinkPortIds" attribute. + The "resourceDefinitionId" attribute provides information to the API consumer (i.e. the NFVO) to assist + in correlating the resource changes performed during the LCM operation with the granted resources in a + specific Grant exchange, which is identified by the "grantId" available in the "Individual VNF lifecycle + management operation occurrence" and the "id" in the "Individual Grant". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + zoneId: + description: > + The identifier of the resource zone, as managed by the resource + management layer (typically, the VIM), where the referenced VirtualNetwork + resource is placed. Shall be provided if this information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + 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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + AffectedVirtualStorage: + description: > + This type provides information about added, deleted, modified and + temporary virtual storage resources. + type: object + required: + - id + - virtualStorageDescId + - changeType + - storageResource + properties: + id: + description: > + Identifier of the storage instance, identifying the applicable + "virtualStorageResourceInfo" entry in the "VnfInstance" data type. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + virtualStorageDescId: + description: > + Identifier of the related VirtualStorage descriptor in the VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" vnfdId: description: > - If present, this attribute signals modifications of the "vnfdId" - attribute in "VnfInstance". + Identifier of the VNFD. + Shall be present in case of a "change current VNF Package" to identify whether the affected virtual storage + instance is associated to a VirtualStorage descriptor which is referred from the source or destination VNFD. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - vnfProvider: + changeType: description: > - If present, this attribute signals modifications of the - "vnfProvider" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfPkgId" attribute) was modified implicitly following a request to - modify the "vnfPkgId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfPkgId” attribute. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfProductName: + Signals the type of change. Permitted values: + * ADDED + * REMOVED + * MODIFIED + * TEMPORARY + For a temporary resource, an AffectedVirtualStorage structure exists + as long as the temporary resource exists. + type: string + enum: + - ADDED + - REMOVED + - MODIFIED + - TEMPORARY + storageResource: description: > - If present, this attribute signals modifications of the - "vnfProductName" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfPkgId" attribute) was modified implicitly following a request to - modify the "vnfPkgId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfPkgId” attribute. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - vnfSoftwareVersion: + Reference to the VirtualStorage resource. Detailed information is + (for new and modified resources) or has been (for removed + resources) available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + resourceDefinitionId: description: > - If present, this attribute signals modifications of the - "vnfSoftwareVersion" attribute in "VnfInstance". - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" - vnfdVersion: + The identifier of the "ResourceDefinition" in the granting exchange + related to the LCM operation occurrence. It shall be present when an + applicable GrantInfo for the granted resource exists. + The "resourceDefinitionId" attribute provides information to the API + consumer (i.e. the NFVO) to assist in correlating the resource changes + performed during the LCM operation with the granted resources in a + specific Grant exchange, which is identified by the "grantId" available + in the "Individual VNF lifecycle management operation occurrence" and + the "id" in the "Individual Grant". + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + zoneId: description: > - If present, this attribute signals modifications of the - "vnfdVersion" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfPkgId" attribute) was modified implicitly following a request to - modify the "vnfPkgId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfPkgId” attribute. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version" - - StopType: - description: > - * FORCEFUL: The VNFM will stop the VNF immediately after accepting the - request. - * GRACEFUL: The VNFM will first arrange to take the VNF out of service - after accepting the request. Once that operation is successful or once - the timer value specified in the "gracefulStopTimeout" attribute - expires, the VNFM will stop the VNF. - type: string - enum: - - FORCEFUL - - GRACEFUL \ No newline at end of file + The identifier of the resource zone, as managed by the resource + management layer (typically, the VIM), where the referenced VirtualNetwork + resource is placed. Shall be provided if this information is available from the VIM. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + 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: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" \ No newline at end of file diff --git a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index d26037d1124ddc60e4a65ef162f754f2c181997d..491065a100f788d458dfc3a4cdb4ff5fb9ed7fe1 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -1,435 +1,361 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Lifecycle Management Notification interface - description: > + description: | SOL003 - VNF Lifecycle Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/callback/v1" + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/callback/v1 + - url: https://127.0.0.1/callback/v1 paths: ############################################################################### # Notification endpoint VnfLcmOperationOccurrenceNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: VnfLcmOperationOccurrenceNotification - description: A notification about lifecycle changes triggered by a VNF LCM operation occurrence.. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification" - - 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 + requestBody: + $ref: '#/components/requestBodies/VnfLcmOperationOccurrenceNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/VnfLcmOperationOccurrenceNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, - e.g. during subscription. + description: | + The GET method allows the API producer to test the notification endpoint that is provided by the + API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VnfLcmOperationOccurrenceNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint VnfIdentifierCreationNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: VnfIdentifierCreationNotification - description: > - A notification about the creation of a VNF identifier and the related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification" - - 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 + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierCreationNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/VnfIdentifierCreationNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > + description: | The GET method allows the server to test the notification endpoint that is provided by the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VnfIdentifierCreationNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint VnfIdentifierDeletionNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. This method shall follow the provisions specified in the tables 5.4.20.3.1-1 and 5.4.20.3.1-2 for URI query parameters, request and response data structures, and response codes. - parameters: - - name: VnfIdentifierDeletionNotification - description: > - A notification about the deletion of a VNF identifier and the related "Individual VNF instance" resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification" - - 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 + requestBody: + $ref: '#/components/requestBodies/VnfIdentifierDeletionNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/VnfIdentifierDeletionNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > + description: | The GET method allows the server to test the notification endpoint that is provided by the API consumer, e.g. during subscription. This method shall follow the provisions specified in the tables 5.4.20.3.2-1 and 5.4.20.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VnfIdentifierDeletionNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + + +components: + requestBodies: + VnfLcmOperationOccurrenceNotification: + description: | + A notification about lifecycle changes triggered by a VNF LCM operation occurrence.. + content: + application/json: + schema: + $ref: "../VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification" + required: true + + VnfIdentifierCreationNotification: + description: | + A notification about the creation of a VNF identifier and the related "Individual VNF instance" resource. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification" + required: true + + VnfIdentifierDeletionNotification: + description: | + A notification about the deletion of a VNF identifier and the related "Individual VNF instance" resource. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification" + required: true + + responses: + VnfLcmOperationOccurrenceNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfLcmOperationOccurrenceNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfIdentifierCreationNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfIdentifierCreationNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfIdentifierDeletionNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfIdentifierDeletionNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml index 9b96ab2028002103f4e1677d7abed450019fbcef..f40cf9455279baa6c27b3da151c76446937f4ddd 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml @@ -1,57 +1,44 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Lifecycle Operation Granting interface - description: > + description: | SOL003 - VNF Lifecycle Operation Granting interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "1.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/grant/v1" - -schemes: - - https + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/grant/v1 + - url: https://127.0.0.1/grant/v1 paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': + /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Resource: Grants # ############################################################################### - '/grants': + /grants: #SOL003 location: 9.4.2 post: - description: > + description: | Grant Lifecycle Operation. The POST method requests a grant for a particular VNF lifecycle operation. This method shall follow the provisions specified in the tables 9.4.2.3.1-1 and 9.4.2.3.1-2 @@ -62,234 +49,228 @@ paths: case which is indicated by responding with "202 Accepted", this resource may be created after the response is returned. parameters: - - name: GrantRequest - in: body - required: true - schema: - $ref: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + requestBody: + $ref: '#/components/requestBodies/GrantRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the grant has been created successfully (synchronous mode). - A representation of the created "Individual grant" resource shall be returned in the response body. - The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant" - resource just created. - 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 VNF 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: "definitions/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" + $ref: '#/components/responses/Grants.Post.201' 202: - description: > - 202 ACCEPTED - - Shall be returned when the request has been accepted for processing - and it is expected to take some time to create the grant (asynchronous mode). - The response body shall be empty. - The HTTP response shall include a "Location" HTTP header that indicates the URI - of the "Individual grant" resource that will be created once the granting decision has been made. - headers: - Location: - description: The resource URI of the created VNF 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 + $ref: '#/components/responses/Grants.Post.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: -# description: > -# 403 FORBIDDEN -# -# Shall be returned upon the following error: The grant has been rejected. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + #description: | + # 403 FORBIDDEN + # + # Shall be returned upon the following error: The grant has been rejected. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Resource: Individual grant # ############################################################################### - '/grants/{grantId}': + /grants/{grantId}: #SOL003 location: 9.4.3 parameters: - - name: grantId - description: > - Identifier of the grant. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request granting a - new VNF lifecycle operation. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/GrantId' get: - description: > + description: | Grant Lifecycle Operation. The GET method reads a grant. This method shall follow the provisions specified in the tables 9.4.3.3.2-1 and 9.4.3.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the grant has been read successfully. - A representation of the "Individual grant" resource shall be returned in the response body. - 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/VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" + $ref: '#/components/responses/IndividualGrant.Get.200' 202: - description: > - 202 ACCEPTED - - Shall be returned when the process of creating the grant is ongoing, no grant is available yet. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualGrant.Get.202' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: -# description: > -# 403 FORBIDDEN -# -# Shall be returned upon the following error: The grant has been rejected. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + #description: | + # 403 FORBIDDEN + # + # Shall be returned upon the following error: The grant has been rejected. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + +components: + parameters: + GrantId: + name: grantId + in: path + description: | + Identifier of the grant. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request granting a + new VNF lifecycle operation. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + GrantRequest: + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleOperationGranting_def.yaml#/definitions/GrantRequest" + required: true + + responses: + Grants.Post.201: + description: | + 201 CREATED + + Shall be returned when the grant has been created successfully (synchronous mode). + A representation of the created "Individual grant" resource shall be returned in the response body. + The HTTP response shall include a "Location" HTTP header that indicates the URI of the "Individual grant" + resource just created. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" + + Grants.Post.202: + description: | + 202 ACCEPTED + + Shall be returned when the request has been accepted for processing + and it is expected to take some time to create the grant (asynchronous mode). + The response body shall be empty. + The HTTP response shall include a "Location" HTTP header that indicates the URI + of the "Individual grant" resource that will be created once the granting decision has been made. + headers: + Location: + description: | + The resource URI of the created subscription resource. + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualGrant.Get.200: + description: | + 200 OK + + Shall be returned when the grant has been read successfully. + A representation of the "Individual grant" resource shall be returned in the response body. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFLifecycleOperationGranting_def.yaml#/definitions/Grant" + + IndividualGrant.Get.202: + description: | + 202 ACCEPTED + + Shall be returned when the process of creating the grant is ongoing, no grant is available yet. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml b/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml similarity index 72% rename from src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml rename to src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml index 786eb8b53d0a22040db33332e3ce84f1c8c55fa0..6eeab6a6d3a69fbf86a57464def7a246fccddc33 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/definitions/VNFLifecycleOperationGranting_def.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/definitions/SOL003VNFLifecycleOperationGranting_def.yaml @@ -30,6 +30,16 @@ definitions: description: > Identifier of the VNFD that defines the VNF for which the LCM operation is to be granted. + In case of the "Change current VNF package operation, this identifier + refers to the VNFD which defines the VNF before the LCM operation to + be granted. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + dstVnfdId: + description: > + Identifier of the "destination" VNFD which will define the VNF after + executing the "Change current VNF package" LCM operation to be granted. + Shall be included if the operation changes the current VNF Package and + shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" flavourId: description: > @@ -179,13 +189,17 @@ definitions: vnfInstanceId: description: > Identifier of the related VNF instance. + The NFVO shall set the value of the attribute by copying the value + from the associated GrantRequest. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" vnfLcmOpOccId: description: > Identifier of the related VNF lifecycle management operation occurrence. + The NFVO shall set the value of the attribute by copying the value + from the associated GrantRequest. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" - vimConnections: + vimConnectionInfo: description: > Provides information regarding VIM connections that are approved to be used by the VNFM to allocate resources, and provides parameters @@ -193,7 +207,7 @@ definitions: The VNFM shall update the " vimConnectionInfo" attribute of the "VnfInstance" structure by adding unknown entries received in this attribute. - This attribute is not intended for the modification of VimConnection + This attribute is not intended for the modification of vimConnectionInfo entries passed earlier; for that, the VnfInfoModificationRequest structure shall be used. This attribute shall only be supported when VNF-related Resource @@ -205,8 +219,8 @@ definitions: release, it is recommended in the present document that the number of entries in the "vims" attribute in the Grant is not greater than 1. - type: array - items: + type: object + additionalProperties: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/VimConnectionInfo" zones: description: > @@ -226,37 +240,10 @@ definitions: type: array items: $ref: "#/definitions/ZoneGroupInfo" - computeReservationId: - description: > - Information that identifies a reservation applicable to the compute - resource requirements of the corresponding grant request. - At least one of (computeReservationId, networkReservationId, - storageReservationId) shall be present when policy is - GRANT_RESERVE_SINGLE and an applicable reservation exists. None of - these shall be present otherwise. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" - networkReservationId: - description: > - Information that identifies a reservation applicable to the network - resource requirements of the corresponding grant request. - At least one of (computeReservationId, networkReservationId, - storageReservationId) shall be present when policy is - GRANT_RESERVE_SINGLE and an applicable reservation exists. None of - these shall be present otherwise. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" - storageReservationId: - description: > - Information that identifies a reservation applicable to the storage - resource requirements of the corresponding grant request. - At least one of (computeReservationId, networkReservationId, - storageReservationId) shall be present when policy is - GRANT_RESERVE_SINGLE and an applicable reservation exists. None of - these shall be present otherwise. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" addResources: description: > List of resources that are approved to be added, with one entry per - resource. + resource. Shall be set when resources are approved to be added. type: array items: $ref: "#/definitions/GrantInfo" @@ -264,21 +251,22 @@ definitions: description: > List of resources that are approved to be temporarily instantiated during the runtime of the lifecycle operation, with one entry per - resource. + resource. Shall be set when resources are approved to be temporarily + instantiated. type: array items: $ref: "#/definitions/GrantInfo" removeResources: description: > List of resources that are approved to be removed, with one entry - per resource. + per resource. Shall be set when resources are approved to be removed. type: array items: $ref: "#/definitions/GrantInfo" updateResources: description: > List of resources that are approved to be modified, with one entry - per resource. + per resource. Shall be set when resources are approved to be updated. type: array items: $ref: "#/definitions/GrantInfo" @@ -319,25 +307,46 @@ definitions: type: array items: $ref: "#/definitions/VimSoftwareImage" + snapshotResources: + description: > + Mappings between snapshot resources defined in the VNF snapshot package and resources + managed in the VIM. + type: array + items: + $ref: "#/definitions/VimSnapshotResource" extVirtualLinks: description: > Information about external VLs to connect the VNF to. External and/or externally-managed internal VLs can be passed in VNF - lifecycle management operation requests such as InstantiateVnf or - ChangeVnfFlavor, and/or in the grant response. The NFVO may choose - to override in the grant response external and/or externally-managed - VL instances that have been passed previously in the associated VNF - lifecycle management request, if the lifecycle management request + lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor, + ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response. + The NFVO may choose to override in the grant response external and/or + externally-managed VL instances that have been passed previously in the + associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself. + In case of granting an InstantiateVnf request that has originated from the NFVO + and that did not contain the "extVirtualLinks" attribute, this attribute shall be + set by the NFVO. Further in case of granting an InstantiateVnf request that has + originated from the NFVO and that did not contain the "extManagedVirtualLinks" + attribute, this attribute shall be set by the NFVO if there is the need to provide + information about externally-managed virtual links. + If this attribute is present , it need not contain those entries that are unchanged compared to the entries that were passed in the LCM operation which is related to this granting exchange. - External and/or externally-managed internal VLs can be passed in - VNF lifecycle management operation requests such as InstantiateVnf - or ChangeVnfFlavour, and/or in the grant response. The NFVO may choose - to override in the grant response external and/or externally-managed VL - instances that have been passed previously in the associated VNF lifecycle - management request, if the lifecycle management request has originated from the NFVO itself. + External and/or externally-managed internal VLs can be passed in VNF + lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor, + ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response. + The NFVO may choose to override in the grant response external and/or + externally-managed VL instances that have been passed previously in the + associated VNF lifecycle management request, if the lifecycle management request + has originated from the NFVO itself. + In case of granting an InstantiateVnf request that has originated from the NFVO + and that did not contain the "extVirtualLinks" attribute, this attribute shall be + set by the NFVO. Further in case of granting an InstantiateVnf request that has + originated from the NFVO and that did not contain the "extManagedVirtualLinks" + attribute, this attribute shall be set by the NFVO if there is the need to provide + information about externally-managed virtual links. type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtVirtualLinkData" @@ -353,15 +362,21 @@ definitions: externally-managed internal VLs are managed by the NFVO and created towards the VIM. External and/or externally-managed internal VLs can be passed in VNF - lifecycle management operation requests such as InstantiateVnf or - ChangeVnfFlavor, and/or in the grant response. The NFVO may choose - to override in the grant response external and/or externally-managed - VL instances that have been passed previously in the associated VNF - lifecycle management request, if the lifecycle management request + lifecycle management operation requests such as InstantiateVnf, ChangeVnfFlavor, + ChangeExtVnfConnectivity or ChangeCurrentVnfPackage and/or in the grant response. + The NFVO may choose to override in the grant response external and/or + externally-managed VL instances that have been passed previously in the + associated VNF lifecycle management request, if the lifecycle management request has originated from the NFVO itself. + In case of granting an InstantiateVnf request that has originated from the NFVO + and that did not contain the "extVirtualLinks" attribute, this attribute shall be + set by the NFVO. Further in case of granting an InstantiateVnf request that has + originated from the NFVO and that did not contain the "extManagedVirtualLinks" + attribute, this attribute shall be set by the NFVO if there is the need to provide + information about externally-managed virtual links. type: array items: - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ExtManagedVirtualLinkData" + $ref: "../../VNFLifecycleManagement/definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/ExtManagedVirtualLinkData" additionalParams: description: > Additional parameters passed by the NFVO, specific to the VNF and @@ -423,11 +438,19 @@ definitions: resource. Shall only be present if a VDU is applicable to this resource. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD to which resourceTemplateId and vduId refer. Shall be present + if at least one of resourceTemplateId and vduId is present and the operation to + be granted changes the current VNF Package. May be absent otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" resourceTemplateId: description: > - Reference to a resource template (VnfVirtualLinkDesc, - VirtualComputeDesc, VnfExtCpd, VirtualStorageDesc) in the - VNFD. + Reference to the applicable resource template in the VNFD as follows: + - if type="VL" : VnfVirtualLinkDesc + - if type="COMPUTE": VirtualComputeDesc + - if type="LINKPORT" : VnfExtCpd + - if type="STORAGE" : VirtualStorageDesc $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" resource: description: > @@ -435,6 +458,12 @@ definitions: resources that are planned to be deleted or modified. Shall be absent otherwise. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + snapshotResDef: + description: > + Information to identify a snapshot resource. Shall only be present if the + operation to be granted concerns to creating a VNF snapshot from the VNF + or to reverting the VNF to a VNF snapshot. + $ref: "#/definitions/SnapshotResourceDefinition" GrantInfo: description: > @@ -451,11 +480,10 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" reservationId: description: > - The reservation identifier applicable to the - VNFC/VirtualLink/VirtualStorage. It shall be present for new - resources when policy is GRANT_RESERVE_MULTI and an applicable - reservation exists; shall not be present otherwise. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + The reservation identifier applicable to the VNFC/VirtualLink/VirtualStorage/compute + host. It shall be present for new resources when policy is GRANT_RESERVE and an + applicable reservation exists; shall not be present otherwise. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" vimConnectionId: description: > Identifier of the VIM connection to be used to manage this resource. @@ -777,4 +805,114 @@ definitions: description: > Identifier of the software image in the resource management layer (i.e. VIM). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" + + SnapshotResourceDefinition: + description: > + This type represents resource definition information related to a snapshot resource. + type: object + required: + - vnfSnapshotId + properties: + vnfSnapshotId: + description: > + Identifier of the VNF snapshot related to the resource change for the VNF instance. + Shall only be present if the operation to be granted concerns to creating a VNF snapshot + from the VNF or to reverting the VNF to a VNF snapshot. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcSnapshotId: + description: > + Reference to the information about a specific VNFC snapshot (refer to "VnfcSnapshotInfo") + of the VNF snapshot. The identifier is unique within the scope of a VNF snapshot, identified + by the "vnfSnapshotId" attribute. Shall only be present if the operation to be granted + concerns to reverting the VNF to a VNF snapshot, and the resource is planned to be added + based on the VNFC snapshot, and the type of resource is "COMPUTE" or "STORAGE". + + If present, the value of the "vduId" (for a related VDU) in the "VnfcResourceInfo" referred + by the "vnfcInfoId" of the "VnfcSnapshotInfo" shall match the value of the "vduId" in the + resource definition that is signalled in the granting request. + + For snapshot resource definitions extracted from a VNF snapshot package, only the + "vnfcSnapshotId" and "storageSnapshotId" (in case of a storage type of resource) are applicable. + If the snapshot resource definition is generated as part of a VNF snapshot created by the VNFM + (that is, not extracted from a VNF snapshot package), the "snapshotResource" is applicable. + This is a similar specification as the one defined with the "vduId", "resourceTemplateId" and + "resource" attributes provided in the ResourceDefinition, but in this case applicable to resources + that are defined from VNF snapshots instead of VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + storageSnapshotId: + description: > + Reference to a snapshotted storage resource associated to the VNFC snapshot. Shall only be + present if the operation to be granted concerns to reverting the VNF to a VNF snapshot, + and the storage resource is planned to be added based on the VNFC snapshot, and the type + of resource is "STORAGE". + + For snapshot resource definitions extracted from a VNF snapshot package, only the + "vnfcSnapshotId" and "storageSnapshotId" (in case of a storage type of resource) are applicable. + If the snapshot resource definition is generated as part of a VNF snapshot created by the VNFM + (that is, not extracted from a VNF snapshot package), the "snapshotResource" is applicable. + This is a similar specification as the one defined with the "vduId", "resourceTemplateId" and + "resource" attributes provided in the ResourceDefinition, but in this case applicable to resources + that are defined from VNF snapshots instead of VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + snapshotResource: + description: > + Resource information for an existing snapshot resource. Shall only be present if the + operation to be granted concerns to reverting the VNF to a VNF snapshot and the resource is + planned to be added based on an existing VNF snapshot that has been created by the VNFM. + Shall be absent otherwise. + + For snapshot resource definitions extracted from a VNF snapshot package, only the + "vnfcSnapshotId" and "storageSnapshotId" (in case of a storage type of resource) are applicable. + If the snapshot resource definition is generated as part of a VNF snapshot created by the VNFM + (that is, not extracted from a VNF snapshot package), the "snapshotResource" is applicable. + This is a similar specification as the one defined with the "vduId", "resourceTemplateId" and + "resource" attributes provided in the ResourceDefinition, but in this case applicable to resources + that are defined from VNF snapshots instead of VNFD. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ResourceHandle" + + VimSnapshotResource: + description: > + This type contains a mapping between a snapshot resource definition related to a VNF snapshot + and the corresponding resource managed by the NFVO in the VIM which is needed during the revert + to VNF snapshot operation. + type: object + required: + - vnfSnapshotId + - vnfcSnapshotId + - vimSnapshotResourceId + properties: + vimConnectionId: + description: > + Identifier of the VIM connection to access the software image referenced in this structure. + The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be + obtained from the "vimConnectionInfo" attribute of the "VnfInstance" structure. + This attribute shall only be supported and present if VNF-related resource management in direct + mode is applicable. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + resourceProviderId: + description: > + Identifies the entity responsible for the management of the virtualised 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/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshotId: + description: > + Identifier of the VNF snapshot related to the snapshot resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcSnapshotId: + description: > + Identifier of the information about a specific VNFC snapshot (refer to "VnfcSnapshotInfo") of + the VNF snapshot. The identifier is unique within the scope of a VNF snapshot, identified by + the "vnfSnapshotId" attribute. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + storageSnapshotId: + description: > + Identifier of the virtual storage resource that has been snapshotted as referred in the VNFC + snapshot information. Shall only be present if the snapshot resource in the VIM is a storage + resource (as indicated by "type=STORAGE" in the parent resource definition). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vimSnapshotResourceId: + description: > + Identifier of the snapshot resource in the resource management layer (i.e. VIM). $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVim" \ No newline at end of file diff --git a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml index 2e4de3ac4efb3d67117dc4fa1a858ccde74fc485..a2434399db40c44a03e964d8d73170843beb113c 100644 --- a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml @@ -1,415 +1,168 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Package Management interface - description: > + description: | SOL003 - VNF Package Management interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -basePath: "/vnfpkgm/v2" - -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/vnfpkgm/v2 + - url: https://127.0.0.1/vnfpkgm/v2 paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': + /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # VNF packages # ############################################################################### - '/onboarded_vnf_packages': + /onboarded_vnf_packages: #SOL003 location: 10.4.2 get: - description: > + description: | Query VNF Package Info. The GET method queries the information of the VNF packages matching the filter. This method shall follow the provisions specified in the tables 10.4.2.3.2-1 and 10.4.2.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the VnfPkgInfo and in data - types referenced from it shall be supported by the VNFM in the - filter expression. - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter. - The following attributes shall be excluded from the VnfPkgInfo structure in the response - body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", - "exclude_default" are provided: - - softwareImages - - additionalArtifacts - - userDefinedData. - - checksum - - onboardingFailureDetails - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the VnfPkgInfo structure - in the response body if this parameter is provided, or none of the parameters - "all_fields," "fields", "exclude_fields", "exclude_default" are provided: - - softwareImages - - additionalArtifacts - - userDefinedData. - in: query - required: false - type: string - - name: nextpage_opaque_marker - 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 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more VNF packages has been queried successfully. - 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 10.5.2.2. - If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" - (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the - response body shall have been transformed according to the rules specified in clauses 5.2.2 and - 5.3.2 of ETSI GS NFV-SOL 013, respectively. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - type: array - items: - $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + $ref: '#/components/responses/OnboardedVnfPackages.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual VNF package # ############################################################################### - '/vnf_packages/{vnfPkgId}': + /vnf_packages/{vnfPkgId}: 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 + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Query VNF Package Info. The GET method reads the information of an individual VNF package. This method shall follow the provisions specified in the tables 10.4.3.3.2-1 and 10.4.3.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string - - name: include_signature - description: > - If this parameter is provided, the NFVO shall include in the ZIP - archive the security information as specified above. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when information of the VNF package has been read successfully. - The response body shall contain the VNF package info representation defined in clause 10.5.2.2. - 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/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + $ref: '#/components/responses/IndividualVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}': + /onboarded_vnf_packages/{vnfdId}: parameters: - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Query VNF Package Info. The GET method reads the information of an individual VNF package. This method shall follow the provisions specified in the tables 10.4.3.3.2-1 and 10.4.3.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information of the VNF package has been read successfully. - The response body shall contain the VNF package info representation defined in clause 10.5.2.2. - 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/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + $ref: '#/components/responses/IndividualOnboardedVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # VNFD in an individual VNF package # ############################################################################### - '/vnf_packages/{vnfPkgId}/vnfd': + /vnf_packages/{vnfPkgId}/vnfd: 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 + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Query VNF Package Info The GET method reads the content of the VNFD within a VNF package. @@ -499,116 +252,46 @@ paths: and 10.4.4.3.2-2 for URI query parameters, request and response data structures, nd response codes. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Permitted values: "text/plain" and/or "application/zip" - Reference: IETF RFC 7231 - in: header - required: true - type: string - enum: - - text/plain - - application/zip - - 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: include_signatures - description: > - If this parameter is provided, the NFVO shall include in the ZIP - archive the security information as specified above. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the content of the VNFD has been read successfully. - The payload body shall contain a copy of the file representing the VNFD or - a ZIP file that contains the file or multiple files representing the VNFD, - as specified above. - The "Content-Type" HTTP header shall be set according to the format of the - returned file, i.e. to "text/plain" for a YAML file or to "application/zip" - for a ZIP file. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - enum: - - text/plain - - application/zip - 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 + $ref: '#/components/responses/VnfdInIndividualVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 409: - # description: > + # description: | # 409 CONFLICT # # Shall be returned upon the following 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". - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}/vnfd': + /onboarded_vnf_packages/{vnfdId}/vnfd: parameters: - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Query VNF Package Info The GET method reads the content of the VNFD within a VNF package. @@ -698,120 +381,49 @@ paths: and 10.4.4.3.2-2 for URI query parameters, request and response data structures, nd response codes. parameters: - - name: Accept - description: > - Content-Types that are acceptable for the response. - Permitted values: "text/plain" and/or "application/zip" - Reference: IETF RFC 7231 - in: header - required: true - type: string - enum: - - text/plain - - application/zip - - 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: include_signatures - description: > - If this parameter is provided, the NFVO shall include in the ZIP - archive the security information as specified above. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the content of the VNFD has been read successfully. - The payload body shall contain a copy of the file representing the VNFD or - a ZIP file that contains the file or multiple files representing the VNFD, - as specified above. - The "Content-Type" HTTP header shall be set according to the format of the - returned file, i.e. to "text/plain" for a YAML file or to "application/zip" - for a ZIP file. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - enum: - - text/plain - - application/zip - 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 + $ref: '#/components/responses/VnfdInIndividualOnboardedVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 409: - # description: > + # description: | # 409 CONFLICT # # Shall be returned upon the following 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". - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Manifest in an individual VNF package # ############################################################################### - '/vnf_packages/{vnfPkgId}/manifest': + /vnf_packages/{vnfPkgId}/manifest: 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 + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Query VNF Package Manifest The GET method reads the content of the manifest within a VNF package. @@ -819,119 +431,41 @@ paths: and 10.4.4a.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. - Permitted values: "text/plain" and/or "application/zip" - Reference: IETF RFC 7231 - in: header - required: true - type: string - enum: - - text/plain - - application/zip - - 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: include_signatures - description: > - If this parameter is provided, the NFVO shall return the manifest and related security - information (such as certificate) in a ZIP archive. - If this parameter is not given, the NFVO shall provide only a copy of the manifest file. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the content of the manifest has been read successfully. - If the "include_signatures" URI query parameter was absent in the request, - or if the manifest file has all security-related information embedded - (i.e. there is no separate certificate file), the payload body shall contain - a copy of the manifest file of the VNF package and the "Content-Type" HTTP - header shall be set to "text/plain". - - If the "include_signatures" URI query parameter was present in the related - request and the manifest file does not have all the security-related - information embedded (i.e. there is a separate certificate file), - the "Content-Type" HTTP header shall be set to "application/zip and the - payload body shall contain a ZIP archive which includes: - • a copy of the manifest file of the VNF package; - • a copy of the related individual certificate file. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - enum: - - text/plain - - application/zip - 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 + $ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}/manifest': + /onboarded_vnf_packages/{vnfdId}/manifest: parameters: - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Query VNF Package Manifest The GET method reads the content of the manifest within a VNF package. @@ -939,123 +473,44 @@ paths: and 10.4.4a.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. - Permitted values: "text/plain" and/or "application/zip" - Reference: IETF RFC 7231 - in: header - required: true - type: string - enum: - - text/plain - - application/zip - - 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: include_signatures - description: > - If this parameter is provided, the NFVO shall return the manifest and related security - information (such as certificate) in a ZIP archive. - If this parameter is not given, the NFVO shall provide only a copy of the manifest file. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the content of the manifest has been read successfully. - If the "include_signatures" URI query parameter was absent in the request, - or if the manifest file has all security-related information embedded - (i.e. there is no separate certificate file), the payload body shall contain - a copy of the manifest file of the VNF package and the "Content-Type" HTTP - header shall be set to "text/plain". - - If the "include_signatures" URI query parameter was present in the related - request and the manifest file does not have all the security-related - information embedded (i.e. there is a separate certificate file), - the "Content-Type" HTTP header shall be set to "application/zip and the - payload body shall contain a ZIP archive which includes: - • a copy of the manifest file of the VNF package; - • a copy of the related individual certificate file. - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - enum: - - text/plain - - application/zip - 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 + $ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # VNF package content # ############################################################################### - '/vnf_packages/{vnfPkgId}/package_content': + /vnf_packages/{vnfPkgId}/package_content: 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 + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Fetch VNF Package. The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. @@ -1072,150 +527,55 @@ paths: 10.4.5.3.2-1 and 10.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: - - text/plain - - application/zip - - 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 "Range" header is present in the request and the NFVO - does not support responding to range requests with a 206 response, - it shall return a 200 OK response instead as defined below. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the VNF package file has been read successfully. - The response body shall include a copy of the VNF package file. - 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. - 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 + $ref: '#/components/responses/IndividualVnfPackageContent.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests, this response shall be returned when - a single consecutive byte range from the content of the VNF package file - has been read successfully according to the request. - 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: - 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 + $ref: '#/components/responses/IndividualVnfPackageContent.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: -# description: > -# 409 CONFLICT -# -# Shall be returned upon the following 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". - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + # description: | + # 409 CONFLICT + + # Shall be returned upon the following 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". + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: -# description: > -# 416 RANGE NOT SATISFIABLE -# -# Shall be returned upon the following error: The byte range passed in the "Range" header -# did not match any available byte range in the VNF package file (e.g. "access after end of file"). - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + # description: | + # 416 RANGE NOT SATISFIABLE + + # Shall be returned upon the following error: The byte range passed in the "Range" header + # did not match any available byte range in the VNF package file (e.g. "access after end of file"). + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}/package_content': + /onboarded_vnf_packages/{vnfdId}/package_content: parameters: - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - type: string - required: true + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Fetch VNF Package. The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. @@ -1232,152 +592,58 @@ paths: 10.4.5.3.2-1 and 10.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: - - text/plain - - application/zip - - 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 "Range" header is present in the request and the NFVO - does not support responding to range requests with a 206 response, - it shall return a 200 OK response instead as defined below. - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the VNF package file has been read successfully. - The response body shall include a copy of the VNF package file. - 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. - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests, this response shall be returned when - a single consecutive byte range from the content of the VNF package file - has been read successfully according to the request. - 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: - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: -# description: > -# 409 CONFLICT -# -# Shall be returned upon the following 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". - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + # description: | + # 409 CONFLICT + + # Shall be returned upon the following 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". + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: -# description: > -# 416 RANGE NOT SATISFIABLE -# -# Shall be returned upon the following error: The byte range passed in the "Range" header -# did not match any available byte range in the VNF package file (e.g. "access after end of file"). - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + # description: | + # 416 RANGE NOT SATISFIABLE + + # Shall be returned upon the following error: The byte range passed in the "Range" header + # did not match any available byte range in the VNF package file (e.g. "access after end of file"). + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # VNF package artifacts # ############################################################################### - '/vnf_packages/{vnfPkgId}/artifacts': + /vnf_packages/{vnfPkgId}/artifacts: 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 - required: true - type: string + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Fetch VNF Package Artifacts. The GET method shall return an archive that contains a set of artifacts @@ -1385,7 +651,10 @@ paths: embedded in a directory structure being the same as in the VNF package. The criteria for exclusion/inclusion of an artifact in the archive are defined as follows: - Artifacts that are software images shall be excluded from the archive. - - Artifacts that are external to the VNF package shall be excluded from the archive. + - Artifacts that are not software images and that are external to the VNF package shall be + excluded from the archive unless the URI query parameter "include_external_artifacts" has + been provided. External artifacts shall be included in the archive using the content of + the "artifactPath" attribute as the path. - All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive, unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts shall be excluded. @@ -1400,149 +669,43 @@ paths: This method shall follow the provisions specified in the tables 10.4.5a.3.2-1 and 10.4.5a.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. - The "Accept" HTTP header shall be set to "application/zip". - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the archive containing - the artifact files has been read successfully. - The payload body shall be a ZIP archive containing the requested - set of artifacts selected according to the provisions specified above - in this clause, and, if the flag "include_signatures" was provided in - the related request, the applicable signature files and, if available, - the separate certificate files from the VNF package. - The "Content-Type" HTTP header shall be set to "application/zip". - headers: - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests, this response shall be returned - when a single consecutive byte range from the content of the archive - that would have been returned in a "200 OK" response has been read - successfully according to the request. - The response body shall contain the requested part of the archive. - The "Content-Type" HTTP header shall be set to "application/zip". - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. - headers: - Content-Range: - type: string - maximum: 1 - minimum: 1 - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}/artifacts': + /onboarded_vnf_packages/{vnfdId}/artifacts: parameters: - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - required: true - type: string + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Fetch VNF Package Artifacts. The GET method shall return an archive that contains a set of artifacts @@ -1550,7 +713,10 @@ paths: embedded in a directory structure being the same as in the VNF package. The criteria for exclusion/inclusion of an artifact in the archive are defined as follows: - Artifacts that are software images shall be excluded from the archive. - - Artifacts that are external to the VNF package shall be excluded from the archive. + - Artifacts that are not software images and that are external to the VNF package shall be + excluded from the archive unless the URI query parameter "include_external_artifacts" has + been provided. External artifacts shall be included in the archive using the content of + the "artifactPath" attribute as the path. - All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive, unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts shall be excluded. @@ -1565,560 +731,175 @@ paths: This method shall follow the provisions specified in the tables 10.4.5a.3.2-1 and 10.4.5a.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. - The "Accept" HTTP header shall be set to "application/zip". - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the archive containing - the artifact files has been read successfully. - The payload body shall be a ZIP archive containing the requested - set of artifacts selected according to the provisions specified above - in this clause, and, if the flag "include_signatures" was provided in - the related request, the applicable signature files and, if available, - the separate certificate files from the VNF package. - The "Content-Type" HTTP header shall be set to "application/zip". - headers: - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests, this response shall be returned - when a single consecutive byte range from the content of the archive - that would have been returned in a "200 OK" response has been read - successfully according to the request. - The response body shall contain the requested part of the archive. - The "Content-Type" HTTP header shall be set to "application/zip". - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. - headers: - Content-Range: - type: string - maximum: 1 - minimum: 1 - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual VNF package artifact # ############################################################################### - '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}': + /vnf_packages/{vnfPkgId}/artifacts/{artifactPath}: parameters: - - name: artifactPath - description: > - SequenceFor an artifact contained as a file in the VNF package, - this variable shall contain a sequence of one or more path segments - representing the path of the artifact within the VNF package, - relative to the root of the package. - - EXAMPLE: foo/bar/m%40ster.sh - - For an external artifact represented as a URI in the VNF package - manifest, this variable shall contain a sequence of one or more path - segments as synthesized by the NFVO (see clause 10.5.3.3), - representing this artifact. - - Since multiple path segments are allowed to be contained in this variable, - the "/" character that separates these segments is not percent-encoded. - Each individual segment is percent-encoded if necessary as defined in clause - 4.1 of ETSI GS NFV-SOL 013. - in: path - type: string - required: true - - 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 + - $ref: '#/components/parameters/ArtifactPath' + - $ref: '#/components/parameters/VnfPkgId' get: - description: > + description: | Fetch VNF Package Artifacts. The GET method fetches the content of an artifact within a VNF package. This method shall follow the provisions specified in the tables 10.4.6.3.2-1 and 10.4.6.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 "Range" header is present in the request and the NFVO - does not support responding to range requests with a 206 response, - it shall return a 200 OK response instead as defined below. - 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 - - name: include_signatures - description: > - If this parameter is provided, the NFVO shall return the artifact - and related security information (such as signature and optional - certificate) in a ZIP archive. - If this parameter is not given, the NFVO shall provide only a copy - of the artifact file. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the artifact file has - been read successfully. - - If the "include_signatures" request URI parameter was not provided in - the related request, the payload body shall contain a copy of the artifact - file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type" - HTTP header shall be set according to the content type of the artifact file. - If the artifact is encrypted, the header shall be set to the value "application/cms" - (IETF RFC 7193). If the content type cannot be determined, the header shall be set - to the value "application/octet-stream". - - If the "include_signatures" request URI parameter was provided in the related request, - the "Content-Type" HTTP header shall be set to "application/zip and the payload body - shall contain a ZIP archive which includes: - • a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004; - • the related security information (individual signature file and optional related - individual certificate file). - headers: - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests and the "include_signatures" request - URI parameter was not present in the related request, this response shall - be returned when a single consecutive byte range from the content of the - artifact file, if the NFVO supports range requests has been read successfully - according to the request. - 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: - 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 + $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: -# description: > -# 409 CONFLICT -# -# Shall be returned upon the following 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. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + # description: | + # 409 CONFLICT + + # Shall be returned upon the following 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. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: -# description: > -# 416 RANGE NOT SATISFIABLE -# -# Shall be returned upon the following error: The byte range passed in the -# "Range" header did not match any available byte range in the artifact file -# (e.g. "access after end of file"). -# The response body may contain a ProblemDetails structure. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + # description: | + # 416 RANGE NOT SATISFIABLE + + # Shall be returned upon the following error: The byte range passed in the + # "Range" header did not match any available byte range in the artifact file + # (e.g. "access after end of file"). + # The response body may contain a ProblemDetails structure. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" - '/onboarded_vnf_packages/{vnfdId}/artifacts/{artifactPath}': + /onboarded_vnf_packages/{vnfdId}/artifacts/{artifactPath}: parameters: - - name: artifactPath - description: > - SequenceFor an artifact contained as a file in the VNF package, - this variable shall contain a sequence of one or more path segments - representing the path of the artifact within the VNF package, - relative to the root of the package. - - EXAMPLE: foo/bar/m%40ster.sh - - For an external artifact represented as a URI in the VNF package - manifest, this variable shall contain a sequence of one or more path - segments as synthesized by the NFVO (see clause 10.5.3.3), - representing this artifact. - - Since multiple path segments are allowed to be contained in this variable, - the "/" character that separates these segments is not percent-encoded. - Each individual segment is percent-encoded if necessary as defined in clause - 4.1 of ETSI GS NFV-SOL 013. - in: path - type: string - required: true - - name: vnfdId - description: > - Identifier of the VNFD and the VNF package. - The identifier is allocated by the VNF provider. - This identifier can be retrieved from the "vnfdId" attribute - in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. - in: path - type: string - required: true + - $ref: '#/components/parameters/ArtifactPath' + - $ref: '#/components/parameters/VnfdId' get: - description: > + description: | Fetch VNF Package Artifacts. The GET method fetches the content of an artifact within a VNF package. This method shall follow the provisions specified in the tables 10.4.6.3.2-1 and 10.4.6.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 "Range" header is present in the request and the NFVO - does not support responding to range requests with a 206 response, - it shall return a 200 OK response instead as defined below. - 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 - - name: include_signatures - description: > - If this parameter is provided, the NFVO shall return the artifact - and related security information (such as signature and optional - certificate) in a ZIP archive. - If this parameter is not given, the NFVO shall provide only a copy - of the artifact file. - This URI query parameter is a flag, i.e. it shall have no value. - The NFVO shall support this parameter. - in: query - required: false - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/Range' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: '#/components/parameters/include_signature' responses: 200: - description: > - 200 OK - - Shall be returned when the whole content of the artifact file has - been read successfully. - - If the "include_signatures" request URI parameter was not provided in - the related request, the payload body shall contain a copy of the artifact - file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type" - HTTP header shall be set according to the content type of the artifact file. - If the artifact is encrypted, the header shall be set to the value "application/cms" - (IETF RFC 7193). If the content type cannot be determined, the header shall be set - to the value "application/octet-stream". - - If the "include_signatures" request URI parameter was provided in the related request, - the "Content-Type" HTTP header shall be set to "application/zip and the payload body - shall contain a ZIP archive which includes: - • a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004; - • the related security information (individual signature file and optional related - individual certificate file). - headers: - Content-Type: - description: > - The MIME type of the body of the response. - 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". - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.200' 206: - description: > - 206 PARTIAL CONTENT - - If the NFVO supports range requests and the "include_signatures" request - URI parameter was not present in the related request, this response shall - be returned when a single consecutive byte range from the content of the - artifact file, if the NFVO supports range requests has been read successfully - according to the request. - 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: - 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 + $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.206' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 409: -# description: > -# 409 CONFLICT -# -# Shall be returned upon the following 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. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409" + # description: | + # 409 CONFLICT + + # Shall be returned upon the following 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. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/409" 416: -# description: > -# 416 RANGE NOT SATISFIABLE -# -# Shall be returned upon the following error: The byte range passed in the -# "Range" header did not match any available byte range in the artifact file -# (e.g. "access after end of file"). -# The response body may contain a ProblemDetails structure. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + # description: | + # 416 RANGE NOT SATISFIABLE + + # Shall be returned upon the following error: The byte range passed in the + # "Range" header did not match any available byte range in the artifact file + # (e.g. "access after end of file"). + # The response body may contain a ProblemDetails structure. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Subscriptions # ############################################################################### - '/subscriptions': + /subscriptions: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables @@ -2128,329 +909,130 @@ paths: "Individual subscription" resource as defined in clause 10.4.8 shall have been created. This method shall not trigger any notification. Creation of two "Individual subscription" resources with the same - callbackURI and the same filter can result in performance degradation + callback URI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a new "Individual subscription" resource if another "Individual subscription" resource with the same filter and - callbackUri already exists (in which case it shall return the + callback URI already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" - resource with the same filter and callbackUri). - parameters: - - name: PkgmSubscriptionRequest - description: > - Representation of the created subscription resource. - The HTTP response shall include a "Location" HTTP header that - points to the created subscription resource. - in: body - required: true - schema: - $ref: "definitions/VNFPackageManagement_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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + resource with the same filter and callback URI). + requestBody: + $ref: '#/components/requestBodies/PkgmSubscriptionRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location" HTTP header that points to the created resource. - 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 VNF 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: - type: array - items: - $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + $ref: '#/components/responses/Subscriptions.Post.201' 303: -# description: > -# 303 SEE OTHER -# -# Shall be returned when a subscription with the same callbackURI and the same filter -# already exists and the policy of the NFVO is to not create redundant subscriptions. -# The HTTP response shall include a "Location" HTTP header that contains the resource -# URI of the existing "Individual subscription" resource. -# The response body shall be empty. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" + # description: | + # 303 SEE OTHER + + # Shall be returned when a subscription with the same callback URI and the same filter + # already exists and the policy of the NFVO is to not create redundant subscriptions. + # The HTTP response shall include a "Location" HTTP header that contains the resource + # URI of the existing "Individual subscription" resource. + # The response body shall be empty. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303" 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query Subscription Information. 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 10.4.7.3.2-1 and 10.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the PkgmSubscription and in - data types referenced from it shall be supported by the VNFM in - the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - 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 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active - subscriptions of the functional block that invokes the method, i.e. zero or more - representations of VNF package management subscriptions as defined in clause 10.5.2.4. - If the "filter" URI parameter was supplied in the request, the data in the response - body shall have been transformed according to the rules specified in clause 5.2.2 - of ETSI GS NFV-SOL 013 - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - type: array - items: - $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + $ref: '#/components/responses/Subscriptions.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual subscription # ############################################################################### - '/subscriptions/{subscriptionId}': + /subscriptions/{subscriptionId}: #SOL003 location: 10.4.8 parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by - the "Location" HTTP header in the response to a POST request - creating a new "Individual subscription" resource. It can also be retrieved from - the "id" attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query Subscription Information. The GET method reads an individual subscription. This method shall follow the provisions specified in the tables 10.4.8.3.2-1 and 10.4.8.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has been read successfully. - The response body shall contain a representation of the "Individual subscription" resource. - 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/VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + $ref: '#/components/responses/IndividualSubscription.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: - description: > + description: | Terminate subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 10.4.8.3.5-1 and 10.4.8.3.5-2 @@ -2461,58 +1043,1043 @@ paths: NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. - 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: > - 204 NO CONTENT - - Shall be returned when the "Individual subscription" resource has been deleted successfully. - headers: - 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 + $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + +components: + parameters: + VnfPkgId: + name: vnfPkgId + in: path + 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. + required: true + style: simple + explode: false + schema: + type: string + + VnfdId: + name: vnfdId + in: path + description: | + Identifier of the VNFD and the VNF package. + The identifier is allocated by the VNF provider. + This identifier can be retrieved from the "vnfdId" attribute + in the VnfPackageOnboardingNotification or VnfPackageChangeNotification. + required: true + style: simple + explode: false + schema: + type: string + + ArtifactPath: + name: artifactPath + in: path + description: | + SequenceFor an artifact contained as a file in the VNF package, + this variable shall contain a sequence of one or more path segments + representing the path of the artifact within the VNF package, + relative to the root of the package. + + EXAMPLE: foo/bar/m%40ster.sh + + For an external artifact represented as a URI in the VNF package + manifest, this variable shall contain a sequence of one or more path + segments as synthesized by the NFVO (see clause 10.5.3.3), + representing this artifact. + + Since multiple path segments are allowed to be contained in this variable, + the "/" character that separates these segments is not percent-encoded. + Each individual segment is percent-encoded if necessary as defined in clause + 4.1 of ETSI GS NFV-SOL 013. + required: true + style: simple + explode: false + schema: + type: string + + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. + This identifier can be retrieved from the resource referenced by + the "Location" HTTP header in the response to a POST request + creating a new "Individual subscription" resource. It can also be retrieved from + the "id" attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + include_signature: + name: include_signature + in: query + description: | + If this parameter is provided, the NFVO shall include in the ZIP + archive the security information as specified above. + This URI query parameter is a flag, i.e. it shall have no value. + The NFVO shall support this parameter. + required: false + schema: + type: string + + Range: + name: Range + in: header + 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 "Range" header is present in the request and the NFVO + does not support responding to range requests with a 206 response, + it shall return a 200 OK response instead. + required: false + schema: + type: string + + requestBodies: + PkgmSubscriptionRequest: + description: | + Representation of the created subscription resource. + The HTTP response shall include a "Location" HTTP header that + points to the created subscription resource. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest" + required: true + + responses: + OnboardedVnfPackages.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF packages has been queried successfully. + 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 10.5.2.2. + If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" + (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the + response body shall have been transformed according to the rules specified in clauses 5.2.2 and + 5.3.2 of ETSI GS NFV-SOL 013, respectively. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + + IndividualVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when information of the VNF package has been read successfully. + The response body shall contain the VNF package info representation defined in clause 10.5.2.2. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + + IndividualOnboardedVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when information of the VNF package has been read successfully. + The response body shall contain the VNF package info representation defined in clause 10.5.2.2. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo" + + VnfdInIndividualVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when the content of the VNFD has been read successfully. + The payload body shall contain a copy of the file representing the VNFD or + a ZIP file that contains the file or multiple files representing the VNFD, + as specified above. + The "Content-Type" HTTP header shall be set according to the format of the + returned file, i.e. to "text/plain" for a YAML file or to "application/zip" + for a ZIP file. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + enum: + - text/plain + - application/zip + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + VnfdInIndividualOnboardedVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when the content of the VNFD has been read successfully. + The payload body shall contain a copy of the file representing the VNFD or + a ZIP file that contains the file or multiple files representing the VNFD, + as specified above. + The "Content-Type" HTTP header shall be set according to the format of the + returned file, i.e. to "text/plain" for a YAML file or to "application/zip" + for a ZIP file. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + enum: + - text/plain + - application/zip + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ManifestInIndividualVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when the content of the manifest has been read successfully. + If the "include_signatures" URI query parameter was absent in the request, + or if the manifest file has all security-related information embedded + (i.e. there is no separate certificate file), the payload body shall contain + a copy of the manifest file of the VNF package and the "Content-Type" HTTP + header shall be set to "text/plain". + + If the "include_signatures" URI query parameter was present in the related + request and the manifest file does not have all the security-related + information embedded (i.e. there is a separate certificate file), + the "Content-Type" HTTP header shall be set to "application/zip and the + payload body shall contain a ZIP archive which includes: + • a copy of the manifest file of the VNF package; + • a copy of the related individual certificate file. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + enum: + - text/plain + - application/zip + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + ManifestInIndividualOnboardedVnfPackage.Get.200: + description: | + 200 OK + + Shall be returned when the content of the manifest has been read successfully. + If the "include_signatures" URI query parameter was absent in the request, + or if the manifest file has all security-related information embedded + (i.e. there is no separate certificate file), the payload body shall contain + a copy of the manifest file of the VNF package and the "Content-Type" HTTP + header shall be set to "text/plain". + + If the "include_signatures" URI query parameter was present in the related + request and the manifest file does not have all the security-related + information embedded (i.e. there is a separate certificate file), + the "Content-Type" HTTP header shall be set to "application/zip and the + payload body shall contain a ZIP archive which includes: + • a copy of the manifest file of the VNF package; + • a copy of the related individual certificate file. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + enum: + - text/plain + - application/zip + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageContent.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the VNF package file has been read successfully. + The response body shall include a copy of the VNF package file. + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageContent.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned when + a single consecutive byte range from the content of the VNF package file + has been read successfully according to the request. + 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: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageContent.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the VNF package file has been read successfully. + The response body shall include a copy of the VNF package file. + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageArtifact.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the artifact file has + been read successfully. + + If the "include_signatures" request URI parameter was not provided in + the related request, the payload body shall contain a copy of the artifact + file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type" + HTTP header shall be set according to the content type of the artifact file. + If the artifact is encrypted, the header shall be set to the value "application/cms" + (IETF RFC 7193). If the content type cannot be determined, the header shall be set + to the value "application/octet-stream". + + If the "include_signatures" request URI parameter was provided in the related request, + the "Content-Type" HTTP header shall be set to "application/zip and the payload body + shall contain a ZIP archive which includes: + • a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004; + • the related security information (individual signature file and optional related + individual certificate file). + headers: + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageContent.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned when + a single consecutive byte range from the content of the VNF package file + has been read successfully according to the request. + 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: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageArtifacts.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the archive containing + the artifact files has been read successfully. + The payload body shall be a ZIP archive containing the requested + set of artifacts selected according to the provisions specified above + in this clause, and, if the flag "include_signatures" was provided in + the related request, the applicable signature files and, if available, + the separate certificate files from the VNF package. + The "Content-Type" HTTP header shall be set to "application/zip". + headers: + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageArtifact.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests and the "include_signatures" request + URI parameter was not present in the related request, this response shall + be returned when a single consecutive byte range from the content of the + artifact file, if the NFVO supports range requests has been read successfully + according to the request. + 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: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + required: true + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualVnfPackageArtifacts.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned + when a single consecutive byte range from the content of the archive + that would have been returned in a "200 OK" response has been read + successfully according to the request. + The response body shall contain the requested part of the archive. + The "Content-Type" HTTP header shall be set to "application/zip". + The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + headers: + Content-Range: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageArtifacts.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the archive containing + the artifact files has been read successfully. + The payload body shall be a ZIP archive containing the requested + set of artifacts selected according to the provisions specified above + in this clause, and, if the flag "include_signatures" was provided in + the related request, the applicable signature files and, if available, + the separate certificate files from the VNF package. + The "Content-Type" HTTP header shall be set to "application/zip". + headers: + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageArtifacts.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned + when a single consecutive byte range from the content of the archive + that would have been returned in a "200 OK" response has been read + successfully according to the request. + The response body shall contain the requested part of the archive. + The "Content-Type" HTTP header shall be set to "application/zip". + The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + headers: + Content-Range: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageArtifact.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the artifact file has + been read successfully. + + If the "include_signatures" request URI parameter was not provided in + the related request, the payload body shall contain a copy of the artifact + file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type" + HTTP header shall be set according to the content type of the artifact file. + If the artifact is encrypted, the header shall be set to the value "application/cms" + (IETF RFC 7193). If the content type cannot be determined, the header shall be set + to the value "application/octet-stream". + + If the "include_signatures" request URI parameter was provided in the related request, + the "Content-Type" HTTP header shall be set to "application/zip and the payload body + shall contain a ZIP archive which includes: + • a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004; + • the related security information (individual signature file and optional related + individual certificate file). + headers: + Content-Type: + description: | + The MIME type of the body of the response. + 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". + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualOnboardedVnfPackageArtifact.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests and the "include_signatures" request + URI parameter was not present in the related request, this response shall + be returned when a single consecutive byte range from the content of the + artifact file, if the NFVO supports range requests has been read successfully + according to the request. + 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: + required : true + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + Subscriptions.Post.201: + description: | + 201 CREATED + + Shall be returned when the subscription has been created successfully. + The response body shall contain a representation of the created "Individual subscription" resource. + The HTTP response shall include a "Location" HTTP header that points to the created resource. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: The resource URI of the created PM Job + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + + Subscriptions.Get.200: + description: | + 200 OK + + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain in an array the representations of all active + subscriptions of the functional block that invokes the method, i.e. zero or more + representations of VNF package management subscriptions as defined in clause 10.5.2.4. + If the "filter" URI parameter was supplied in the request, the data in the response + body shall have been transformed according to the rules specified in clause 5.2.2 + of ETSI GS NFV-SOL 013 + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + + IndividualSubscription.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual subscription has been read successfully. + The response body shall contain a representation of the "Individual subscription" resource. + headers: + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription" + + IndividualSubscription.Delete.204: + description: | + 204 NO CONTENT + + Shall be returned when the "Individual subscription" resource has been deleted successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml b/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml similarity index 90% rename from src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml rename to src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml index efb7f5c8f3a337ff46b070dd2e025fed039c6d4f..0b82df5cf9493b0b536a92457369a0b1556b056a 100644 --- a/src/SOL003/VNFPackageManagement/definitions/VNFPackageManagement_def.yaml +++ b/src/SOL003/VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml @@ -66,7 +66,8 @@ definitions: Checksum of the on-boarded VNF package. It shall be present after the VNF package content has been on-boarded and absent otherwise. - $ref: "#/definitions/Checksum" + Permitted hash algorithms are defined in ETSI GS NFV-SOL 004. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" packageSecurityOption: description: > Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004. @@ -127,6 +128,7 @@ definitions: Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" userDefinedData: description: > User defined data for the VNF package. @@ -227,7 +229,7 @@ definitions: VnfPackageSoftwareImageInfo: description: > - This type represents an artifact contained in a VNF package which + This type represents an artifact contained in or external to a VNF package which represents a software image. type: object required: @@ -243,7 +245,6 @@ definitions: - minDisk - minRam - size - - imagePath properties: id: description: > @@ -264,7 +265,8 @@ definitions: checksum: description: > Checksum of the software image file. - $ref: "#/definitions/Checksum" + Permitted hash algorithms are defined in ETSI GS NFV-SOL 004. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" isEncrypted: description: > Reflects whether the image is encrypted (true) or not (false). @@ -344,14 +346,38 @@ definitions: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" imagePath: description: > - Path in the VNF package, which identifies the image artifact and also + Path which identifies the image artifact and also allows to access a copy of the image artifact. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + For a software image contained as a file in the VNF + package, this attribute shall be present, and the value of + this attribute shall start with the name of the first segment + in the path in the package, i.e., it shall not be prefixed by + path separator characters such as "." and "/". + EXAMPLE: foo/bar/m%40ster.vhd + For an external software image represented as a URI in + the VNF descriptor, this attribute shall be present if the + image artifact has been downloaded by the NFVO and + shall be absent otherwise. If present, it shall contain the + artifactPath under which the image artifact can be + obtained using the "Individual artifact in a VNF package" + resource defined in clause 9.4.7. It is the responsibility of + the NFVO to synthesize this path in a manner that avoids + any collision of the synthesized artifact path with the + paths and names of image artifacts included in the + package. + type: string + imageUri: + description: > + URI of the image artifact as defined in the VNF package + manifest. Shall be present if the image artifact is external + to the VNF package and shall be absent otherwise. + EXAMPLE: https://example.com/m%40ster.vhd + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri" VnfPackageArtifactInfo: description: > This type represents an artifact other than a software image which is - contained in a VNF package. + contained in or external to a VNF package. type: object required: - artifactPath @@ -382,14 +408,6 @@ definitions: collision of the synthesized artifact path with the paths and names of artifacts included in the package. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - checksum: - description: > - Checksum of the artifact file. - $ref: "#/definitions/Checksum" - isEncrypted: - description: > - Reflects whether the artifact is encrypted (true) or not (false). - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" artifactURI: description: > URI of the artifact as defined in the VNF package manifest. @@ -400,6 +418,15 @@ definitions: type: array items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri" + checksum: + description: > + Checksum of the artifact file. + Permitted hash algorithms are defined in ETSI GS NFV-SOL 004. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the artifact is encrypted (true) or not (false). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" nonManoArtifactSetId: description: > Non-MANO artifact set identifier of the non-MANO artifact set to @@ -437,6 +464,14 @@ definitions: in the array matches (logical "or" between the values of one filter attribute). type: object + anyOf: + - oneOf: + - required: + - vnfProductsFromProviders + - required: + - vnfdId + - required: + - vnfPkgId properties: notificationTypes: description: > @@ -524,7 +559,7 @@ definitions: Match VNF packages with a package identifier listed in the attribute. May be present if the "notificationTypes" attribute contains the - value "VnfPackageChangeNotification", and shall be absent + value "VnfPackageChangeNotification" and shall be absent otherwise. The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId" are alternatives to reference to particular VNF packages in a @@ -537,14 +572,14 @@ definitions: description: > Match particular operational states of the VNF package. May be present if the "notificationTypes" attribute contains the - value "VnfPackageChangeNotification", and shall be absent + value "VnfPackageChangeNotification" and shall be absent otherwise. $ref: "#/definitions/PackageOperationalStateType" usageState: description: > Match particular usage states of the VNF package. May be present if the "notificationTypes" attribute contains the - value "VnfPackageChangeNotification", and shall be absent + value "VnfPackageChangeNotification" and shall be absent otherwise. $ref: "#/definitions/PackageUsageStateType" vnfmInfo: @@ -554,24 +589,6 @@ definitions: items: $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - Checksum: - description: > - This type represents the checksum of a VNF package or an artifact file. - type: object - required: - - algorithm - - hash - properties: - algorithm: - description: > - Name of the algorithm used to generate the checksum, as defined in - ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - hash: - description: > - The hexadecimal value of the checksum. - $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" - PackageOperationalStateType: description: > - ENABLED: The VNF package is enabled, i.e. it can be used for @@ -586,9 +603,8 @@ definitions: PackageUsageStateType: description: > - - IN_USE: VNF instances instantiated from this VNF package exist. - - NOT_IN_USE: No existing VNF instance is instantiated from this VNF - package. + - IN_USE: "Individual VNF instance" resources created from this VNF package exist. + - NOT_IN_USE: No "Individual VNF instance" resource created from this VNF package exists. type: string enum: - IN_USE diff --git a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index 664b2b156711cf05029fabcd0c13c2e4943d6c8f..dc1be09b2933677ed50770c4a4a3b8dbf4719064 100644 --- a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -1,305 +1,261 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Package Management Notification interface - description: > + description: | SOL003 - VNF Package Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/callback/v2" - -schemes: - - https + description: ETSI GS NFV-SOL 002 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/callback/v2 + - url: https://127.0.0.1/callback/v2 paths: ############################################################################### # Notification endpoint VnfPackageOnboardingNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification: #SOL003 location: 10.4.9 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: VnfPackageOnboardingNotification - description: A notification about on-boarding of a VNF package. - in: body - required: true - schema: - $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfPackageOnboardingNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/VnfPackageOnboardingNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer - e.g. during subscription. + description: | + The GET method allows the API producer to test the notification endpoint that is provided by + the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VnfPackageOnboardingNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint VnfPackageChangeNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification: #SOL003 location: 10.4.9 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have previously created an "Individual subscription" resource with a matching filter. This method shall follow the provisions specified in the tables 10.4.9.3.1-1 and 10.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: VnfPackageChangeNotification - description: > - A notification about changes of status in a VNF package. - in: body - required: true - schema: - $ref: "definitions/VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VnfPackageChangeNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/VnfPackageChangeNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer - e.g. during subscription. + description: | + The GET method allows the API producer to test the notification endpoint that is provided by + the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 10.4.9.3.2-1 and 10.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/VnfPackageChangeNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + +components: + requestBodies: + + VnfPackageOnboardingNotification: + description: A notification about on-boarding of a VNF package. + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification" + required: true + + VnfPackageChangeNotification: + description: | + A notification about changes of status in a VNF package.= + content: + application/json: + schema: + $ref: "definitions/SOL003VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification" + required: true + + responses: + + VnfPackageOnboardingNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + VnfPackageOnboardingNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + VnfPackageChangeNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + VnfPackageChangeNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string diff --git a/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml b/src/SOL003/VNFPackageManagementNotification/definitions/SOL003VNFPackageManagementNotification_def.yaml similarity index 95% rename from src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml rename to src/SOL003/VNFPackageManagementNotification/definitions/SOL003VNFPackageManagementNotification_def.yaml index 52d66fe316ae85d6dad8aa888026ba6359edc6fd..c78f7e22715f6bc932bee1da6115f4c75236af0c 100644 --- a/src/SOL003/VNFPackageManagementNotification/definitions/VNFPackageManagementNotification_def.yaml +++ b/src/SOL003/VNFPackageManagementNotification/definitions/SOL003VNFPackageManagementNotification_def.yaml @@ -134,7 +134,7 @@ definitions: description: > New operational state of the VNF package. Only present when changeType is OP_STATE_CHANGE. - $ref: "../../VNFPackageManagement/definitions/VNFPackageManagement_def.yaml#/definitions/PackageOperationalStateType" + $ref: "../../VNFPackageManagement/definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PackageOperationalStateType" _links: description: > Links to resources related to this notification. @@ -161,7 +161,7 @@ definitions: vnfPackage: description: > Link to the resource representing the VNF package to which the - notified change applies, i.e. the individual on-boarded VNF package + notified change applies, i.e. the "Individual on-boarded VNF package" resource that represents the VNF package, identified by the "vnfPkgId" identifier which is managed by the NFVO. This attribute shall be provided by the NFVO but is deprecated and can be removed in future versions @@ -170,7 +170,7 @@ definitions: vnfPackageByVnfdId: description: > Link to the resource representing the VNF package to which the notified - change applies, i.e. the individual VNF package resource that represents + change applies, i.e. the "Individual VNF package resource" that represents the VNF package, identified by the "vnfdId" identifier which is assigned by the VNF vendor. $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/NotificationLink" diff --git a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 5439f47e85f22aaea447551a7acace3ce89675b8..5d65b7932af2f5dd51e637678550a97f60913e98 100644 --- a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -1,57 +1,49 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Performance Management interface - description: > + description: | SOL003 - VNF Performance Management interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -basePath: "/vnfpm/v2" +servers: + - url: http://127.0.0.1/vnfpm/v2 + - url: https://127.0.0.1/vnfpm/v2 -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" paths: ############################################################################### # API Versions # ############################################################################### - '/api-versions': + /api-versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # PM jobs # ############################################################################### - '/pm_jobs': + /pm_jobs: #SOL003 location: 6.4.2 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Create PM Job. The POST method creates a PM job. This method shall follow the provisions specified in the tables 6.4.2.3.1-1 and 6.4.2.3.1-2 @@ -59,576 +51,227 @@ paths: As the result of successfully executing this method, a new "Individual PM job" resource as defined in clause 6.4.3 shall have been created. parameters: - - name: CreatePmJobRequest - description: The VNF creation parameters - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest" - - name: Accept - description: > - Content-Types that are acceptable for the response. - Reference: IETF RFC 7231 - in: header - required: true - 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: 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/CreatePmJobRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the PM job has been created successfully. - The response body shall contain a representation of the created "Individual PM job" resource, - as defined in clause 6.5.2.7. - The HTTP response shall include a "Location" HTTP header that points to the created - "Individual PM job" resource. - headers: - Location: - description: The resource URI of the created PM Job - 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: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + $ref: '#/components/responses/PMJobs.Post.201' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query PM Job. The API consumer can use this method to retrieve information about PM jobs. This method shall follow the provisions specified in the tables 6.4.2.3.2-1 and 6.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes. The API consumer can use this method to retrieve information about PM jobs. 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the PmJob and in data - types referenced from it shall be supported by the VNFM in the - filter expression. - in: query - required: false - type: string - - name: all_fields - description: > - Include all complex attributes in the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - in: query - required: false - type: string - - name: fields - description: > - Complex attributes to be included into the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_fields - description: > - Complex attributes to be excluded from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter. - in: query - required: false - type: string - - name: exclude_default - description: > - Indicates to exclude the following complex attributes from the response. - See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter. - The following attributes shall be excluded from the PmJob structure - in the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: - - reports - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be supported by the - VNFM if the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more PM jobs has been queried successfully. - The response body shall contain in an array the representations of zero or more PM jobs, - as defined in clause 6.5.2.7. - If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" - (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the - response body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 - of ETSI GS NFV-SOL 013, respectively. - If the VNFM supports alternative 2 (paging) according to clause 5.4..2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + $ref: '#/components/responses/PMJobs.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual PM job # ############################################################################### - '/pm_jobs/{pmJobId}': + /pm_jobs/{pmJobId}: #SOL003 location: 6.4.3 parameters: - - name: pmJobId - description: > - Identifier of the PM job. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual PM job" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/PmJobId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query PM Job. The API consumer can use this method for reading an individual PM job. This method shall follow the provisions specified in the tables 6.4.3.3.2-1 and 6.4.3.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual PM job has been read successfully. - The response body shall contain a representation of the "Individual PM job" resource, - as defined in clause 6.5.2.7. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + $ref: '#/components/responses/IndividualPMJob.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" patch: - description: > - This method allows to modify an "individual PM job" resource. + description: | + This method allows to modify an "Individual PM job" resource. This method shall follow the provisions specified in the tables 6.4.3.3.4-1 and 6.4.3.3.4-2 for URI query parameters, request and response data structures, and response codes. - 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: 200: - description: > - 200 OK - - Shall be returned when the request has been processed successfully. - The response body shall contain a data structure of type "PmJobModifications". - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications" + $ref: '#/components/responses/IndividualPMJob.Patch.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: - description: > + description: | Delete PM Job. This method terminates an individual PM job. This method shall follow the provisions specified in the tables 6.4.3.3.5-1 and 6.4.3.3.5-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, the "Individual PM job" resource shall not exist any longer. - 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: > - 204 NO CONTENT - - Shall be returned when the PM job has been deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualPMJob.Delete.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual performance report # ############################################################################### - '/pm_jobs/{pmJobId}/reports/{reportId}': + /pm_jobs/{pmJobId}/reports/{reportId}: #SOL003 location: 6.4.4 parameters: - - name: pmJobId - description: > - Identifier of the PM job. - in: path - type: string - required: true - - name: reportId - description: > - Identifier of the performance report. - in: path - type: string - required: true + - $ref: '#/components/parameters/PmJobId' + - $ref: '#/components/parameters/ReportId' get: - description: > + description: | The API consumer can use this method for reading an individual performance report. This method shall follow the provisions specified in the tables 6.4.4.3.2-1 and 6.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version responses: 200: - description: > - 200 OK - - Shall be returned when information of an individual performance report has been read successfully. - The response body shall contain a representation of the "Individual performance report" resource, - as defined in clause 6.5.2.10. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport" + $ref: '#/components/responses/IndividualPerformanceReport.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Thresholds # ############################################################################### - '/thresholds': + /thresholds: #SOL003 location: 6.4.5 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Create Threshold. The POST method can be used by the API consumer to create a threshold. This method shall follow the provisions specified in the tables 6.4.5.3.1-1 and 6.4.5.3.1-2 @@ -636,448 +279,170 @@ paths: As the result of successfully executing this method, a new "Individual threshold" resource as defined in clause 6.4.6 shall have been created. parameters: - - name: CreateThresholdRequest - description: > - Request parameters to create a threshold resource. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/CreateThresholdRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when a threshold has been created successfully. - The response body shall contain a representation of the created "Individual threshold" resource, - as defined in clause 6.5.2.9. - The HTTP response shall include a "Location" HTTP header that contains the resource URI of the - created threshold resource. - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + $ref: '#/components/responses/Thresholds.Post.201' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query Threshold. The API consumer can use this method to query information about thresholds. This method shall follow the provisions specified in the tables 6.4.5.3.2-1 and 6.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. - 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: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. - The VNFM shall support receiving this parameter as part of the URI query string. - The NFVO may supply this parameter. - All attribute names that appear in the Thresholds data type and in data types referenced - from it shall be supported by the VNFM in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. - Shall be supported by the VNFM if the VNFM supports alternative 2 (paging) according to clause - 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when information about zero or more thresholds has been queried successfully. - If the "filter" URI parameter was supplied in the request, the data in the response body shall have - been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - The response body shall contain in an array the representations of zero or more thresholds, - as defined in clause 6.5.2.9. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - - headers: - Location: - description: The resource URI of the created VNF instance - type: string - format: url - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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 - 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 - schema: - type: array - items: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + $ref: '#/components/responses/Thresholds.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual threshold # ############################################################################### - '/thresholds/{thresholdId}': + /thresholds/{thresholdId}: #SOL003 location: 6.4.6 parameters: - - name: thresholdId - description: > - Identifier of the threshold. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual threshold" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/ThresholdId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version get: - description: > + description: | Query Threshold. The API consumer can use this method for reading an individual threshold This method shall follow the provisions specified in the tables 6.4.6.3.2-1 and 6.4.6.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. - 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: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual threshold has been read successfully. - The response body shall contain a representation of the threshold, as defined in clause 6.5.2.9. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + $ref: '#/components/responses/IndividualThreshold.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" patch: - description: > + description: | This method allows to modify an "Individual threshold" resource. This method shall follow the provisions specified in the tables 6.4.6.3.4-1 and 6.4.6.3.4-2 for URI query parameters, request and response data structures, and response codes. - 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: 200: - description: > - 200 OK - - Shall be returned when the request has been processed successfully. - The response body shall contain a data structure of type "ThresholdModifications". - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - 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/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications" + $ref: '#/components/responses/IndividualThreshold.Patch.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 412: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/412" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: - description: > + description: | Delete Threshold. This method allows to delete a threshold. This method shall follow the provisions specified in the tables 6.4.6.3.5-1 and 6.4.6.3.5-2 for URI query parameters, request and response data structures, and response codes. As the result of successfully executing this method, the "Individual threshold" resource shall not exist any longer. - 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: > - 204 NO CONTENT - - The threshold was deleted successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/IndividualThreshold.Delete.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" # ############################################################################## # # Subscriptions # @@ -1085,7 +450,7 @@ paths: # '/subscriptions': # #SOL003 location: 6.4.7 # post: -# description: > +# description: | # Subscribe. # The POST method creates a new subscription. # This method shall follow the provisions specified in the tables 6.4.7.3.1-1 and 6.4.7.3.1-2 @@ -1102,42 +467,42 @@ paths: # with the same filter and callbackUri). # parameters: # - name: PmSubscriptionRequest -# description: > +# description: | # Details of the subscription to be created. # in: body # required: true # schema: # $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscriptionRequest" # - name: Accept -# description: > +# description: | # Content-Types that are acceptable for the response. # Reference: IETF RFC 7231 # in: header # required: true # type: string # - name: Authorization -# description: > +# description: | # The authorization token for the request. # Reference: IETF RFC 7235 # in: header # required: false # type: string # - name: Content-Type -# description: > +# description: | # The MIME type of the body of the request. # Reference: IETF RFC 7231 # in: header # required: true # type: string # - name: Version -# description: > +# description: | # Version of the API requested to use when responding to this request. # in: header # required: true # type: string # responses: # 201: -# description: > +# description: | # 201 CREATED # # Shall be returned when the subscription has been created successfully. @@ -1151,14 +516,14 @@ paths: # type: string # format: url # Content-Type: -# description: > +# description: | # The MIME type of the body of the request. # Reference: IETF RFC 7231 # type: string # maximum: 1 # minimum: 1 # WWW-Authenticate: -# description: > +# 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. @@ -1166,7 +531,7 @@ paths: # maximum: 1 # minimum: 0 # Version: -# description: > +# description: | # Version of the API used in the response. # type: string # maximum: 1 @@ -1174,30 +539,30 @@ paths: # schema: # $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" # 303: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303" # 400: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" # 401: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" # 403: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" # 404: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" # 405: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" # 406: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" # 422: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" # 500: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" # 503: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" # 504: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" # # get: -# description: > +# description: | # Query Subscription Information. # TThe client can use this method to query the list of active subscriptions # to Performance management notifications subscribed by the client. @@ -1205,21 +570,21 @@ paths: # for URI query parameters, request and response data structures, and response codes. # parameters: # - name: Accept -# description: > +# description: | # Content-Types that are acceptable for the response. # Reference: IETF RFC 7231 # in: header # required: true # type: string # - name: Authorization -# description: > +# description: | # The authorization token for the request. # Reference: IETF RFC 7235 # in: header # required: false # type: string # - name: filter -# description: > +# description: | # Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. # The VNFM shall support receiving this parameter as part of the # URI query string. The NFVO may supply this parameter. @@ -1230,7 +595,7 @@ paths: # required: false # type: string # - name: nextpage_opaque_marker -# description: > +# description: | # Marker to obtain the next page of a paged response. Shall be # supported by the VNFM if the VNFM supports alternative 2 (paging) # according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. @@ -1238,14 +603,14 @@ paths: # required: false # type: string # - name: Version -# description: > +# description: | # Version of the API requested to use when responding to this request. # in: header # required: true # type: string # responses: # 200: -# description: > +# description: | # 200 OK # # Shall be returned when the list of subscriptions has been queried successfully. @@ -1259,14 +624,14 @@ paths: # in clause 5.4.2.3 of ETSI GS NFV-SOL 013. # headers: # Content-Type: -# description: > +# description: | # The MIME type of the body of the request. # Reference: IETF RFC 7231 # type: string # maximum: 1 # minimum: 1 # WWW-Authenticate: -# description: > +# 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. @@ -1274,13 +639,13 @@ paths: # maximum: 1 # minimum: 0 # Version: -# description: > +# description: | # Version of the API used in the response. # type: string # maximum: 1 # minimum: 1 # Link: -# description: > +# description: | # Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. # type: string # maximum: 1 @@ -1290,25 +655,25 @@ paths: # items: # $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" # 400: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" # 401: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" # 403: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" # 404: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" # 405: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" # 406: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" # 422: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" # 500: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" # 503: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" # 504: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" # # ############################################################################### # # Individual subscription # @@ -1317,7 +682,7 @@ paths: # #SOL003 location: 6.4.8 # parameters: # - name: subscriptionId -# description: > +# description: | # This identifier can be retrieved from the resource referenced by the # "Location" HTTP header in the response to a POST request creating a # new "Individual subscription" resource. It can also be retrieved from the "id" @@ -1326,7 +691,7 @@ paths: # type: string # required: true # get: -# description: > +# description: | # Query Subscription Information. # The client can use this method for reading an individual subscription about # Performance management notifications subscribed by the client. @@ -1334,28 +699,28 @@ paths: # for URI query parameters, request and response data structures, and response codes. # parameters: # - name: Accept -# description: > +# description: | # Content-Types that are acceptable for the response. # Reference: IETF RFC 7231 # in: header # required: true # type: string # - name: Authorization -# description: > +# description: | # The authorization token for the request. # Reference: IETF RFC 7235 # in: header # required: false # type: string # - name: Version -# description: > +# description: | # Version of the API requested to use when responding to this request. # in: header # required: true # type: string # responses: # 200: -# description: > +# description: | # 200 OK # # Shall be returned when the subscription has been read successfully. @@ -1363,14 +728,14 @@ paths: # as defined in clause 6.5.2.3. # headers: # Content-Type: -# description: > +# description: | # The MIME type of the body of the request. # Reference: IETF RFC 7231 # type: string # maximum: 1 # minimum: 1 # WWW-Authenticate: -# description: > +# 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. @@ -1378,7 +743,7 @@ paths: # maximum: 1 # minimum: 0 # Version: -# description: > +# description: | # Version of the API used in the response. # type: string # maximum: 1 @@ -1386,28 +751,28 @@ paths: # schema: # $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" # 400: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" # 401: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" # 403: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" # 404: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" # 405: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" # 406: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" # 422: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" # 500: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" # 503: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" # 504: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" # # delete: -# description: > +# description: | # Terminate Subscription. # This method terminates an individual subscription. # This method shall follow the provisions specified in the tables 6.4.8.3.5-1 and 6.4.8.3.5-2 @@ -1420,28 +785,28 @@ paths: # API consumer for a certain time period after the deletion. # parameters: # - name: Authorization -# description: > +# description: | # The authorization token for the request. # Reference: IETF RFC 7235 # in: header # required: false # type: string # - name: Version -# description: > +# description: | # Version of the API requested to use when responding to this request. # in: header # required: true # type: string # responses: # 204: -# description: > +# description: | # 204 NO CONTENT # # Shall be returned when the "Individual subscription" resource has been deleted successfully. # The response body shall be empty. # headers: # WWW-Authenticate: -# description: > +# 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. @@ -1449,28 +814,485 @@ paths: # maximum: 1 # minimum: 0 # Version: -# description: > +# description: | # Version of the API used in the response. # type: string # maximum: 1 # minimum: 1 # 400: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" # 401: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" # 403: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" # 404: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" # 405: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" # 406: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" # 422: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" # 500: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" # 503: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" # 504: -# $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file +# $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + +components: + parameters: + PmJobId: + name: pmJobId + in: path + description: | + Identifier of the PM job. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual PM job" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + ReportId: + name: reportId + in: path + description: | + Identifier of the performance report. + required: true + style: simple + explode: false + schema: + type: string + + ThresholdId: + name: thresholdId + in: path + description: | + Identifier of the threshold. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual threshold" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + CreatePmJobRequest: + description: The VNF creation parameters + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreatePmJobRequest" + required: true + + CreateThresholdRequest: + description: Request parameters to create a threshold resource. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/CreateThresholdRequest" + required: true + + responses: + PMJobs.Post.201: + description: | + 201 CREATED + + Shall be returned when the PM job has been created successfully. + The response body shall contain a representation of the created "Individual PM job" resource, + as defined in clause 6.5.2.7. + The HTTP response shall include a "Location" HTTP header that points to the created + "Individual PM job" resource. + headers: + Location: + description: The resource URI of the created PM Job + style: simple + explode: false + schema: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + + PMJobs.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more PM jobs has been queried successfully. + The response body shall contain in an array the representations of zero or more PM jobs, + as defined in clause 6.5.2.7. + If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" + (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the + response body shall have been transformed according to the rules specified in clauses 5.2.2 and 5.3.2 + of ETSI GS NFV-SOL 013, respectively. + If the VNFM supports alternative 2 (paging) according to clause 5.4..2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + + IndividualPMJob.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual PM job has been read successfully. + The response body shall contain a representation of the "Individual PM job" resource, + as defined in clause 6.5.2.7. + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJob" + + IndividualPMJob.Patch.200: + description: | + 200 OK + + Shall be returned when the request has been processed successfully. + The response body shall contain a data structure of type "PmJobModifications". + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmJobModifications" + + IndividualPMJob.Delete.200: + description: | + 204 NO CONTENT + + Shall be returned when the PM job has been deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + + IndividualPerformanceReport.Get.200: + description: | + 200 OK + + Shall be returned when information of an individual performance report has been read successfully. + The response body shall contain a representation of the "Individual performance report" resource, + as defined in clause 6.5.2.10. + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceReport" + + Thresholds.Post.201: + description: | + 201 CREATED + + Shall be returned when a threshold has been created successfully. + The response body shall contain a representation of the created "Individual threshold" resource, + as defined in clause 6.5.2.9. + The HTTP response shall include a "Location" HTTP header that contains the resource URI of the + created threshold resource. + headers: + Location: + description: TThe resource URI of the created VNF instance + style: simple + explode: false + schema: + type: string + format: url + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + + Thresholds.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more thresholds has been queried successfully. + If the "filter" URI parameter was supplied in the request, the data in the response body shall have + been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + The response body shall contain in an array the representations of zero or more thresholds, + as defined in clause 6.5.2.9. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Location: + description: The resource URI of the created VNF instance + style: simple + explode: false + schema: + type: string + format: url + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + + IndividualThreshold.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual threshold has been read successfully. + The response body shall contain a representation of the threshold, as defined in clause 6.5.2.9. + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/Threshold" + + IndividualThreshold.Patch.200: + description: | + 200 OK + + Shall be returned when the request has been processed successfully. + The response body shall contain a data structure of type "ThresholdModifications". + headers: + Content-Type: + description: | + The MIME type of the body of the response. Reference: IETF RFC 7231 + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdModifications" + + IndividualThreshold.Delete.200: + description: | + 204 NO CONTENT + + The threshold was deleted successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index c6be960ac619ebcea3d713c29cff8c69f3b0baeb..3d2f7303e6a506b28a8194b4d54ec880c51de7ad 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -1,51 +1,41 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - VNF Performance Management Notification interface - description: > + description: | SOL003 - VNF Performance Management Notification interface - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 2.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf - -basePath: "/callback/v2" - -schemes: - - https + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/callback/v2 + - url: https://127.0.0.1/callback/v2 paths: ############################################################################### # Notification endpoint PerformanceInformationAvailableNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-PerformanceInformationAvailableNotification: #SOL003 location: 6.4.9 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification regarding a performance management event from the API producer to an API consumer. @@ -53,133 +43,61 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: PerformanceInformationAvailableNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/PerformanceInformationAvailableNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/PerformanceInformationAvailableNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer, - e.g. during the creation of the PM job or threshold resource. + description: | + The GET method allows the API producer to test the notification endpoint that is provided + by the API consumer, e.g. during the creation of the PM job or threshold resource. This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/PerformanceInformationAvailableNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" ############################################################################### # Notification endpoint ThresholdCrossedNotification # ############################################################################### - '/URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification': + /URI-is-provided-by-the-client-when-creating-the-subscription-ThresholdCrossedNotification: #SOL003 location: 6.4.9 + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version post: - description: > + description: | Notify. The POST method delivers a notification regarding a performance management event from the API producer to an API consumer. @@ -187,122 +105,158 @@ paths: This method shall follow the provisions specified in the tables 6.4.9.3.1-1 and 6.4.9.3.1-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: ThresholdCrossedNotification - description: > - Notification about performance information availability. - in: body - required: true - schema: - $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" - - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/ThresholdCrossedNotification' responses: 204: - description: > - 204 NO CONTENT - - Shall be returned when the notification has been delivered successfully. - headers: - 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 + $ref: '#/components/responses/ThresholdCrossedNotification.Post.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" get: - description: > - The GET method allows the server to test the notification endpoint that is provided by the API consumer - e.g. during subscription. + description: | + The GET method allows the API producer to test the notification endpoint that is provided + by the API consumer e.g. during subscription. This method shall follow the provisions specified in the tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters, request and response data structures, and response codes. - 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: > - 204 NO CONTENT - - Shall be returned to indicate that the notification endpoint has been tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/ThresholdCrossedNotification.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" + +components: + requestBodies: + PerformanceInformationAvailableNotification: + description: | + Notification about performance information availability. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification" + required: true + + ThresholdCrossedNotification: + description: | + Notification about performance information availability. + content: + application/json: + schema: + $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/ThresholdCrossedNotification" + required: true + + responses: + PerformanceInformationAvailableNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + PerformanceInformationAvailableNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + ThresholdCrossedNotification.Post.204: + description: | + 204 NO CONTENT + + Shall be returned when the notification has been delivered successfully. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string + + ThresholdCrossedNotification.Get.204: + description: | + 204 NO CONTENT + + Shall be returned to indicate that the notification endpoint has been tested successfully. + The response body shall be empty. + headers: + 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. + style: simple + explode: false + schema: + type: string + Version: + description: | + Version of the API used in the response. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml b/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml new file mode 100644 index 0000000000000000000000000000000000000000..76307edf05319c8a1518a107f695680e012a5443 --- /dev/null +++ b/src/SOL003/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml @@ -0,0 +1,496 @@ +openapi: 3.0.2 + +info: + title: SOL003 - VNF Snapshot Package Management interface + description: | + SOL003 - VNF Snapshot Package Management interface + + IMPORTANT: Please note that this file might be not aligned to the current + version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. + In case of discrepancies the published ETSI Group Specification takes precedence. + + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG + license: + name: ETSI Forge copyright notice + url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + +externalDocs: + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf + +servers: + - url: http://0.0.0.1/vnfsnapshotpkgm/v1 + - url: https://0.0.0.1/vnfsnapshotpkgm/v1 + +paths: + ############################################################################### + # API Versions # + ############################################################################### + /api_versions: + $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' + + /vnf_snapshot_packages: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + get: + description: | + The GET method queries the information of the VNF packages matching the filter. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + 200: + $ref: '#/components/responses/VNFSnapshotPackages.Get.200' + 400: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + 401: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + 403: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + 404: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + 405: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + 406: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + 416: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + 422: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + 429: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + 500: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + 503: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + 504: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_snapshot_packages/{vnfSnapshotPkgId}: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/VnfSnapshotPkgId' + get: + description: | + The GET method reads the information of an individual VNF snapshot package. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker + responses: + 200: + $ref: '#/components/responses/IndividualVNFSnapshotPackages.Get.200' + 400: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + 401: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + 403: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + 404: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + 405: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + 406: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + 416: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + 422: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + 429: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + 500: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + 503: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + 504: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_snapshot_packages/{vnfSnapshotPkgId}/package_content: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/VnfSnapshotPkgId' + get: + description: | + The GET method fetches the content of a VNF snapshot package. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + responses: + 200: + $ref: '#/components/responses/PackageContent.Get.200' + 206: + $ref: '#/components/responses/PackageContent.Get.206' + 400: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + 401: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + 403: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + 404: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + 405: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + 406: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + 409: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + 416: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + 422: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + 429: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + 500: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + 503: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + 504: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + + /vnf_snapshot_packages/{vnfSnapshotPkgId}/artifacts/{artifactPath}: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization + - $ref: '#/components/parameters/VnfSnapshotPkgId' + - $ref: '#/components/parameters/ArtifactPath' + get: + description: | + The GET method fetches the content of an artifact within the VNF snapshot package. + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + responses: + 200: + $ref: '#/components/responses/IndividualArtifact.Get.200' + 206: + $ref: '#/components/responses/IndividualArtifact.Get.206' + 400: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400 + 401: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401 + 403: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403 + 404: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404 + 405: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405 + 406: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406 + 409: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409 + 416: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416 + 422: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422 + 429: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429 + 500: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500 + 503: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503 + 504: + $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504 + +components: + parameters: + VnfSnapshotPkgId: + name: vnfSnapshotPkgId + in: path + description: | + Identifier of the VNF snapshot package. The identifier is allocated by the NFVO. + This identifier can be retrieved from the "id" attribute of the applicable "VnfSnapshotPkgInfo" in the body of + the response to requesting the creation of a new "Individual VNF snapshot package" resource or in a response to + a GET request querying the "Individual VNF snapshot package" or the "VNF snapshot packages" resource. + required: true + style: simple + explode: false + schema: + type: string + + ArtifactPath: + name: artifactPath + in: path + description: | + For an artifact contained as a file in the VNF snapshot package, this variable shall contain a sequence + of one or path segments representing the path of the artifact within the VNF snapshot package, relative + to the root of the package. + + EXAMPLE: foo/bar/m%40ster.sh + + For an external artifact represented as a URI in the VNF snapshot package manifest, this variable shall + contain a sequence of one or more path segments as synthesized by the NFVO (see clause 12.5.3.3) representing + this artifact. + + 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 snapshot package" or the + "VNF snapshot packages" resource. + + Since multiple path segments are allowed to be contained in this variable, the "/" character that separates + these segments is not percent-encoded. Each individual segment is percent-encoded if necessary as defined + in clause 4.1 of ETSI GS NFV-SOL 013. + required: true + style: simple + explode: false + schema: + type: string + + responses: + VNFSnapshotPackages.Get.200: + description: | + 200 OK + + Shall be returned when information about zero or more VNF snapshot packages has been queried successfully. + + The response body shall contain in an array the VNF snapshot package info representations that match the + attribute filter, i.e. zero or more VNF snapshot package info representations as defined in clause 12.5.2.2. + + If the "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or "exclude_default" + URI parameters was supplied in the request and is supported, the data in the response body shall have been + transformed according to the rules specified in clauses 5.2.2 and 5.3.2 of ETSI GS NFV-SOL 013, respectively. + + If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this + resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 + of ETSI GS NFV-SOL 013. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: definitions/SOL003VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo + + IndividualVNFSnapshotPackages.Get.200: + description: | + 200 OK + + Shall be returned when information of the VNF snapshot package has been read successfully. + + The response body shall contain the VNF snapshot package info representation defined in clause 12.5.2.2. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: definitions/SOL003VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgInfo + + PackageContent.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the VNF snapshot package file has been read successfully. + + The response body shall include a copy of the VNF snapshot package file. + + The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to "application/zip" + for a VNF snapshot package. The VNF snapshot package format is defined in ETSI GS NFV-SOL 010. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/*: + schema: + type: string + format: binary + + PackageContent.Get.206: + description: | + 206 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned when a single consecutive byte range + from the content of the VNF snapshot package file has been read successfully according to the request. + + The response body shall contain the requested part of the VNF snapshot 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: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Content-Range: + description: > + The Content-Range response HTTP header indicates where in a full body message a partial message belongs. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/*: + schema: + type: string + format: binary + + IndividualArtifact.Get.200: + description: | + 200 OK + + Shall be returned when the whole content of the artifact file has been read successfully. + + The response body shall include a copy of the artifact file from the VNF snapshot package. + The VNF snapshot package format is defined in ETSI GS NFV-SOL 010. + + 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: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/*: + schema: + type: string + format: binary + + IndividualArtifact.Get.206: + description: | + 2006 PARTIAL CONTENT + + If the NFVO supports range requests, this response shall be returned when a single consecutive byte range + from the content of the artifact file has been read successfully according to the request. + + The response body shall contain the requested part of the artifact file from the VNF snapshot package. + The VNF snapshot package is defined in ETSI GS NFV-SOL 010. + + 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". + + The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + headers: + Version: + description: The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Content-Range: + description: > + The Content-Range response HTTP header indicates where in a full body message a partial message belongs. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/*: + schema: + type: string + format: binary \ No newline at end of file diff --git a/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml b/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml new file mode 100644 index 0000000000000000000000000000000000000000..15ef041f0fd056d9829695db39fdb95d3b0f6c1d --- /dev/null +++ b/src/SOL003/VNFSnapshotPackageManagement/definitions/SOL003VNFSnapshotPackageManagement_def.yaml @@ -0,0 +1,438 @@ +# Copyright (c) ETSI 2017. +# https://forge.etsi.org/etsi-forge-copyright-notice.txt + +definitions: + VnfSnapshotPkgInfo: + description: > + This type represents the information of a VNF snapshot package. + type: object + required: + - id + - name + - isFullSnapshot + - state + - isCancelPending + - _links + properties: + id: + description: > + Identifier of the VNF snapshot packageinformation held by the NFVO. This identifier + is allocated by the NFVO. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfSnapshotPkgUniqueId: + description: > + Identifier of the VNF snapshot package, which identifies the VNF snapshot package in + a globally unique way. It is created during the "build VNF snapshot package operation". + Multiples instances of the same VNF snapshot package share the same vnfSnapshotPkgUniqueId. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + name: + description: > + Human-readable name of the VNF snapshot package. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + checksum: + description: > + Checksum of the stored VNF snapshot package. Hash algorithms applicable to VNF + snapshot packages are defined in ETSI GS NFV-SOL 010. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + createdAt: + description: > + Timestamp indicating when the VNF snapshot package creation has been completed. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + vnfSnapshotId: + description: > + Identifier of specific VNF snapshot in the VNF snapshot package. + This identifier is allocated by the VNFM during the VNF snapshot creation. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfcSnapshotInfoIds: + description: > + Identifiers of information held by the VNFM about specific VNFC snapshots part + of the VNF snapshot and contained in the VNF snapshot package. This identifier + is allocated by the VNFM during the VNF snapshot creation. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + type: object + items: + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + isFullSnapshot: + description: > + Value is TRUE in case of a "full" VNF snapshot package, i.e., containing all snapshotted + VNFC instances; otherwise the value is FALSE. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + vnfdInfo: + description: > + VNFD of the snapshotted VNF instance that is contained in the stored VNF snapshot package. + $ref: "#/definitions/VnfdInfo" + vnfsr: + description: > + VNF snapshot record with the information as present in the representation of the + "Individual VNF snapshot" resource. + $ref: "#/definitions/VnfSnapshotRecord" + vnfcSnapshotImages: + description: > + Information about VNF snapshot artifacts that are VNFC snapshot images. Every local and + external snapshot image shall be included. No other artifacts shall be included. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + type: object + items: + $ref: "#/definitions/VnfcSnapshotImageInfo" + additionalArtifacts: + description: > + Information about VNF snapshot artifacts that are not VNFC snapshot images. + + NOTE: The attribute shall not be present before the VNF snapshot package content + has been uploaded or built. Otherwise, this attribute shall be present unless it + has been requested to be excluded per attribute selector. + type: object + items: + $ref: "#/definitions/SnapshotPkgArtifactInfo" + state: + description: > + State of the VNF snapshot package. + Permitted values: + - CREATED: the VNF snapshot package information has been created. + - BUILDING: the VNF snapshot package is being built. + - UPLOADING: the VNF snapshot package is being uploaded. + - EXTRACTING: the VNF snapshot package’s content is being extracted. + - AVAILABLE: the VNF snapshot package is available (i.e., build or upload is completed). + - ERROR: failure during the VNF snapshot package building, uploading or processing. + - ERROR_EXTRACTING: failure during the VNF snapshot package extraction task. + type: string + enum: + - CREATED + - BUILDING + - UPLOADING + - EXTRACTING + - AVAILABLE + - ERROR + - ERROR_EXTRACTING + isCancelPending: + description: > + Indicates if an ongoing operation with the content of the VNF snapshot package is being + cancelled. If the value of the "state" attribute is "BUILDING", "UPLOADING", "PROCESSING" + or "EXTRACTING" and the operation is being cancelled, this attribute shall be set to true. + Otherwise, it shall be set to false. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + failureDetails: + description: > + Failure details associated to current error state of the VNF snapshot package state. + If "state" is "ERROR" or "ERROR_EXTRACTING", this attribute shall be present unless + it has been requested to be excluded via an attribute selector. + type: object + required: + - errorType + - details + properties: + errorType: + description: > + Type of error, when the failure happened (building, upload, processing, extracting). + + Permitted values: + - BUILD_ERROR + - UPLOAD_ERROR + - PROCESS_ERROR + - CANCELLED + - EXTRACTION_ERROR + type: string + enum: + - BUILD_ERROR + - UPLOAD_ERROR + - PROCESS_ERROR + - CANCELLED + - EXTRACTION_ERROR + details: + description: > + Failure details containing error information (such as failed uploading or processing + operation, affected artifact, reason for cancellation, etc.). See clause 6.3 of + ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + userDefinedData: + description: > + User defined data for the VNF snapshot package to be built/uploaded. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + _links: + description: > + Links to resources related to this resource. + type: object + required: + - self + - packageContent + properties: + self: + description: > + URI of this resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + packageContent: + description: > + Link to the "VNF snapshot package content" resource. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link" + + VnfcSnapshotImageInfo: + description: > + This type represents an artifact contained in a VNF snapshot package which + represents a snapshot image. + type: object + required: + - id + - name + - checksum + - isEncrypted + - vnfcInstanceId + - containerFormat + - diskFormat + - createdAt + - minDisk + - minRam + - size + properties: + id: + description: > + Identifier of the VNFC snapshot image. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierLocal" + name: + description: > + Name of the VNFC snapshot image. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + checksum: + description: > + Checksum of the snapshot image file. Hash algorithms applicable to VNF + snapshot package artifacts are defined in ETSI GS NFV-SOL 010. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the artifact is encrypted (true) or not (false). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + vnfcInstanceId: + description: > + Identifier of the snapshotted VNFC instance that this snapshot image belongs to. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + containerFormat: + description: > + Container format indicates whether the snapshot image is in a file format that + also contains metadata about the actual snapshot. + + Permitted values: + - AKI: a kernel image format + - AMI: a machine image format + - ARI: a ramdisk image format + - BARE: the image does not have a container or metadata envelope + - DOCKER: docker container format + - OVA: OVF package in a tarfile + - OVF: OVF container format + + NOTE: The list of permitted values was taken from "Container formats" in [i.5] + (OpenStack® documentation: "Disk and container formats for images"). + type: string + enum: + - AKI + - AMI + - ARI + - BARE + - DOCKER + - OVA + - OVF + diskFormat: + description: > + Disk format of a snapshot image is the format of the underlying disk image. + + Permitted values: + - AKI: a kernel image format + - AMI: a machine image format + - ARI: a ramdisk image format + - ISO: an archive format for the data contents of an optical disc, such as CD-ROM + - QCOW2: a common disk image format, which can expand dynamically and supports copy on write + - RAW: an unstructured disk image format + - VDI: a common disk image format + - VHD: a common disk image format + - VHDX: enhanced version of VHD format + - VMDK: a common disk image format + + NOTE: The list of permitted values was adapted from "Disk formats" in [i.5] + (OpenStack® documentation: "Disk and container formats for images"). + type: string + enum: + - AKI + - AMI + - ARI + - ISO + - QCOW2 + - RAW + - VDI + - VHD + - VHDX + - VMDK + createdAt: + description: > + Timestamp indicating when the VNFC snapshot image was created. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime" + minDisk: + description: > + The minimal disk for this VNFC snapshot image (in bytes). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/UnsignedInt" + minRam: + description: > + The minimal RAM for this VNFC snapshot image (in bytes). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/UnsignedInt" + size: + description: > + Size of this VNFC snapshot image (in bytes). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/UnsignedInt" + userMetadata: + description: > + User-defined metadata. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + imagePath: + description: > + Path which identifies the image artifact and also allows to access a copy of the image artifact. + For an image artifact contained as a file in the VNF snapshot package, this attribute shall be + present, and the value of this attribute shall start with the name of the first segment in the + path in the package, i.e., it shall not be prefixed by path separator characters such as "." + and "/". + + EXAMPLE: foo/bar/m%40ster.vhd + + For an external image artifact represented as a URI in the manifest file, this attribute shall + be present if the artifact has been downloaded by the NFVO or the artifact has been processed + after building the VNF snapshot package and shall be absent otherwise. If present, it shall + contain the artifactPath under which the image artifact can be obtained using the + "Individual artifact in a VNF snapshot package" resource defined in clause 12.4.5. It is the + responsibility of the NFVO to synthesize this path in a manner that avoids any collision of + the synthesized artifact path with the paths and names of artifacts included in the snapshot + package. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + imageUri: + description: > + URI of the image artifact as defined in the VNF snapshot package manifest. Shall be present + if the image artifact is external to the snapshot package and shall be absent otherwise. + + EXAMPLE: https://example.com/m%40ster.vhd + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri" + + SnapshotPkgArtifactInfo: + description: > + This type represents an artifact other than a software image which is contained in + a VNF snapshot package. + type: object + required: + - checksum + - isEncrypted + properties: + artifactPath: + description: > + Path which identifies the artifact and also allows to access a copy of the artifact. + For an artifact contained as a file in the VNF snapshot package, this attribute shall + be present, and the value of this attribute shall start with the name of the first + segment in the path in the package, i.e. it shall not be prefixed by path separator + characters such as "." and "/". + + EXAMPLE: foo/bar/m%40ster.sh + + For an external artifact represented as a URI in the manifest file, this attribute + shall be present if the artifact has been downloaded by the NFVO or the artifact has + been processed after building the VNF snapshot package and shall be absent otherwise. + If present, it shall contain the artifactPath under which the artifact can be obtained + using the "Individual artifact in a VNF snapshot package" resource defined in + clause 12.4.5. It is the responsibility of the NFVO to synthesize this path in a manner + that avoids any collision of the synthesized artifact path with the paths and names of + artifacts included in the snapshot package. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + artifactUri: + description: > + URI of the artifact as defined in the VNF snapshot package manifest. Shall be present + if the artifact is external to the snapshot package and shall be absent otherwise. + + EXAMPLE: https://example.com/m%40ster.sh + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri" + checksum: + description: > + Checksum of the artifact file. Hash algorithms applicable to VNF + snapshot package artifacts are defined in ETSI GS NFV-SOL 010. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the artifact is encrypted (true) or not (false). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + metadata: + description: > + The metadata of the artifact that are available in the VNF package, such as Content type, + size, creation date, etc. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + VnfdInfo: + description: > + This type represents the VNFD which is contained in a VNF snapshot package. + type: object + required: + - avnfdId + - vnfdPath + - checksum + - isEncrypted + properties: + avnfdId: + description: > + VNFD identifier of the snapshotted VNF instance. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier" + vnfdPath: + description: > + Path which allows to access a copy of the VNFD. The VNFD is implemented as + a collection of one or more files, and the path refers to the ZIP archive + file embedding these files. The VNF snapshot package format is defined + specified in the ETSI GS NFV-SOL 010. + The value of this attribute shall start with the name of the first segment + of the path in the package, i.e. it shall not be prefixed by path separator + characters such as "." and "/". + EXAMPLE: foo/bar/m@ster + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + checksum: + description: > + Checksum of the VNFD archive file. Hash algorithms applicable to VNF + snapshot package artifacts are defined in ETSI GS NFV-SOL 010. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the VNFD archive file is encrypted (true) or not (false). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" + + VnfSnapshotRecord: + description: > + This type represents the VNF snapshot record which is contained in a VNF snapshot package. + type: object + required: + - recordPath + - checksum + - isEncrypted + properties: + recordPath: + description: > + Path which identifies the VNF snapshot record and allows to access a copy of the + VNF snapshot record for the extraction. + The value of this attribute shall start with the name of the first segment of the + path in the package, i.e. it shall not be prefixed by path separator characters + such as "." and "/". + EXAMPLE: foo/bar/m@ster + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String" + checksum: + description: > + Checksum of the VNF snapshot record file. Hash algorithms applicable to VNF + snapshot package artifacts are defined in ETSI GS NFV-SOL 010. + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum" + isEncrypted: + description: > + Reflects whether the VNF snapshot record file is encrypted (true) or not (false). + $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean" diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml index 457871e2460986850774baf82232765e3e4f4e80..35b96b1e07da1fbd65dcfc31a013134dd78561d1 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml @@ -1,9 +1,8 @@ -swagger: "2.0" +openapi: 3.0.2 info: - version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" title: SOL003 - Virtualised Resources Quota Available Notification interface - description: > + description: | SOL003 - Virtualised Resources Quota Available Notification interface @@ -11,46 +10,38 @@ info: version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - - In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based - filtering mechanism is defined. This mechanism is currently not - included in the corresponding OpenAPI design for this GS version. Changes - to the attribute-based filtering mechanism are being considered in v2.5.1 - of this GS for inclusion in the corresponding future ETSI NFV OpenAPI - design. - - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution= + Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues + contact: + name: NFV-SOL WG license: - name: "ETSI Forge copyright notice" + name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt + version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1" externalDocs: - description: ETSI GS NFV-SOL 003 V2.7.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf + description: ETSI GS NFV-SOL 003 V3.3.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.03.01_60/gs_NFV-SOL003v030301p.pdf -basePath: "/vrqan/v1" - -schemes: - - https - -consumes: - - "application/json" -produces: - - "application/json" +servers: + - url: http://127.0.0.1/vrqan/v1 + - url: https://127.0.0.1/vrqan/v1 paths: ############################################################################### # API Versions # ############################################################################### - '/api_versions': + /api_versions: $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' ############################################################################### # Subscriptions # ############################################################################### - '/subscriptions': + /subscriptions: + parameters: + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization post: - description: > + description: | Subscribe. The POST method creates a new subscription. This method shall follow the provisions specified in the tables 11.4.2.3.1-1 and 11.4.2.3.1-2 @@ -58,317 +49,130 @@ paths: As the result of successfully executing this method, a new "Individual subscription" resource as defined in clause 11.4.3 shall have been created. This method shall not trigger any notification. - Creation of two "Individual subscription" resources with the same callbackURI and + Creation of two "Individual subscription" resources with the same callback URI and the same filter can result in performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a new "Individual subscription" resource if another "Individual subscription" resource with the same filter and - callbackUri already exists (in which case it shall return the "201 Created" response code), + callback URI already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" - resource with the same filter and callbackUri). + resource with the same filter and callback URI). 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 Content-Type header shall be set to - "application/merge-patch+json" according to - IETF RFC 7396. - in: header - required: true - type: string - - name: VrQuotaAvailSubscriptionRequest - description: Details of the subscription to be created. - in: body - required: true - schema: - $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest" - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: true - type: string + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType + requestBody: + $ref: '#/components/requestBodies/VrQuotaAvailSubscriptionRequest' responses: 201: - description: > - 201 CREATED - - Shall be returned when the subscription has been created successfully. - The response body shall contain a representation of the created "Individual subscription" resource. - The HTTP response shall include a "Location" HTTP header that points to the created resource. - 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 VNF 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: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" + $ref: '#/components/responses/Subscriptions.Post.201' 303: -# description: > -# 303 SEE OTHER -# -# Shall be returned when a subscription with the same callbackURI and the same -# filter already exists and the policy of the NFVO is to not create redundant subscriptions. -# The HTTP response shall include a "Location" HTTP header that contains the resource URI -# of the existing "Individual subscription" resource. -# The response body shall be empty. - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" + #description: | + # 303 SEE OTHER + + # Shall be returned when a subscription with the same callback URI and the same + # filter already exists and the policy of the NFVO is to not create redundant subscriptions. + # The HTTP response shall include a "Location" HTTP header that contains the resource URI + # of the existing "Individual subscription" resource. + # The response body shall be empty. + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303" 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" get: - description: > + description: | Query Subscription Information. 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 11.4.2.3.2-1 and 11.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - - name: filter - description: > - Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013. - The VNFM shall support receiving this parameter as part of the - URI query string. The NFVO may supply this parameter. - All attribute names that appear in the VrQuotaAvailSubscription - and in data types referenced from it shall be supported by the - VNFM in the filter expression. - in: query - required: false - type: string - - name: nextpage_opaque_marker - description: > - Marker to obtain the next page of a paged response. Shall be - supported by the VNFM if the VNFM supports alternative 2 (paging) - according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - in: query - 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 + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker responses: 200: - description: > - 200 OK - - Shall be returned when the list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of all active - subscriptions of the functional block that invokes the method, i.e. zero or more - representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. - If the "filter" URI parameter was supplied in the request, the data in the response body shall - have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. - If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. - 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 - 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 - schema: - type: array - items: - $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" + $ref: '#/components/responses/Subscriptions.Get.200' 204: - description: > - No Content - - The notification endpoint was tested successfully. - The response body shall be empty. - headers: - 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 + $ref: '#/components/responses/Subscriptions.Get.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" ############################################################################### # Individual subscription # ############################################################################### - '/subscriptions/{subscriptionId}': + /subscriptions/{subscriptionId}: parameters: - - name: subscriptionId - description: > - Identifier of this subscription. - This identifier can be retrieved from the resource referenced by the - "Location" HTTP header in the response to a POST request creating a - new "Individual subscription" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. - in: path - type: string - required: true + - $ref: '#/components/parameters/SubscriptionId' + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version + - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization get: - description: > + description: | Query Subscription Information. The GET method reads an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.2-1 and 11.4.3.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. - 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: true - type: string responses: 200: - description: > - 200 OK - - Shall be returned when information about an individual subscription has been read successfully. - The response body shall contain a representation of the "Individual subscription" resource - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 - schema: - $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription" + $ref: '#/components/responses/IndividualSubscription.Get.200' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" delete: - description: > + description: | Terminate subscription. The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the tables 11.4.3.3.5-1 and 11.4.3.3.5-2 @@ -378,45 +182,236 @@ paths: sent to the formerly-subscribed API consumer. NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 204: - description: > - No Content - - Shall be returned when the "Individual subscription" resource has been deleted successfully. - headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 - type: string - maximum: 1 - minimum: 1 + $ref: '#/components/responses/IndividualSubscription.Delete.204' 400: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400" 401: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401" 403: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403" 404: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405" 422: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422" 406: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406" 500: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503" 504: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504" + + +components: + parameters: + SubscriptionId: + name: subscriptionId + in: path + description: | + Identifier of this subscription. + This identifier can be retrieved from the resource referenced by the + "Location" HTTP header in the response to a POST request creating a + new "Individual subscription" resource. It can also be retrieved from the "id" + attribute in the payload body of that response. + required: true + style: simple + explode: false + schema: + type: string + + requestBodies: + + VrQuotaAvailSubscriptionRequest: + description: | + Details of the subscription to be created. + content: + application/json: + schema: + $ref: "./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest" + required: true + + + responses: + Subscriptions.Post.201: + description: | + 201 CREATED + + Shall be returned when the subscription has been created successfully. + The response body shall contain a representation of the created "Individual subscription" resource. + The HTTP response shall include a "Location" HTTP header that points to the created resource. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Location: + description: | + The resource URI of the created VNF instance + style: simple + explode: false + schema: + type: string + format: url + content: + application/json: + schema: + $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription + + Subscriptions.Get.200: + description: | + 200 OK + + Shall be returned when the list of subscriptions has been queried successfully. + The response body shall contain in an array the representations of all active + subscriptions of the functional block that invokes the method, i.e. zero or more + representations of virtualised resource quota available subscriptions as defined in clause 11.5.2.3. + If the "filter" URI parameter was supplied in the request, the data in the response body shall + have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013. + If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 + for this resource, inclusion of the Link HTTP header in this response shall follow the provisions + in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + Link: + description: | + Reference to other resources. Used for paging in the present document, see clause 4.7.2.1. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + type: array + items: + $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription + + Subscriptions.Get.204: + description: | + No Content + + The notification endpoint was tested successfully. + The response body shall be empty. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + + IndividualSubscription.Get.200: + description: | + 200 OK + + Shall be returned when information about an individual subscription has been read successfully. + The response body shall contain a representation of the "Individual subscription" resource. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string + content: + application/json: + schema: + $ref: ./definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription + + IndividualSubscription.Delete.204: + description: | + No Content + + Shall be returned when the "Individual subscription" resource has been deleted successfully. + headers: + Version: + description: | + The used API version. + style: simple + explode: false + schema: + type: string + 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. + style: simple + explode: false + schema: + type: string + Content-Type: + description: | + The MIME type of the body of the response. + style: simple + explode: false + schema: + type: string \ No newline at end of file diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml similarity index 100% rename from src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml rename to src/SOL003/VirtualisedResourcesQuotaAvailableNotification/definitions/SOL003VirtualisedResourcesQuotaAvailableNotification_def.yaml diff --git a/src/components/SOL002SOL003_params.yaml b/src/components/SOL002SOL003_params.yaml new file mode 100644 index 0000000000000000000000000000000000000000..2211c23c42ca3de0eb569b07cd96b89bb17e2313 --- /dev/null +++ b/src/components/SOL002SOL003_params.yaml @@ -0,0 +1,106 @@ +components: + parameters: + Version: + name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: true + schema: + type: string + + Accept: + name: Accept + description: > + Content-Types that are acceptable for the response. Reference: IETF RFC 7231. + in: header + required: true + schema: + type: string + + Authorization: + name: Authorization + description: > + The authorization token for the request. Reference: IETF RFC 7235. + in: header + required: false + schema: + type: string + + ContentType: + name: Content-Type + description: | + The MIME type of the body of the request. Reference: IETF RFC 7231 + in: header + required: true + schema: + type: string + + filter: + name: filter + description: > + Attribute-based filtering expression according to clause 5.2 of ETSI + GS NFV-SOL 013. The NFV-MANO functional entity shall support + receiving this parameter as part of the URI query string. The API + consumer may supply this parameter. All attribute names that appear + in the FmSubscription and in data types referenced from it shall be + supported by the NFV-MANO functional entity in the filter + expression. + in: query + required: false + schema: + type: string + + all_fields: + name: all_fields + description: > + Include all complex attributes in the response. See clause + 5.3 of ETSI GS NFV-SOL 013. The NFV-MANO functional entity + shall support this parameter. + in: query + required: false + schema: + type: string + + fields: + name: fields + description: > + Complex attributes to be included into the response. See clause + 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional + entity should support this parameter. + in: query + required: false + schema: + type: string + + exclude_fields: + name: exclude_fields + description: > + Complex attributes to be excluded from the response. See clause + 5.3 of ETSI GS NFV-SOL 013 for details. The NFV-MANO functional + entity should support this parameter. + in: query + required: false + schema: + type: string + + exclude_default: + name: exclude_default + in: query + description: >- + Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV-SOL 013 + for details. The NFV-MANO functional entity shall support this parameter. + required: false + schema: + type: string + + nextpage_opaque_marker: + name: nextpage_opaque_marker + description: > + Marker to obtain the next page of a paged response. Shall be supported by + the NFV-MANO functional entity if the entity supports alternative 2 (paging) + according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. + in: query + required: false + schema: + type: string diff --git a/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml b/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml index 1a3ef0121a043049e2fea506316d1b73e62f4f8b..8ba60530565a7fbbae199f15b99fd9e35cc97058 100644 --- a/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFFaultManagement_def.yaml @@ -65,181 +65,6 @@ definitions: URI of this resource. $ref: "SOL002SOL003_def.yaml#/definitions/Link" - Alarm: - description: > - The alarm data type encapsulates information about an alarm. - type: object - required: - - id - - managedObjectId - - alarmRaisedTime - - ackState - - perceivedSeverity - - eventTime - - eventType - - probableCause - - isRootCause - - _links - properties: - id: - description: > - Identifier of this Alarm information element. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - managedObjectId: - description: > - Identifier of the affected VNF instance. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfcInstanceIds: - description: > - Identifiers of the affected VNFC instances. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - rootCauseFaultyResource: - description: > - The virtualised resources that are causing the VNF fault. - Shall be present if the alarm affects virtualized resources. - $ref: "#/definitions/FaultyResourceInfo" - alarmRaisedTime: - description: > - Time stamp indicating when the alarm is raised by the managed - object. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - alarmChangedTime: - description: > - Time stamp indicating when the alarm was last changed. It shall be - present if the alarm has been updated. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - alarmClearedTime: - description: > - Time stamp indicating when the alarm was cleared. It shall be - present if the alarm has been cleared. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - alarmAcknowledgedTime: - description: > - Time stamp indicating when the alarm was acknowledged. - It shall be present if the alarm has been acknowledged. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - ackState: - description: > - Acknowledgement state of the alarm. - Permitted values: - * UNACKNOWLEDGED - * ACKNOWLEDGED. - type: string - enum: - - UNACKNOWLEDGED - - ACKNOWLEDGED - perceivedSeverity: - description: > - Perceived severity of the managed object failure. - $ref: "#/definitions/PerceivedSeverityType" - eventTime: - description: > - Time stamp indicating when the fault was observed. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - eventType: - description: > - Type of event. - $ref: "#/definitions/EventType" - faultType: - description: > - Additional information to clarify the type of the fault. - type: string - probableCause: - description: > - Information about the probable cause of the fault. - type: string - isRootCause: - description: > - Attribute indicating if this fault is the root for other correlated - alarms. If true, then the alarms listed in the attribute - "correlatedAlarmId" are caused by this fault. - type: boolean - correlatedAlarmIds: - description: > - List of identifiers of other alarms correlated to this fault. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - faultDetails: - description: > - Provides additional information about the fault. - type: array - items: - type: string - _links: - description: > - Links for this resource. - type: object - required: - - self - properties: - self: - description: > - URI of this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - objectInstance: - description: > - Link to the resource representing the VNF instance to which the - notified alarm is correlated. Shall be present if the VNF - instance information is accessible as a resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - - AlarmNotification: - description: > - This type represents an alarm notification about VNF faults. - This notification shall be triggered by the VNFM when: - * An alarm has been created. - * An alarm has been updated, e.g. if the severity of the alarm has - changed. - type: object - required: - - id - - notificationType - - subscriptionId - - timeStamp - - alarm - - _links - properties: - id: - description: > - Identifier of this notification. If a notification is sent multiple - times due to multiple subscriptions, the "id" attribute of all these - notifications shall have the same value. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - notificationType: - description: > - Discriminator for the different notification types. Shall be set to - "AlarmNotification" for this notification type. - type: string - enum: - - AlarmNotification - subscriptionId: - description: > - Identifier of the subscription that this notification relates to. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - timeStamp: - description: > - Date-time of the generation of the notification. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - alarm: - description: > - Information about an alarm including AlarmId, affected VNF - identifier, and FaultDetails. - $ref: "#/definitions/Alarm" - _links: - description: > - Links to resources related to this notification. - type: object - required: - - subscription - properties: - subscription: - description: > - Link to the related subscription. - $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" - AlarmClearedNotification: description: > This type represents an alarm cleared notification about VNF faults. diff --git a/src/definitions/SOL002SOL003VNFIndicator_def.yaml b/src/definitions/SOL002SOL003VNFIndicator_def.yaml index 36baa3834c9a4670d52028c46fedba180d7619ce..978c3500e3c37ada355114e61691347ed0a05ffe 100644 --- a/src/definitions/SOL002SOL003VNFIndicator_def.yaml +++ b/src/definitions/SOL002SOL003VNFIndicator_def.yaml @@ -51,8 +51,8 @@ definitions: VnfIndicatorNotificationsFilter: description: > - This type represents a subscription filter related to notifications - about VNF indicator value changes. + This type represents a subscription filter for notifications + related to VNF indicators. At a particular nesting level in the filter structure, the following applies: All attributes shall match in order for the filter to match (logical "and" between different filter attributes). If an attribute is @@ -64,6 +64,19 @@ definitions: description: > Filter criteria to select VNF instances about which to notify. $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter" + notificationTypes: + description: > + Match particular notification types. + Permitted values: + * VnfIndicatorValueChangeNotification + * SupportedIndicatorsChangeNotification + The permitted values of the "notificationTypes" attribute are spelled exactly + as the names of the notification types to facilitate automated code generation + systems. + type: string + enum: + - VnfIndicatorValueChangeNotification + - SupportedIndicatorsChangeNotification indicatorIds: description: > Match particular VNF indicator identifiers. @@ -207,6 +220,84 @@ definitions: Link to the related "Individual VNF instance" resource. Shall be present if the VNF instance information is accessible as a resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" + subscription: + description: > + Link to the related subscription. + $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" + + SupportedIndicatorsChangeNotification: + description: > + This type represents a notification to inform the receiver that the set of indicators supported + by a VNF instance has changed. It shall comply with the provisions defined in table 8.5.2.6-1. + The notification shall be triggered by the VNFM when the set of supported VNF indicators has changed + as a side effect of the "Change current VNF package" operation. It may be triggered by the VNFM when + a VNF has been instantiated. + type: object + required: + - id + - notificationType + - subscriptionId + - timeStamp + - vnfInstanceId + - _links + properties: + id: + description: > + Identifier of this notification. If a notification is sent multiple times + due to multiple subscriptions, the "id" attribute of all these notifications + shall have the same value. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + notificationType: + description: > + Discriminator for the different notification types. Shall be set to + "SupportedIndicatorsChangeNotification" for this notification type. + type: string + enum: + - VnfIndicatorValueChangeNotification + subscriptionId: + description: > + Identifier of the subscription that this notification relates to. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + timeStamp: + description: > + Date-time of the generation of the notification. + $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" + vnfInstanceId: + description: > + Identifier of the VNF instance which provides the indicator value. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + supportedIndicators: + description: > + Set of VNF indicators supported by the VNF instance. + type: array + items: + type: object + required: + - vnfIndicatorId + properties: + vnfIndicatorId: + description: > + Identifier of the VNF indicator whose value has changed. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + name: + description: > + Human readable name of the VNF indicator. + Shall be present if defined in the VNFD. + ETSI GS NFV-SOL 001 specifies the structure and format of + the VNFD based on TOSCA specifications. + type: string + _links: + description: > + Links for this resource. + type: object + required: + - subscription + properties: + vnfInstance: + description: > + Link to the related "Individual VNF instance" resource. Shall be present + if the VNF instance information is accessible as a resource. + $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" subscription: description: > Link to the related subscription. diff --git a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml index 658fcdfb5048fddce4656bf1700c8b94279ae316..637afa64f62ae777e116d3ad164b0911becdb69d 100644 --- a/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFLifecycleManagement_def.yaml @@ -22,11 +22,9 @@ definitions: type: string metadata: description: > - If present, this attribute provides values for the "metadata" attribute in "VnfInstance", - as defined in clause 5.5.2.2. - If a “metadata” entry in this CreateVnfRequest data structure has a corresponding default - value declared in the VNFD, the value in the “metadata” entry in the CreateVnfRequest - structure takes precedence. + If present, this attribute provides additional initial values, overriding those obtained from the VNFD, for + the "metadata" attribute in "VnfInstance", as defined in clause 5.5.2.2. Provisions for handling metadata + during the operation are defined in clause 5.4.2.3.1. $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" ScaleVnfRequest: @@ -70,6 +68,12 @@ definitions: This type represents request parameters for the "Scale VNF to Level" operation. type: object + anyOf: + - oneOf: + - required: + - instantiationLevelId + - required: + - scaleInfo properties: instantiationLevelId: description: > @@ -148,285 +152,6 @@ definitions: items: $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - VnfInfoModifications: - description: > - This type represents attribute modifications that were performed on an - "Individual VNF instance" resource. The attributes that can be included - consist of those requested to be modified explicitly in the - "VnfInfoModificationRequest" data structure, and additional attributes - of the "VnfInstance" data structure that were modified implicitly e.g. - when modifying the referenced VNF package. - type: object - properties: - vnfInstanceName: - description: > - If present, this attribute signals modifications of the - "vnfInstanceName" attribute in "VnfInstance". - type: string - vnfInstanceDescription: - description: > - If present, this attribute signals modifications of the - "vnfInstanceDescription" attribute in "VnfInstance". - type: string - vnfConfigurableProperties: - description: > - If present, this attribute signals modifications of the - "vnfConfigurableProperties" attribute in "VnfInstance". - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - metadata: - description: > - If present, this attribute signals modifications of the "metadata" - attribute in "VnfInstance". - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - extensions: - description: > - If present, this attribute signals modifications of the "extensions" - attribute in "VnfInstance". - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - vnfdId: - description: > - If present, this attribute signals modifications of the "vnfdId" - attribute in "VnfInstance". - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfProvider: - description: > - If present, this attribute signals modifications of the - "vnfProvider" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfPkgId" attribute) was modified implicitly following a request to - modify the "vnfPkgId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfPkgId” attribute. - type: string - vnfProductName: - description: > - If present, this attribute signals modifications of the - "vnfProductName" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfPkgId" attribute) was modified implicitly following a request to - modify the "vnfPkgId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfPkgId” attribute. - type: string - vnfSoftwareVersion: - description: > - If present, this attribute signals modifications of the - "vnfSoftwareVersion" attribute in "VnfInstance". - $ref: "SOL002SOL003_def.yaml#/definitions/Version" - vnfdVersion: - description: > - If present, this attribute signals modifications of the - "vnfdVersion" attribute in "VnfInstance". - If present, this attribute (which depends on the value of the - "vnfdId" attribute) was modified implicitly following a request to - modify the "vnfdId" attribute, by copying the value of this - attribute from the VNFD in the VNF Package identified by the - "vnfdId” attribute. - $ref: "SOL002SOL003_def.yaml#/definitions/Version" - vnfcInfoModifications: - description: > - If present, this attribute signals modifications of certain - entries in the "vnfcInfo" attribute array in the - "instantiatedVnfInfo" attribute of "VnfInstance", as defined - in clause 5.5.2.12 - type: array - items: - $ref: "#/definitions/VnfcInfoModifications" - vnfcInfoModificationsDeleteIds: - description: > - If present, this attribute signals the deletion of certain - entries in the "vnfcInfo" attribute array in the - "instantiatedVnfInfo" attribute of "VnfInstance", as defined - in clause 5.5.2.12 - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - - VnfLcmOpOcc: - description: > - This type represents a VNF lifecycle management operation occurrence. - type: object - required: - - id - - operationState - - stateEnteredTime - - startTime - - vnfInstanceId - - operation - - isAutomaticInvocation - - isCancelPending - properties: - id: - description: > - Identifier of this VNF lifecycle management operation occurrence. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - operationState: - description: > - The state of the LCM operation. - $ref: "#/definitions/LcmOperationStateType" - stateEnteredTime: - description: > - Date-time when the current state has been entered. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - startTime: - description: > - Date-time of the start of the operation. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - vnfInstanceId: - description: > - Identifier of the VNF instance to which the operation applies - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - grantId: - description: > - Identifier of the grant related to this VNF LCM operation - occurrence, if such grant exists. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - operation: - description: > - Type of the actual LCM operation represented by this VNF LCM - operation occurrence. - $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType" - isAutomaticInvocation: - description: > - Set to true if this VNF LCM operation occurrence has been triggered - by an automated procedure inside the VNFM (i.e. - ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf - triggered by auto-heal). Set to false otherwise. - $ref: "SOL002SOL003_def.yaml#/definitions/Boolean" - operationParams: - description: > - Input parameters of the LCM operation. This attribute shall be - formatted according to the request data type of the related LCM - operation. The following mapping between operationType and the - data type of this attribute shall apply: - * INSTANTIATE: InstantiateVnfRequest - * SCALE: ScaleVnfRequest - * SCALE_TO_LEVEL: ScaleVnfToLevelRequest - * CHANGE_FLAVOUR: ChangeVnfFlavourRequest - * OPERATE: OperateVnfRequest - * HEAL: HealVnfRequest - * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest - * TERMINATE: TerminateVnfRequest - * MODIFY_INFO: VnfInfoModifications - type: object - isCancelPending: - description: > - If the VNF LCM operation occurrence is in "STARTING", "PROCESSING" - or "ROLLING_BACK" state and the operation is being cancelled, this - attribute shall be set to true. Otherwise, it shall be set to false. - $ref: "SOL002SOL003_def.yaml#/definitions/Boolean" - cancelMode: - description: > - The mode of an ongoing cancellation. Shall be present when - isCancelPending=true, and shall be absent otherwise. - $ref: "#/definitions/CancelModeType" - error: - description: > - If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" - is "PROCESSING" or "ROLLING_BACK" and previous value of - "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: "SOL002SOL003_def.yaml#/definitions/ProblemDetails" - resourceChanges: - description: > - This attribute contains information about the cumulative changes to - virtualised resources that were performed so far by the LCM - operation since its start, if applicable. - type: object - properties: - affectedVnfcs: - description: > - Information about VNFC instances that were affected during the - lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc" - affectedVirtualLinks: - description: > - Information about VL instances that were affected during the - lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "#/definitions/AffectedVirtualLink" - affectedVirtualStorages: - description: > - Information about virtualised storage instances that were affected - during the lifecycle operation. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "#/definitions/AffectedVirtualStorage" - changedInfo: - description: > - Information about the changed VNF instance information, including - VNF configurable properties, if applicable. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - $ref: "#/definitions/VnfInfoModifications" - changedExtConnectivity: - description: > - Information about changed external connectivity, if applicable. - This allows the NFVO to obtain the information contained in the - latest "result" notification if it has not received it due to an - error or a wrongly configured subscription filter. - type: array - items: - $ref: "#/definitions/ExtVirtualLinkInfo" - _links: - description: > - Links to resources related to this resource. - type: object - required: - - self - - vnfInstance - properties: - self: - description: > - URI of this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - vnfInstance: - description: > - Link to the VNF instance that the operation applies to. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - grant: - description: > - Link to the grant for this operation, if one exists. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - cancel: - description: > - Link to the task resource that represents the "cancel" operation - for this VNF LCM operation occurrence, if cancelling is - currently allowed. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - retry: - description: > - Link to the task resource that represents the "retry" operation - for this VNF LCM operation occurrence, if retrying is currently - allowed. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - rollback: - description: > - Link to the task resource that represents the "rollback" - operation for this VNF LCM operation occurrence, if rolling back - is currently allowed. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - fail: - description: > - Link to the task resource that represents the "fail" operation - for this VNF LCM operation occurrence, if declaring as failed is - currently allowed. - $ref: "SOL002SOL003_def.yaml#/definitions/Link" - CancelMode: description: > This type represents a parameter to select the mode of cancelling an @@ -467,6 +192,11 @@ definitions: This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" + verbosity: + description: > + This attribute signals the requested verbosity of LCM operation occurrence notifications. If it is not present, + it shall default to the value "FULL". + $ref: "#/definitions/LcmOpOccNotificationVerbosityType" LccnSubscription: description: > @@ -476,6 +206,7 @@ definitions: required: - id - callbackUri + - verbosity - _links properties: id: @@ -493,6 +224,10 @@ definitions: description: > The URI of the endpoint to send the notification to. $ref: "SOL002SOL003_def.yaml#/definitions/Uri" + verbosity: + description: > + This attribute signals the verbosity of LCM operation occurrence notifications. + $ref: "#/definitions/LcmOpOccNotificationVerbosityType" _links: description: > Links to resources related to this resource. @@ -510,6 +245,7 @@ definitions: required: - id - resourceHandle + - currentVnfExtCpData properties: id: description: > @@ -528,35 +264,19 @@ definitions: type: array items: $ref: "#/definitions/ExtLinkPortInfo" - - ExtManagedVirtualLinkInfo: - type: object - required: - - id - - vnfVirtualLinkDescId - - networkResource - properties: - id: - description: > - Identifier of the externally-managed internal VL and the related - externally-managed VL information instance. - The identifier is assigned by the NFV-MANO entity that manages this - VL instance. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfVirtualLinkDescId: - description: > - Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - networkResource: - description: > - Reference to the VirtualNetwork resource. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - vnfLinkPorts: - description: > - Link ports of this VL. + currentVnfExtCpData: + description: > + Allows the API consumer to read the current CP configuration information for the connection of external CPs + to the external virtual link. + This attribute reflects the current configuration information that has resulted from merging into this attribute + the "VnfExtCpData" information which was passed as part of the "ExtVirtualLinkData" structure in the input of + the most recent VNF LCM operation such as "InstantiateVnfRequest", "ChangeExtVnfConnectivityRequest", + "ChangeVnfFlavourRequest" or "ChangeCurrentVnfPkgRequest", or has been provided by the NFVO during the granting + procedure. If applying such change results in an empty list of "currentVnfExtCpData" structure instances, the + affected instance of "ExtVirtualLinkInfo" shall be removed from its parent data structure. type: array items: - $ref: "#/definitions/VnfLinkPortInfo" + $ref: "SOL002SOL003_def.yaml#/definitions/VnfExtCpData" ScaleInfo: required: @@ -568,188 +288,18 @@ definitions: description: > Identifier of the scaling aspect. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" scaleLevel: description: > Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. type: integer - VnfcResourceInfo: - description: > - This type represents the information on virtualised compute and storage - resources used by a VNFC in a VNF instance. - type: object - required: - - id - - vduId - - computeResource - properties: - id: - description: > - Identifier of this VnfcResourceInfo instance. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - vduId: - description: > - Reference to the applicable VDU in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - computeResource: - description: > - Reference to the VirtualCompute resource. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - zoneId: - description: > - The identifier of the resource zone, as managed by the - resource management layer (typically, the VIM), where - the referenced VirtualCompute resource is placed. - Shall be provided if this information is available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - storageResourceIds: - description: > - References to the VirtualStorage resources. The value refers to a - VirtualStorageResourceInfo item in the VnfInstance. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - reservationId: - description: > - The reservation identifier applicable to the resource. It shall be - present when an applicable reservation exists. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfcCpInfo: - description: > - CPs of the VNFC instance. - Shall be present when that particular CP of the VNFC instance is - associated to an external CP of the VNF instance. - May be present otherwise. - type: array - items: - type: object - required: - - id - - cpdId - properties: - id: - description: > - Identifier of this VNFC CP instance and the associated array - entry. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - cpdId: - description: > - Identifier of the VDU CPD, cpdId, in the VNFD. - $ref: "SOL002SOL003_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: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - cpProtocolInfo: - description: > - Network protocol information for this CP. - type: array - items: - $ref: "#/definitions/CpProtocolInfo" - vnfLinkPortId: - description: > - Identifier of the "vnfLinkPorts" structure in the - "VnfVirtualLinkResourceInfo" structure. Shall be present if - the CP is associated to a link port. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - metadata: - description: > - Metadata about this CP. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - metadata: - description: > - Metadata about this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - VnfVirtualLinkResourceInfo: - description: > - This type represents the information that allows addressing a virtualised - resource that is used by an internal VL instance in a VNF instance. - type: object - required: - - id - - vnfVirtualLinkDescId - - networkResource - properties: - id: - description: > - Identifier of this VnfVirtualLinkResourceInfo instance. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - vnfVirtualLinkDescId: - description: > - Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - networkResource: - description: > - Reference to the VirtualNetwork resource. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - zoneId: - description: > - The identifier of the resource zone, as managed by the resource - management layer (typically, the VIM), where the referenced - VirtualNetwork resource is placed. Shall be provided if this - information is available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - reservationId: - description: > - The reservation identifier applicable to the resource. It shall be - present when an applicable reservation exists. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - vnfLinkPorts: - description: > - Links ports of this VL. - Shall be present when the linkPort is used for external connectivity - by the VNF (refer to VnfLinkPortInfo). - May be present otherwise. - type: array - items: - $ref: "#/definitions/VnfLinkPortInfo" - metadata: - description: > - Metadata about this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - VirtualStorageResourceInfo: - description: > - This type represents the information that allows addressing a virtualised - resource that is used by a VNF instance. - type: object - required: - - id - - virtualStorageDescId - - storageResource - properties: - id: - description: > - Identifier of this VirtualStorageResourceInfo instance. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - virtualStorageDescId: - description: > - Identifier of the VirtualStorageDesc in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - storageResource: - description: > - Reference to the VirtualStorage resource. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - zoneId: - description: > - The identifier of the resource zone, as managed by the resource - management layer (typically, the VIM), where the referenced - VirtualStorage resource is placed. Shall be provided if this - information is available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - reservationId: - description: > - The reservation identifier applicable to the resource. It shall be - present when an applicable reservation exists. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - metadata: - description: > - Metadata about this resource. - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - VnfLinkPortInfo: type: object required: @@ -762,7 +312,7 @@ definitions: $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" resourceHandle: description: > - Reference to the virtualised network resource realizing this link + Reference to the virtualised resource realizing this link port. $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" cpInstanceId: @@ -780,7 +330,7 @@ definitions: connection point instance or internal connection point (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. + "vnfcCpInfo" item of a "vnfcResourceInfo" item in the VnfInstance. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" cpInstanceType: description: > @@ -825,6 +375,7 @@ definitions: description: > This type describes the protocol layer(s) that a CP uses together with protocol-related information, like addresses. + type: object required: - layerProtocol properties: @@ -852,12 +403,32 @@ definitions: This type represents information about a network address that has been assigned. type: object + anyOf: + - required: + - macAddress + - required: + - ipAddresses + oneOf: + - required: + - addresses + - required: + - addressRange properties: macAddress: description: > MAC address, if assigned. At least one of "macAddress" or "ipAddresses" shall be present. $ref: "SOL002SOL003_def.yaml#/definitions/MacAddress" + segmentationId: + description: > + Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a + subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. + Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment + value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an + identifier used between the application and the NFVI networking infrastructure to identify the network + sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local + segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology. + type: string ipAddresses: description: > Addresses assigned to the CP instance. Each entry represents IP @@ -928,6 +499,12 @@ definitions: description: > Identifier of the monitoring parameter defined in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" name: description: > Human readable name of the monitoring parameter, as defined in the @@ -993,142 +570,6 @@ definitions: items: $ref: "#/definitions/LcmOperationStateType" - AffectedVirtualLink: - description: > - This type provides information about added, deleted, modified and - temporary VLs. - type: object - required: - - id - - vnfVirtualLinkDescId - - changeType - - networkResource - properties: - id: - description: > - Identifier of the virtual link instance, identifying the applicable - "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - vnfVirtualLinkDescId: - description: > - Identifier of the related VLD in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - changeType: - description: > - Signals the type of change. Permitted values: - * ADDED - * REMOVED - * MODIFIED - * TEMPORARY - * LINK_PORT_ADDED - * LINK_PORT_REMOVED - For a temporary resource, an AffectedVirtualLink structure exists as - long as the temporary resource exists. - type: string - enum: - - ADDED - - REMOVED - - MODIFIED - - TEMPORARY - - LINK_PORT_ADDED - - LINK_PORT_REMOVED - networkResource: - description: > - Reference to the VirtualNetwork resource. Detailed information is - (for new and modified resources) or has been (for removed - resources) available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - resourceDefinitionId: - description: > - The identifier of the "ResourceDefinition" in the granting exchange - related to the LCM operation occurrence. It shall be present when an - applicable GrantInfo for the granted resource exists. - The "resourceDefinitionId" attribute provides information to the API - consumer (i.e. the NFVO) to assist in correlating the resource changes - performed during the LCM operation with the granted resources in a - specific Grant exchange, which is identified by the "grantId" available - in the "Individual VNF lifecycle management operation occurrence" and - the "id" in the "Individual Grant". - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal" - zoneId: - description: > - The identifier of the resource zone, as managed by the resource - management layer (typically, the VIM), where the referenced VirtualNetwork - resource is placed. Shall be provided if this information is available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - 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: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - - AffectedVirtualStorage: - description: > - This type provides information about added, deleted, modified and - temporary virtual storage resources. - type: object - required: - - id - - virtualStorageDescId - - changeType - - storageResource - properties: - id: - description: > - Identifier of the storage instance, identifying the applicable - "virtualStorageResourceInfo" entry in the "VnfInstance" data type. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" - virtualStorageDescId: - description: > - Identifier of the related VirtualStorage descriptor in the VNFD. - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" - changeType: - description: > - Signals the type of change. Permitted values: - * ADDED - * REMOVED - * MODIFIED - * TEMPORARY - For a temporary resource, an AffectedVirtualStorage structure exists - as long as the temporary resource exists. - type: string - enum: - - ADDED - - REMOVED - - MODIFIED - - TEMPORARY - storageResource: - description: > - Reference to the VirtualStorage resource. Detailed information is - (for new and modified resources) or has been (for removed - resources) available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/ResourceHandle" - resourceDefinitionId: - description: > - The identifier of the "ResourceDefinition" in the granting exchange - related to the LCM operation occurrence. It shall be present when an - applicable GrantInfo for the granted resource exists. - The "resourceDefinitionId" attribute provides information to the API - consumer (i.e. the NFVO) to assist in correlating the resource changes - performed during the LCM operation with the granted resources in a - specific Grant exchange, which is identified by the "grantId" available - in the "Individual VNF lifecycle management operation occurrence" and - the "id" in the "Individual Grant". - $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierLocal" - zoneId: - description: > - The identifier of the resource zone, as managed by the resource - management layer (typically, the VIM), where the referenced VirtualNetwork - resource is placed. Shall be provided if this information is available from the VIM. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - 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: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" - LccnLinks: description: > This type represents the links to resources that a notification can @@ -1162,7 +603,13 @@ definitions: required: - id - cpdId + - cpConfigId - cpProtocolInfo + oneOf: + - required: + - associatedVnfcCpId + - required: + - associatedVnfVirtualLinkId properties: id: description: > @@ -1172,6 +619,17 @@ definitions: description: > Identifier of the external CPD, VnfExtCpd, in the VNFD. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd" + cpConfigId: + description: > + Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig" map of the "currentVnfExtCpData" + in the "ExtVirtualLinkInfo" structure. + $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" + vnfdId: + description: > + Identifier of the VNFD. + Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change + current VNF package" operation or due to its final failure). + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" cpProtocolInfo: description: > Network protocol information for this CP. @@ -1180,7 +638,7 @@ definitions: $ref: "#/definitions/CpProtocolInfo" extLinkPortId: description: > - Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" structure. + Identifier of the "ExtLinkPortInfo" structure inside the "ExtVirtualLinkInfo" structure. Shall be present if the CP is associated to a link port. $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" metadata: @@ -1259,184 +717,6 @@ definitions: - FORCEFUL ######################################################################################################################## - VnfLcmOperationOccurrenceNotification: - description: > - This type represents a VNF lifecycle management operation occurrence - notification, which informs the receiver of changes in the VNF - lifecycle caused by a VNF LCM operation occurrence. The support of the - notification is mandatory. - This notification shall be triggered by the VNFM when there is a change - in the state of a VNF LCM operation occurrence that changes the VNF lifecycle, - which represents an occurrence of one the following LCM operations: - * Instantiation of the VNF - * Scaling of the VNF instance (including auto-scaling) - * Healing of the VNF instance (including auto-healing) - * Change of the state of the VNF instance (i.e. Operate VNF) - * Change of the deployment flavour of the VNF instance - * Change of the external connectivity of the VNF instance - * Termination of the VNF instance - * Modification of VNF instance information and/or VNF configurable - properties through the "PATCH" method on the "Individual VNF instance" - resource. - Clause 5.6.2 defines the states and state transition of a VNF LCM operation occurrence, - and also specifies details of the notifications to be emitted at each state transition. - If this is the initial notification about the start of a VNF LCM operation occurrence, - it is assumed that the notification is sent by the VNFM before any action (including sending the grant request) - is taken as part of the LCM operation. Due to possible race conditions, the "start" notification, - the grant request and the LCM operation acknowledgment (i.e. the "202 Accepted" response) - can arrive in any order at the NFVO, and the NFVO shall be able to handle such a situation. - If this is a notification about a final or intermediate result state of a VNF LCM operation occurrence, - the notification shall be sent after all related actions of the LCM operation that led - to this state have been executed. - The new state shall be set in the "Individual VNF LCM operation occurrence" resource before - the notification about the state change is sent. - See clause 5.6.2.2 for further provisions regarding sending this notification, including - in cases of handling LCM operation errors. - type: object - required: - - id - - notificationType - - subscriptionId - - timeStamp - - notificationStatus - - operationState - - vnfInstanceId - - operation - - isAutomaticInvocation - - vnfLcmOpOccId - - _links - properties: - id: - description: > - Identifier of this notification. If a notification is sent multiple - times due to multiple subscriptions, the "id" attribute of all these - notifications shall have the same value. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - notificationType: - description: > - Discriminator for the different notification types. Shall be set to - "VnfLcmOperationOccurrenceNotification" for this notification type. - type: string - enum: - - VnfLcmOperationOccurrenceNotification - subscriptionId: - description: > - Identifier of the subscription that this notification relates to. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - timeStamp: - description: > - Date-time of the generation of the notification. - $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" - notificationStatus: - description: > - Indicates whether this notification reports about the start of a - lifecycle operation or the result of a lifecycle operation. - Permitted values: - * START: Informs about the start of the VNF LCM operation - occurrence. - * RESULT: Informs about the final or intermediate result of the VNF - LCM operation occurrence. - type: string - enum: - - START - - RESULT - operationState: - description: > - The state of the VNF LCM operation occurrence. - $ref: "SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LcmOperationStateType" - vnfInstanceId: - description: > - The identifier of the VNF instance affected. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - operation: - description: > - The lifecycle management operation. - $ref: "SOL002SOL003_def.yaml#/definitions/LcmOperationType" - isAutomaticInvocation: - description: > - Set to true if this VNF LCM operation occurrence has been triggered - by an automated procedure inside the VNFM - (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf - triggered by auto-heal). - Set to false otherwise. - type: boolean - vnfLcmOpOccId: - description: > - The identifier of the VNF lifecycle management operation occurrence - associated to the notification. - $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" - affectedVnfcs: - description: > - Information about VNFC instances that were affected during the - lifecycle operation. - Shall be present if the "notificationStatus" is set to "RESULT" and - the operation has performed any resource modification. Shall be - absent otherwise. This attribute contains information about the - cumulative changes to virtualised resources that were performed so - far by the VNF LCM operation occurrence and by any of the error - handling procedures for that operation occurrence. - type: array - items: - $ref: "SOL002SOL003_def.yaml#/definitions/AffectedVnfc" - affectedVirtualLinks: - description: > - Information about VL instances that were affected during the - lifecycle operation. - Shall be present if the "notificationStatus" is set to "RESULT" and - the operation has performed any resource modification. Shall be - absent otherwise. This attribute contains information about the - cumulative changes to virtualised resources that were performed so - far by the VNF LCM operation occurrence and by any of the error - handling procedures for that operation occurrence. - type: array - items: - $ref: "#/definitions/AffectedVirtualLink" - affectedVirtualStorages: - description: > - Information about virtualised storage instances that were affected - during the lifecycle operation. - Shall be present if the "notificationStatus" is set to "RESULT" and - the operation has performed any resource modification. Shall be - absent otherwise. This attribute contains information about the - cumulative changes to virtualised resources that were performed so - far by the VNF LCM operation occurrence and by any of the error - handling procedures for that operation occurrence. - type: array - items: - $ref: "#/definitions/AffectedVirtualStorage" - changedInfo: - description: > - Information about the changed VNF instance information, including - changed VNF configurable properties. - Shall be present if the "notificationStatus" is set to "RESULT" and - the operation has performed any changes to VNF instance information, - including VNF configurable properties. - Shall be absent otherwise. - $ref: "#/definitions/VnfInfoModifications" - changedExtConnectivity: - description: > - Information about changed external connectivity, if this notification - represents the result of a lifecycle operation occurrence. - Shall be present if the "notificationStatus" is set to "RESULT" and - the "operation" has made any changes to the external connectivity of - the VNF instance. Shall be absent otherwise. - Only information about external VL instances that have been added or - modified shall be provided. - type: array - items: - $ref: "#/definitions/ExtVirtualLinkInfo" - error: - description: > - Details of the latest error, if one has occurred during executing - the LCM operation (see clause 6.3 of ETSI GS NFV-SOL 013). - Shall be present if the "operationState" attribute is "FAILED_TEMP", "FAILED" - or "ROLLED_BACK" and shall be absent otherwise. - $ref: "SOL002SOL003_def.yaml#/definitions/ProblemDetails" - _links: - description: > - Links to resources related to this notification. - $ref: "#/definitions/LccnLinks" - VnfIdentifierCreationNotification: description: > This type represents a VNF identifier creation notification, which @@ -1539,11 +819,18 @@ definitions: id: description: > Identifier of the VNFC instance of which the information is to be modified. + The identifier references the "id" attribute in a "VnfcInfo" structure. + The attribute "id" in this data type represents the same identifier as the attribute + "vnfcInstanceId" in other related data types in the present document. For reasons of + backward compatibility, this misalignment is not corrected. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcConfigurableProperties: description: > Changes of the configurable properties of the VNFC instance. + When this structure is part of a request, the modifications signalled in this attribute + shall be applied according to the rules of JSON Merge Patch (see IETF RFC 7396). $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + VnfcInfo: description: > This type represents the information about a VNFC instance that is part of a VNF instance. It shall comply with the @@ -1552,7 +839,6 @@ definitions: required: - id - vduId - - vnfcResourceInfoId - vnfcState properties: id: @@ -1568,6 +854,8 @@ definitions: description: > Identifier of the VnfcResourceInfo instance representing the virtualised resources used by this VNFC instance. + Shall be present in case a corresponding VnfcResourceInfo instance exists. + This allows to represent the error condition that a VNFC instance has lost its resources. $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf" vnfcState: description: > @@ -1590,4 +878,81 @@ definitions: Configurable properties referred in this attribute are declared in the VNFD. This attribute can be modified with the PATCH method - $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" \ No newline at end of file + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + + ModificationsTriggeredByVnfPkgChange: + description: > + This type represents attribute modifications that were performed on an "Individual VNF instance" resource when + changing the current VNF package. The attributes that can be included consist of those requested to be modified + explicitly in the "ChangeCurrentVnfPkgRequest" data structure, and additional attributes of the "VnfInstance" + data structure that were modified implicitly during the operation. + type: object + properties: + vnfConfigurableProperties: + description: > + This attribute signals the modifications of the "vnfConfigurableProperties" attribute in "VnfInstance" performed + by the operation and shall be present if that attribute was modified during the operation. + This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value + of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at + its completion. + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + metadata: + description: > + This attribute signals the modifications of the "metadata" attribute in "VnfInstance" performed by the operation + and shall be present if that attribute was modified during the operation. + This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value + of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at + its completion. + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + extensions: + description: > + This attribute signals the modifications of the "extensions" attribute in "VnfInstance" performed by the operation and + shall be present if that attribute was modified during the operation. + This attribute represents the delta (semantics as per IETF RFC 7386, JSON Merge Patch) between the value + of the attribute at the start of the "Change current VNF package" operation and the value of the attribute at + its completion. + $ref: "SOL002SOL003_def.yaml#/definitions/KeyValuePairs" + vnfdId: + description: > + If present, this attribute signals the new value of the "vnfdId" attribute in "VnfInstance". + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" + vnfProvider: + description: > + If present, this attribute signals the new value of the "vnfProvider" attribute in "VnfInstance". If present, + this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related + operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified + by the "vnfdId" attribute. + type: string + vnfProductName: + description: > + If present, this attribute signals the new value of the "vnfProductName" attribute in "VnfInstance". If present, + this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related + operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified + by the "vnfdId" attribute. + type: string + vnfSoftwareVersion: + description: > + If present, this attribute signals the new value of the "vnfSoftwareVersion" attribute in "VnfInstance". If present, + this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related + operation, and contains a copy of the value of he related attribute from the VNFD in the VNF Package identified + by the "vnfdId" attribute. + $ref: "SOL002SOL003_def.yaml#/definitions/Version" + vnfdVersion: + description: > + If present, this attribute signals the new value of the "vnfdVersion" attribute in "VnfInstance". If present, + this attribute (which depends on the value of the "vnfdId" attribute) was modified implicitly during the related + operation, by copying the value of this attribute from the VNFD in the VNF Package identified by the "vnfdId" + attribute. + $ref: "SOL002SOL003_def.yaml#/definitions/Version" + + LcmOpOccNotificationVerbosityType: + description: > + The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation + occurrence notifications. + * FULL: This signals a full notification which contains all change details. + * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to + be sent via the notification mechanism. + type: string + enum: + - FULL + - SHORT \ No newline at end of file diff --git a/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml b/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml index 9b6e1c4733b90ce00746d91069b6ffc7c42257ac..52e47ec29572cadcb4ac5f9748aaafe96e80bd80 100644 --- a/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml +++ b/src/definitions/SOL002SOL003VNFPerformanceManagement_def.yaml @@ -125,6 +125,7 @@ definitions: - id - notificationType - timeStamp + - pmJobId - objectType - objectInstanceId - _links @@ -147,6 +148,10 @@ definitions: description: > Date and time of the generation of the notification. $ref: "SOL002SOL003_def.yaml#/definitions/DateTime" + pmJobId: + description: > + Identifier of the PM job for which performance information is available. + $ref: "SOL002SOL003_def.yaml#/definitions/Identifier" objectType: description: > Type of the measured object. @@ -180,7 +185,7 @@ definitions: objectInstance: description: > Link to the resource representing the measured object instance to which the - notified change applies. Shall be present if the measured object instance + notification applies. Shall be present if the measured object instance information is accessible as a resource. $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink" pmJob: @@ -296,8 +301,7 @@ definitions: Type of the measured object. The applicable measured object type for a measurement is defined in clause 7.2 of ETSI GS NFV-IFA 027. - type: - string + type: string objectInstanceIds: description: > Identifiers of the VNF instances for which performance information @@ -383,6 +387,11 @@ definitions: This type represents modifications to a PM job. It shall comply with the provisions defined in table 6.5.2.12-1. type: object + oneOf: + - required: + - callbackUri + - required: + - authentication properties: callbackUri: description: > @@ -394,7 +403,7 @@ definitions: New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body, these modifications shall be applied according to the - rules of JSON Merge PATCH. + rules of JSON Merge Patch (see IETF RFC 7396). This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" @@ -418,7 +427,7 @@ definitions: performanceMetricGroup: description: > Group of performance metrics. A metric group is a pre-defined list - of metrics, known to the producer that it can decompose to + of metrics, known to the API producer that it can decompose to individual metrics. Valid values are specified as "Measurement Group" values in clause 7.2 of ETSI GS NFV-IFA 027. At least one of the two attributes (performance metric or group) @@ -428,9 +437,9 @@ definitions: type: string collectionPeriod: description: > - Specifies the periodicity at which the producer will collect + Specifies the periodicity at which the API producer will collect performance information. The unit shall be seconds. - At the end of each reportingPeriod, the producer will inform the + At the end of each reportingPeriod, the API producer will inform the consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the @@ -444,10 +453,10 @@ definitions: # Done using min and max params to set a range for positive int. reportingPeriod: description: > - Specifies the periodicity at which the producer will report to the - consumer. about performance information. The unit shall be seconds. - At the end of each reportingPeriod, the producer will inform the - consumer about availability of the performance data collected for + Specifies the periodicity at which the API producer will report to the + API consumer. about performance information. The unit shall be seconds. + At the end of each reportingPeriod, the API producer will inform the + API consumer about availability of the performance data collected for each completed collection period during this reportingPeriod. The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case, the performance data for the @@ -535,6 +544,11 @@ definitions: This type represents modifications to a threshold. It shall comply with the provisions defined in table 6.5.2.11-1. type: object + oneOf: + - required: + - callbackUri + - required: + - authentication properties: callbackUri: description: > @@ -546,7 +560,7 @@ definitions: New value of the "authentication" attribute, or "null" to remove the attribute. If present in a request body, these modifications shall be applied according to the - rules of JSON Merge PATCH. + rules of JSON Merge PATCH (see IETF RFC 7396). This attribute shall not be present in response bodies. At least one of the attributes defined in this type shall be present in request bodies. $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication" diff --git a/src/definitions/SOL002SOL003_def.yaml b/src/definitions/SOL002SOL003_def.yaml index abd9749817fd3b5d1e7679d504d1055e5640fe54..d4249c5e1c300cc321b65049f996e75b2a691d4e 100644 --- a/src/definitions/SOL002SOL003_def.yaml +++ b/src/definitions/SOL002SOL003_def.yaml @@ -93,6 +93,17 @@ definitions: This type represents subscription filter criteria to match VNF instances. type: object + anyOf: + - oneOf: + - required: + - vnfdId + - required: + - vnfProductsFromProviders + - oneOf: + - required: + - vnfInstanceIds + - required: + - vnfInstanceNames properties: vnfdIds: description: > @@ -194,14 +205,8 @@ definitions: the identifier of that VIM. type: object required: - - id - vimType properties: - id: - description: > - The identifier of the VIM Connection. This identifier is managed by - the NFVO. - $ref: "#/definitions/Identifier" vimId: description: > The identifier of the VIM instance. This identifier is managed by @@ -313,14 +318,30 @@ definitions: properties: cpdId: description: > - The identifier of the CPD in the VNFD. + The identifier of the CPD in the VNFD. In case this identifier refers to a CPD with trunking enabled, + the external CP instances created from this CPD will represent ports in a trunk. + + NOTE: In case this identifier refers to a CPD with trunking enabled, the external CP instances created + from this CPD will represent ports in a trunk. $ref: "#/definitions/IdentifierInVnfd" cpConfig: description: > - List of instance data that need to be configured on the CP instances + Map of instance data that need to be configured on the CP instances created from the respective CPD. - type: array - items: + The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. + The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). + Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. + Thus, given a particular value of the “cpdId” attribute, there shall be one “cpConfig” entry for each VNFC + instance that has been or can be created from a VDU which includes a CPD identified by the “cpdId” attribute. + If the cpConfig represents a subport in a trunk, all “cpConfig” entries in this list shall have the same + segmentationId, which means they are connected to the same set of external VLs via the trunk. + The map entry value shall be set to "null" in order to delete a "VnfExtCpConfig" entry identified by a + particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed + by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance + in case it represents a subport. Deleting the last key from the map removes the affected instance of the + "VnfExtCpData" structure from its parent data structure. + type: object + additionalProperties: $ref: "#/definitions/VnfExtCpConfig" VnfExtCpConfig: @@ -331,13 +352,19 @@ definitions: 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. + anyOf: + - required: + - linkPortId + - required: + - cpProtocolData type: object properties: - cpInstanceId: + parentCpConfigId: 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. + Value of the key that identifies the "VnfExtCpConfig" map entry which corresponds to the parent port of the + trunk. Reference to the "VnfExtCpConfig" entry that corresponds to the parent port of the trunk. Only present + in "VnfExtCpConfig" structures that provide configuration information for a CP which represents a sub-port in + a trunk, and if parent ports are supported. $ref: "#/definitions/IdentifierInVnf" linkPortId: description: > @@ -345,20 +372,17 @@ definitions: will be associated. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": - 1) The "linkPortId" and "cpProtocolData" attributes shall both be - absent for the deletion of an existing external CP instance - addressed by cpInstanceId. - 2) At least one of these attributes shall be present for a - to-be-created external CP instance or an existing external + 1) At least one of the "linkPortId" and "cpProtocolData" attributes shall + be present for a to-be-created external CP instance or an existing external CP instance. - 3) If the "linkPortId" attribute is absent, the VNFM shall create a + 2) If the "linkPortId" attribute is absent, the VNFM shall create a link port. - 4) If the "cpProtocolData" attribute is absent, the "linkPortId" + 3) 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. - 5) If both "cpProtocolData" and "linkportId" are provided, the API + 4) 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" @@ -368,12 +392,13 @@ definitions: that connects the CP to a VL. The following conditions apply to the attributes "linkPortId" and "cpProtocolData": - 1) The "linkPortId" and "cpProtocolData" attributes shall both be - absent for the deletion of an existing external CP instance - addressed by cpInstanceId. - 2) At least one of these attributes shall be present for a - to-be-created external CP instance or an existing external - CP instance. + 1) Void + 2) At least one of the "linkPortId" and "cpProtocolData" attributes + shall be present for an external CP instance representing a subport + that is to be created, or an external CP instance that is to be created + by creating the corresponding VNFC or VNF instance during the current or + a subsequent LCM operation, or for an existing external CP instance + that is to be re-configured or added to a particular external virtual link. 3) If the "linkPortId" attribute is absent, the VNFM shall create a link port. 4) If the "cpProtocolData" attribute is absent, the "linkPortId" @@ -416,6 +441,18 @@ definitions: description: > This type represents network address data for IP over Ethernet. type: object + anyOf: + - required: + - macAddress + - required: + - ipAddresses + oneOf: + - required: + - fixedAddresses + - required: + - numDynamicAddresses + - required: + - ipAddressRange properties: macAddress: description: > @@ -423,6 +460,16 @@ definitions: the VIM. At least one of "macAddress" or "ipAddresses" shall be present. $ref: "#/definitions/MacAddress" + segmentationId: + description: > + Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a + subport in a trunk, segmentationId shall be present. Otherwise it shall not be present. + Depending on the NFVI networking infrastructure, the segmentationId may indicate the actual network segment + value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an + identifier used between the application and the NFVI networking infrastructure to identify the network + sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local + segmentationId to whatever segmentationId is actually used by the NFVI’s transport technology. + type: string ipAddresses: description: > List of IP addresses to assign to the CP instance. Each entry @@ -535,42 +582,6 @@ definitions: items: $ref: "#/definitions/ExtLinkPortData" - ExtManagedVirtualLinkData: - type: object - required: - - id - - virtualLinkDescId - - resourceId - properties: - id: - description: > - The identifier of the externally-managed internal VL instance. The - identifier is assigned by the NFV-MANO entity that manages this VL - instance. - $ref: "#/definitions/Identifier" - vnfVirtualLinkDescId: - description: > - The identifier of the VLD in the VNFD for this VL. - $ref: "#/definitions/IdentifierInVnfd" - vimConnectionId: - description: > - Identifier of the VIM connection to manage this resource. This - attribute shall only be supported and present if VNF-related - 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" - Identifier: description: > An identifier with the intention of being globally unique. @@ -623,6 +634,12 @@ definitions: A number defined in IETF RFC 8259. type: number + UnsignedInt: + description: > + Unsigned integer number + type: integer + minimum: 0 + IdentifierInVnfd: description: > An identifier that is unique within a VNF descriptor. @@ -647,9 +664,32 @@ definitions: Representation: string of variable length. type: string + Checksum: #no definition found + description: > + Cheksum description + type: string + ######################################################################################################################## # TO CHECK IF INCLUDE THESE DATA TYPES IN ANOTHER DEF FILES + VnfLinkPortData: + description: > + This type represents an externally provided link port to be used to connect a VNFC connection point + to an exernally managed VL. + type: object + required: + - vnfLinkPortId + - resourceHandle + properties: + vnfLinkPortId: + description: > + Identifier of this link port as provided by the entity that has created the link port. + $ref: "#/definitions/Identifier" + resourceHandle: + description: > + Resource handle of the virtualised resource that realizes the link port. + $ref: "#/definitions/ResourceHandle" + ExtLinkPortData: description: > This type represents an externally provided link port to be used to @@ -683,6 +723,9 @@ definitions: HEAL | Represents the "Heal VNF" LCM operation. OPERATE | Represents the "Operate VNF" LCM operation. CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation. + CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation. + CREATE_SNAPSHOT | Represents the "Create VNF snapshot" LCM operation. + REVERT_TO_SNAPSHOT | Represents the "Revert to VNF snapshot" LCM operation. type: string enum: - INSTANTIATE @@ -693,6 +736,9 @@ definitions: - HEAL - OPERATE - CHANGE_EXT_CONN + - CHANGE_VNFPKG + - CREATE_SNAPSHOT + - REVERT_TO_SNAPSHOT LcmOperationType: description: > @@ -706,7 +752,10 @@ definitions: HEAL | Represents the "Heal VNF" LCM operation. OPERATE | Represents the "Operate VNF" LCM operation. CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation. - MODIFY_INFO | Represents the "Modify VNF Information" LCM operation. + MODIFY_INFO | Represents the "Modify VNF Information" LCM operation. + CREATE_SNAPSHOT | Represents the "Create VNF Snapshot" LCM operation. + REVERT_TO_SNAPSHOT | Represents the “Revert-To VNF Snapshot" LCM operation. + CHANGE_VNFPKG | Represents the "Change current VNF package" LCM operation. type: string enum: - INSTANTIATE @@ -718,6 +767,9 @@ definitions: - OPERATE - CHANGE_EXT_CONN - MODIFY_INFO + - CREATE_SNAPSHOT + - REVERT_TO_SNAPSHOT + - CHANGE_VNFPKG ProblemDetails: #SOL003 location: 4.3.5.3 @@ -857,94 +909,4 @@ definitions: 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" - - AffectedVnfc: - description: > - This type provides information about added, deleted, modified and - temporary VNFCs. - type: object - required: - - id - - vduId - - changeType - - computeResource - properties: - id: - description: > - Identifier of the Vnfc instance, identifying the applicable - "vnfcResourceInfo" entry in the "VnfInstance" data type. - $ref: "#/definitions/IdentifierInVnf" - vduId: - description: > - Identifier of the related VDU in the VNFD. - $ref: "#/definitions/IdentifierInVnfd" - changeType: - description: > - Signals the type of change. Permitted values: - * ADDED - * REMOVED - * MODIFIED - * TEMPORARY - For a temporary resource, an AffectedVnfc structure exists as long - as the temporary resource exists. - type: string - enum: - - ADDED - - REMOVED - - MODIFIED - - TEMPORARY - computeResource: - description: > - Reference to the VirtualCompute resource. Detailed information is - (for new and modified resources) or has been (for removed - resources) available from the VIM. - $ref: "#/definitions/ResourceHandle" - resourceDefinitionId: - description: > - The identifier of the "ResourceDefinition" in the granting exchange - related to the LCM operation occurrence. It shall be present when - an applicable GrantInfo for thegranted resource exists. See note. - $ref: "#/definitions/IdentifierLocal" - zoneId: - description: > - The identifier of the resource zone, as managed by the resource management - layer (typically, the VIM), where the referenced VirtualCompute resource is placed. - Shall be provided if this information is available from the VIM. - $ref: "#/definitions/Identifier" - metadata: - description: > - Metadata about this resource. - The content of this attribute shall be a copy of the content of the - "metadata" attribute of the VnfcResourceInfo structure. - $ref: "#/definitions/KeyValuePairs" - affectedVnfcCpIds: - description: > - Identifiers of CP(s) of the VNFC instance that were affected by the - change. - Shall be present for those affected CPs of the VNFC instance that - are associated to an external CP of the VNF instance. - May be present for further affected CPs of the VNFC instance. - type: array - items: - $ref: "#/definitions/IdentifierInVnf" - addedStorageResourceIds: - description: > - References to VirtualStorage resources that have been added. Each - value refers to a VirtualStorageResourceInfo item in the - VnfInstance that was added to the VNFC. It shall be provided if at - least one storage resource was added to the VNFC. - type: array - items: - $ref: "#/definitions/IdentifierInVnf" - removedStorageResourceIds: - description: > - References to VirtualStorage resources that have been removed. - The value contains the identifier of a VirtualStorageResourceInfo - item that has been removed from the VNFC, and might no longer exist - in the VnfInstance. - It shall be provided if at least one storage resource was removed - from the VNFC. - type: array - items: - $ref: "#/definitions/IdentifierInVnf" \ No newline at end of file + $ref: "#/definitions/Uri" \ No newline at end of file diff --git a/src/endpoints/SOL002SOL003_endpoints.yaml b/src/endpoints/SOL002SOL003_endpoints.yaml index 9ae760eda97938b04a18504100a77e833457de86..977eb5a1a1d0539b4fa7add01eee3745dad16029 100644 --- a/src/endpoints/SOL002SOL003_endpoints.yaml +++ b/src/endpoints/SOL002SOL003_endpoints.yaml @@ -3,12 +3,7 @@ endpoints: api-versions: parameters: - - name: Version - description: > - Version of the API requested to use when responding to this request. - in: header - required: false - type: string + - $ref: ../components/SOL002SOL003_params.yaml#/components/parameters/Version get: summary: Retrieve API version information description: > @@ -16,37 +11,60 @@ endpoints: table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported. responses: - 200: - description: > - 200 OK - - API version information was read successfully. - The response body shall contain 4.4 API version - information, as defined in clause 4.4.1.13. + "200": + $ref: '#/components/responses/ApiVersions.Get' + "400": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/400 + "401": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/401 + "403": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/403 + "404": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/404 + "405": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/405 + "406": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/406 + "413": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/413 + "414": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/414 + "416": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/416 + "422": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/422 + "429": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/429 + "500": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/500 + "503": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/503 + "504": + $ref: ../responses/SOL002SOL003_resp.yaml#/components/responses/504 + +components: + responses: + ApiVersions.Get: + description: > + 200 OK + + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: schema: - $ref: '../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' - headers: - Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Version: - description: The used API version. - type: string - maximum: 1 - minimum: 1 - 400: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/400' } - 401: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/401' } - 403: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/403' } - 404: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/404' } - 405: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/405' } - 406: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/406' } - 413: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/413' } - 414: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/414' } - 416: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/416' } - 422: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/422' } - 429: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/429' } - 500: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/500' } - 503: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/503' } - 504: { $ref: '../responses/SOL002SOL003_resp.yaml#/responses/504' } \ No newline at end of file + $ref: '../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' \ No newline at end of file diff --git a/src/responses/SOL002SOL003_resp.yaml b/src/responses/SOL002SOL003_resp.yaml index bfb8b1d77ed710c9279560bd13688f67f563e1a2..d1e0e0896e1c8523a9d1cdc76bea9aa6f545a22f 100644 --- a/src/responses/SOL002SOL003_resp.yaml +++ b/src/responses/SOL002SOL003_resp.yaml @@ -1,571 +1,661 @@ # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt -responses: - 206: - description: > - 206 PARTIAL CONTENT - headers: - Content-Type: - description: > - The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 - Content-Range: - description: > - The Content-Range response HTTP header indicates where in a full body message a partial message belongs. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 303: - description: > - 303 See Other - 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 - - 400: - description: > - 400 BAD REQUEST - - 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the - "ProblemDetails" structure to be returned. - - If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect - query parameters or the payload body contains a syntactically incorrect data structure), - the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, - and should include in the "detail" attribute more information about the source of the problem. - - If the response to a GET request which queries a container resource would be so big that the performance - of the API producer is adversely affected, and the API producer does not support paging for the affected resource, - it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include - in the "detail" attribute more information about the source of the problem. - - If there is an application error related to the client's input that cannot be easily mapped to any other - HTTP response code ("catch all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information - about the source of the problem. - - If the request contains a malformed access token, the API producer should respond with this response. - The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 - and IETF RFC 7235. The ProblemDetails structure may be provided. - - The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 - for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 401: - description: > - 401 UNAUTHORIZED - - If the request contains no access token even though one is required, or if the request contains an authorization - token that is invalid (e.g. expired or revoked), the API producer should respond with this response. - The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 - and IETF RFC 7235. The ProblemDetails structure may be provided. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 403: - description: > - 403 FORBIDDEN - - If the API consumer is not allowed to perform a particular request to a particular resource, - the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. - It should include in the "detail" attribute information about the source of the problem, - and may indicate how to solve it. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 404: - description: > - 404 NOT FOUND - - If the API producer did not find a current representation for the resource addressed by the URI passed - in the request or is not willing to disclose that one exists, it shall respond with this response code. - The "ProblemDetails" structure may be provided, including in the "detail" attribute information about - the source of the problem, e.g. a wrong resource URI variable. - - This response code is not appropriate in case the resource addressed by the URI is a container resource - which is designed to contain child resources, but does not contain any child resource at the time - the request is received. For a GET request to an existing empty container resource, a typical response - contains a 200 OK response code and a payload body with an empty array. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 405: - description: > - 405 METHOD NOT ALLOWED - - If a particular HTTP method is not supported for a particular resource, the API producer shall respond - with this response code. The "ProblemDetails" structure may be omitted. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 406: - description: > - 406 NOT ACCEPTABLE - - If the "Accept" HTTP header does not contain at least one name of a content type - that is acceptable to the API producer, the API producer shall respond with this - response code. The "ProblemDetails" structure may be omitted. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 409: - description: > - 409 CONFLICT - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 412: - description: > - 412 PRECONDITION FAILED - - Error: A precondition given in an HTTP request header is not fulfilled. - Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. - The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey - more information about the error. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 413: - description: > - 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. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 414: - description: > - 414 URI TOO LONG - - If the request URI of a request is longer than the API producer is willing or able to process, - it shall respond with this response code. This condition can e.g. be caused by passing long queries - in the request URI of a GET request. The "ProblemDetails" structure may be omitted. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 416: - description: > - 416 Range Not Satisfiable - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 422: - description: > - 422 UNPROCESSABLE ENTITY - - If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data - cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond - with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" - attribute more information about the source of the problem. - - This error response code is only applicable for methods that have a request body. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 429: - description: > - 429 TOO MANY REQUESTS - - If the API consumer has sent too many requests in a defined period of time and the API producer is able - to detect that condition ("rate limiting"), the API producer shall respond with this response code, - following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. - The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information - about the source of the problem. - - The period of time and allowed number of requests are configured within the API producer by means - outside the scope of the present document. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 500: - description: > - 500 INTERNAL SERVER ERROR - - If there is an application error not related to the client's input that cannot be easily mapped to any other - HTTP response code ("catch all error"), the API producer shall respond with this response code. - The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information - about the source of the problem. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 503: - description: > - 503 SERVICE UNAVAILABLE - - If the API producer encounters an internal overload situation of itself or of a system it relies on, - it should respond with this response code, following the provisions in IETF RFC 7231 for the use of - the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" - structure may be omitted. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" - - 504: - description: > - 504 GATEWAY TIMEOUT - - If the API producer encounters a timeout while waiting for a response from an upstream server - (i.e. a server that the API producer communicates with when fulfilling a request), it should respond - with this response code. - 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/SOL002SOL003_def.yaml#/definitions/ProblemDetails" \ No newline at end of file +components: + responses: + 206: + description: > + 206 PARTIAL CONTENT + headers: + Content-Type: + description: > + The MIME type of the body of the response. + schema: + type: string + maximum: 1 + minimum: 1 + Content-Range: + description: > + The Content-Range response HTTP header indicates where in a full body message a partial message belongs. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 303: + description: > + 303 See Other + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + + 400: + description: > + 400 BAD REQUEST + + 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the + "ProblemDetails" structure to be returned. + + If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect + query parameters or the payload body contains a syntactically incorrect data structure), + the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, + and should include in the "detail" attribute more information about the source of the problem. + + If the response to a GET request which queries a container resource would be so big that the performance + of the API producer is adversely affected, and the API producer does not support paging for the affected resource, + it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include + in the "detail" attribute more information about the source of the problem. + + If there is an application error related to the client's input that cannot be easily mapped to any other + HTTP response code ("catch all error"), the API producer shall respond with this response code. + The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information + about the source of the problem. + + If the request contains a malformed access token, the API producer should respond with this response. + The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 + and IETF RFC 7235. The ProblemDetails structure may be provided. + + The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 + for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 401: + description: > + 401 UNAUTHORIZED + + If the request contains no access token even though one is required, or if the request contains an authorization + token that is invalid (e.g. expired or revoked), the API producer should respond with this response. + The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 + and IETF RFC 7235. The ProblemDetails structure may be provided. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 403: + description: > + 403 FORBIDDEN + + If the API consumer is not allowed to perform a particular request to a particular resource, + the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. + It should include in the "detail" attribute information about the source of the problem, + and may indicate how to solve it. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 404: + description: > + 404 NOT FOUND + + If the API producer did not find a current representation for the resource addressed by the URI passed + in the request or is not willing to disclose that one exists, it shall respond with this response code. + The "ProblemDetails" structure may be provided, including in the "detail" attribute information about + the source of the problem, e.g. a wrong resource URI variable. + + This response code is not appropriate in case the resource addressed by the URI is a container resource + which is designed to contain child resources, but does not contain any child resource at the time + the request is received. For a GET request to an existing empty container resource, a typical response + contains a 200 OK response code and a payload body with an empty array. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 405: + description: > + 405 METHOD NOT ALLOWED + + If a particular HTTP method is not supported for a particular resource, the API producer shall respond + with this response code. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 406: + description: > + 406 NOT ACCEPTABLE + + If the "Accept" HTTP header does not contain at least one name of a content type + that is acceptable to the API producer, the API producer shall respond with this + response code. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 409: + description: > + 409 CONFLICT + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 412: + description: > + 412 PRECONDITION FAILED + + Error: A precondition given in an HTTP request header is not fulfilled. + Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. + The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey + more information about the error. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 413: + description: > + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 414: + description: > + 414 URI TOO LONG + + If the request URI of a request is longer than the API producer is willing or able to process, + it shall respond with this response code. This condition can e.g. be caused by passing long queries + in the request URI of a GET request. The "ProblemDetails" structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 416: + description: > + 416 Range Not Satisfiable + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 422: + description: > + 422 UNPROCESSABLE ENTITY + + If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data + cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond + with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" + attribute more information about the source of the problem. + + This error response code is only applicable for methods that have a request body. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 429: + description: > + 429 TOO MANY REQUESTS + + If the API consumer has sent too many requests in a defined period of time and the API producer is able + to detect that condition ("rate limiting"), the API producer shall respond with this response code, + following the provisions in IETF RFC 6585 [17] for the use of the "Retry-After" HTTP header. + The "ProblemDetails" structure shall be provided and shall include in the "detail" attribute more information + about the source of the problem. + + The period of time and allowed number of requests are configured within the API producer by means + outside the scope of the present document. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 500: + description: > + 500 INTERNAL SERVER ERROR + + If there is an application error not related to the client's input that cannot be easily mapped to any other + HTTP response code ("catch all error"), the API producer shall respond with this response code. + The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information + about the source of the problem. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 503: + description: > + 503 SERVICE UNAVAILABLE + + If the API producer encounters an internal overload situation of itself or of a system it relies on, + it should respond with this response code, following the provisions in IETF RFC 7231 for the use of + the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" + structure may be omitted. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" + + 504: + description: > + 504 GATEWAY TIMEOUT + + If the API producer encounters a timeout while waiting for a response from an upstream server + (i.e. a server that the API producer communicates with when fulfilling a request), it should respond + with this response code. + headers: + Content-Type: + description: The MIME type of the body of the response. + schema: + 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. + schema: + type: string + maximum: 1 + minimum: 0 + Version: + description: > + Version of the API used in the response. + schema: + type: string + maximum: 1 + minimum: 1 + content: + application/json: + schema: + $ref: "../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails" \ No newline at end of file