Commit e2704a70 authored by moscatelli's avatar moscatelli
Browse files

SOL002: VNF Configuration interface consolidation

parent 94d75a0e
Pipeline #891 passed with stage
in 0 seconds
...@@ -14,17 +14,23 @@ info: ...@@ -14,17 +14,23 @@ info:
url: https://forge.etsi.org/etsi-forge-copyright-notice.txt url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
contact: contact:
name: "NFV-SOL WG" name: "NFV-SOL WG"
externalDocs: externalDocs:
description: ETSI GS NFV-SOL 002 V2.5.1 description: ETSI GS NFV-SOL 002 V2.5.1
url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
basePath: /vnfconfig/v1 basePath: /vnfconfig/v1
schemes: schemes:
- http - http
- https - https
-
consumes: consumes:
- application/json - application/json
-
produces: produces:
- application/json - application/json
paths: paths:
############################################################################### ###############################################################################
# API Versions # # API Versions #
...@@ -43,6 +49,13 @@ paths: ...@@ -43,6 +49,13 @@ paths:
in: header in: header
required: true required: true
type: string 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: >
...@@ -50,7 +63,7 @@ paths: ...@@ -50,7 +63,7 @@ paths:
responses: responses:
200: 200:
description: > description: >
OK 200 OK
Configuration information about a VNF instance was read successfully. Configuration information about a VNF instance was read successfully.
The response body shall contain a representation of the configuration resource. The response body shall contain a representation of the configuration resource.
schema: schema:
...@@ -66,21 +79,38 @@ paths: ...@@ -66,21 +79,38 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } WWW-Authenticate:
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } description: >
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } Challenge if the corresponding HTTP request has not provided
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } authorization, or error details if the corresponding HTTP
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } request has provided an invalid authorization token.
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } type: string
409: { $ref: 'responses/VNFConfiguration_resp.yaml#/responses/409' } maximum: 1
413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } minimum: 0
414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } 400:
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 401:
429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 403:
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' } 404:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
405:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
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: 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.
...@@ -96,7 +126,7 @@ paths: ...@@ -96,7 +126,7 @@ paths:
responses: responses:
200: 200:
description: > description: >
OK 200 OK
The request was accepted and completed. The response body shall contain the parameters The request was accepted and completed. The response body shall contain the parameters
of the configuration modification that was applied to the configuration resource. of the configuration modification that was applied to the configuration resource.
...@@ -113,17 +143,29 @@ paths: ...@@ -113,17 +143,29 @@ paths:
type: string type: string
maximum: 1 maximum: 1
minimum: 1 minimum: 1
400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 400:
401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } 401:
404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' } 403:
406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } 404:
414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' } 405:
422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
429: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/429' } 406:
500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } 412:
504: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/504' } $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
\ No newline at end of file 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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment