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

18
externalDocs:
Giacomo Bernini's avatar
Giacomo Bernini committed
19
20
  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
21

22
basePath: /vnfconfig/v1
23

Giacomo Bernini's avatar
Giacomo Bernini committed
24
schemes:
25
26
  - http
  - https
27
  -
Giacomo Bernini's avatar
Giacomo Bernini committed
28
consumes:
29
  - application/json
30
  -
Giacomo Bernini's avatar
Giacomo Bernini committed
31
produces:
32
  - application/json
33

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

  ###############################################################################
  # VNF Configuration                                                           #
  ###############################################################################
  '/configuration':
45
46
47
48
49
50
51
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
52
53
54
55
56
57
58
      - 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
59
60
61
62
63
64
65
    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: >
66
            200 OK
Giacomo Bernini's avatar
Giacomo Bernini committed
67
68
69
70
71
72
73
74
75
76
            Configuration information about a VNF instance was read successfully.
            The response body shall contain a representation of the configuration resource.
          schema:
            $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfiguration'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
77
78
79
80
81
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
            WWW-Authenticate:
              description: >
                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/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"
Giacomo Bernini's avatar
Giacomo Bernini committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
    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/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
      responses:
        200:
          description: >
129
            200 OK
Giacomo Bernini's avatar
Giacomo Bernini committed
130
131
132
133
134
135
136
137
138
139
140

            The request was accepted and completed. The response body shall contain the parameters
            of the configuration modification that was applied to the configuration resource.
          schema:
            $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
141
142
143
144
145
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
        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/404"
        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"