VNFConfiguration.yaml 5.96 KB
Newer Older
1
openapi: 3.0.2
moscatelli's avatar
moscatelli committed
2

Giacomo Bernini's avatar
Giacomo Bernini committed
3
info:
moscatelli's avatar
moscatelli committed
4
  title: SOL002 - VNF Configuration interface
5
6
7
8
  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.
Giacomo Bernini's avatar
Giacomo Bernini committed
9
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
10
11
  contact:
    name: NFV-SOL WG
12
  license:
moscatelli's avatar
moscatelli committed
13
    name: ETSI Forge copyright notice
14
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
15
  version: 1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
16

17
externalDocs:
18
  description: ETSI GS NFV-SOL 002 V3.3.1
19
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
20

21
22
23
servers:
  - url: http://127.0.0.1/vnfconfig/v1
  - url: https://127.0.0.1/vnfconfig/v1
24

25
paths:
26
  /api_versions:
27
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
Giacomo Bernini's avatar
Giacomo Bernini committed
28

29
  /configuration:
30
    parameters:
31
32
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
Giacomo Bernini's avatar
Giacomo Bernini committed
33
34
    get:
      summary: Read VNF/VNFC configuration from VNF
35
      description: |
Giacomo Bernini's avatar
Giacomo Bernini committed
36
37
        The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
      responses:
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
        "200":
          $ref: '#/components/responses/Configuration.Get'
        "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

Giacomo Bernini's avatar
Giacomo Bernini committed
63
64
65
    patch:
      summary: Modify VNF/VNFC configuration.
      description: This method sets or modifies a configuration resource.
66
67
      requestBody:
        $ref: '#/components/requestBodies/ConfigurationRequest'
Giacomo Bernini's avatar
Giacomo Bernini committed
68
      responses:
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
        "200":
          $ref: '#/components/responses/Configuration.Patch'
        "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
Giacomo Bernini's avatar
Giacomo Bernini committed
97

98
99
100
101
102
103
104
components:
  requestBodies:
    ConfigurationRequest:
      description: |
        The parameter for the configuration modification, as defined in clause 9.5.2.2.
      content:
        application/json:
Giacomo Bernini's avatar
Giacomo Bernini committed
105
          schema:
106
107
            $ref: ./definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications
      required: true
108

109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
  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