Commit 4cb43914 authored by Francesca Moscatelli's avatar Francesca Moscatelli
Browse files

SOL002 initial migration to OpenAPI v3.0.2

parent cd75e32f
Pipeline #3565 failed with stage
in 0 seconds
swagger: "2.0" openapi: 3.0.2
info: info:
version: "1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL002 - API version interface title: SOL002 - API version interface
description: > description: |
SOL002 - API version Interface SOL002 - API version Interface IMPORTANT: Please note that this file might be not aligned to the current version of
IMPORTANT: Please note that this file might be not aligned to the current the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies
version of the ETSI Group Specification it refers to and has not been the published ETSI Group Specification takes precedence.
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/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
name: NFV-SOL WG
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 002 V2.7.1 description: ETSI GS NFV-SOL 002 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf 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
paths: paths:
############################################################################### /vnfconfig/api_versions:
# API Versions #
###############################################################################
'/vnfconfig/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
/vnffm/api_versions:
'/vnffm/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
/vnfind/api_versions:
'/vnfind/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
/vnflcm/api_versions:
'/vnflcm/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
/vnfpm/api_versions:
'/vnfpm/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
\ No newline at end of file
swagger: "2.0" openapi: 3.0.2
info: info:
version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL002 - VNF Configuration interface title: SOL002 - VNF Configuration interface
description: > description: |
SOL002 - VNF Configuration Interface SOL002 - VNF Configuration Interface IMPORTANT: Please note that this file might be not aligned to the current
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
version of the ETSI Group Specification it refers to and has not been discrepancies the published ETSI Group Specification takes precedence.
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/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
name: NFV-SOL WG
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 002 V2.7.1 description: ETSI GS NFV-SOL 002 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
basePath: /vnfconfig/v1 servers:
- url: http://127.0.0.1/vnfconfig/v1
schemes: - url: https://127.0.0.1/vnfconfig/v1
- http
- https
consumes:
- application/json
produces:
- application/json
paths: paths:
############################################################################### /api_versions:
# API Versions #
###############################################################################
'/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
############################################################################### /configuration:
# VNF Configuration #
###############################################################################
'/configuration':
parameters: parameters:
- name: Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
description: > - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
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: get:
summary: Read VNF/VNFC configuration from VNF 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. The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
responses: responses:
200: "200":
description: > $ref: '#/components/responses/Configuration.Get'
200 OK "400":
$ref: ../../responses/SOL002SOL003_resp.yaml#/responses/400
Shall be returned when configuration information about a VNF instance "401":
has been read successfully. $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/401
The response body shall contain a representation of the configuration resource. "403":
schema: $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/403
$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration' "404":
headers: $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/404
Content-Type: "405":
description: The MIME type of the body of the response. $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/405
type: string "406":
maximum: 1 $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/406
minimum: 1 "422":
Version: $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/422
description: The used API version. "429":
type: string $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/429
maximum: 1 "500":
minimum: 1 $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/500
WWW-Authenticate: "503":
description: > $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/503
Challenge if the corresponding HTTP request has not provided "504":
authorization, or error details if the corresponding HTTP $ref: ../../responses/SOL002SOL003_resp.yaml#/responses/504
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"
patch: patch:
summary: Modify VNF/VNFC configuration. summary: Modify VNF/VNFC configuration.
description: This method sets or modifies a configuration resource. description: This method sets or modifies a configuration resource.
parameters: requestBody:
- name: configModifications $ref: '#/components/requestBodies/ConfigurationRequest'
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'
responses: responses:
200: "200":
description: > $ref: '#/components/responses/Configuration.Patch'
200 OK "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":
$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
Shall be returned when the request has been accepted and completed. components:
The response body shall contain the parameters of the configuration requestBodies:
modification that was applied to the configuration resource. ConfigurationRequest:
description: |
The parameter for the configuration modification, as defined in clause 9.5.2.2.
content:
application/json:
schema: schema:
$ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications' $ref: ./definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications
headers: required: true
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
# Shall be returned upon the following error: A precondition given responses:
# in an HTTP request header is not fulfilled. Configuration.Get:
# Typically, this is due to an ETag mismatch, indicating that the resource description: |
# was modified by another entity. The response body should contain a 200 OK
# ProblemDetails structure, in which the "detail" attribute should convey 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.
# more information about the error. headers:
# schema: Version:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412" description: The used API version.
416: style: simple
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" explode: false
422: schema:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" type: string
429: WWW-Authenticate:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" description: |
500: Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" style: simple
503: explode: false
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" schema:
504: type: string
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" Content-Type:
\ No newline at end of file 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
swagger: "2.0" openapi: 3.0.2
info: info:
version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
title: SOL002 - VNF Fault Management interface title: SOL002 - VNF Fault Management interface
description: > description: |
SOL002 - VNF Fault Management interface SOL002 - VNF Fault Management interface IMPORTANT: Please note that this file might be not aligned to the current
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.
version of the ETSI Group Specification it refers to and has not been In case of discrepancies the published ETSI Group Specification takes precedence.
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/bugzilla/buglist.cgi?component=Nfv-Openapis
contact:
name: NFV-SOL WG
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
name: NFV-SOL WG
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 002 V2.7.1 description: ETSI GS NFV-SOL 002 V3.3.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
basePath: /vnffm/v1 servers:
- url: http://127.0.0.1/vnffm/v1
schemes: - url: https://127.0.0.1/vnffm/v1
- http
- https
consumes:
- application/json
produces:
- application/json
paths: paths:
############################################################################### /api_versions:
# API Versions #
###############################################################################
'/api_versions':
$ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
############################################################################### /alarms:
# Alarms #
###############################################################################
'/alarms':
#SOL003 location: 7.4.2
parameters: parameters:
- name: Version - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
description: > - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
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: get:
description: > description: |
The client can use this method to retrieve information about the alarm The client can use this method to retrieve information about the alarm list.
list.
parameters: parameters:
- name: Accept - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
description: > - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
Content-Types that are acceptable for the response. - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
Reference: IETF RFC 7231 - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
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
responses: responses:
200: "200":
description: > $ref: '#/components/responses/Alarms.Get'
200 OK "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
Shall be returned when information about zero or more alarms was queried successfully. /alarms/{alarmId}:
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: