VNFConfiguration.yaml 6.95 KB
Newer Older
1
swagger: "2.0"
moscatelli's avatar
moscatelli committed
2

Giacomo Bernini's avatar
Giacomo Bernini committed
3
info:
4
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
moscatelli's avatar
moscatelli committed
5
  title: SOL002 - VNF Configuration interface
6
  description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
7
    SOL002 - VNF Configuration Interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
Giacomo Bernini's avatar
Giacomo Bernini committed
9
10
11
12
    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
13
  license:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Giacomo Bernini's avatar
Giacomo Bernini committed
16
  contact:
moscatelli's avatar
moscatelli committed
17
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  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
22

23
basePath: /vnfconfig/v1
24

Giacomo Bernini's avatar
Giacomo Bernini committed
25
schemes:
26
27
  - http
  - https
moscatelli's avatar
moscatelli committed
28

Giacomo Bernini's avatar
Giacomo Bernini committed
29
consumes:
30
  - application/json
moscatelli's avatar
moscatelli committed
31

Giacomo Bernini's avatar
Giacomo Bernini committed
32
produces:
33
  - application/json
34

35
paths:
Giacomo Bernini's avatar
Giacomo Bernini committed
36
37
38
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
39
  '/api_versions':
40
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
Giacomo Bernini's avatar
Giacomo Bernini committed
41
42
43
44
45

  ###############################################################################
  # VNF Configuration                                                           #
  ###############################################################################
  '/configuration':
46
47
48
49
50
51
52
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
53
54
55
56
57
58
59
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
60
61
62
63
64
65
66
    get:
      summary: Read VNF/VNFC configuration from VNF
      description: >
        The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
      responses:
        200:
          description: >
67
            200 OK
68
69
70
            
            Shall be returned when configuration information about a VNF instance 
            has been read successfully.
Giacomo Bernini's avatar
Giacomo Bernini committed
71
72
            The response body shall contain a representation of the configuration resource.
          schema:
73
            $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfiguration'
Giacomo Bernini's avatar
Giacomo Bernini committed
74
75
76
77
78
79
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
80
81
82
83
84
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
            WWW-Authenticate:
              description: >
                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:
102
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
103
104
105
106
107
108
109
110
111
112
113
114
        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
115
116
117
118
119
120
121
122
123
124
125
    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:
Giacomo Bernini's avatar
Giacomo Bernini committed
126
            $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
Giacomo Bernini's avatar
Giacomo Bernini committed
127
128
129
      responses:
        200:
          description: >
130
            200 OK
Giacomo Bernini's avatar
Giacomo Bernini committed
131

132
133
134
            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.
Giacomo Bernini's avatar
Giacomo Bernini committed
135
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
136
            $ref: 'definitions/SOL002VNFConfiguration_def.yaml#/definitions/VnfConfigModifications'
Giacomo Bernini's avatar
Giacomo Bernini committed
137
138
139
140
141
142
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
143
144
145
146
147
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
148
149
150
151
152
153
154
155
156
        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:
157
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
158
159
160
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        412:
161
162
          # description: >
          #   412 PRECONDITION FAILED
163

164
165
166
167
168
169
170
          #   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:
171
172
173
174
175
176
177
178
179
180
181
182
183
          $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"