VirtualisedResourcesQuotaAvailableNotification.yaml 10.5 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.2.0"
5
  title: SOL003 - Virtualised Resources Quota Available Notification interface
6
  description: >
7
8
    SOL003 - Virtualised Resources Quota Available Notification interface 

9

10
    IMPORTANT: Please note that this file might be not aligned to the current
11
12
13
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

14
15
16
17
18
19
20
    
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
27

externalDocs:
28
29
  description: ETSI GS NFV-SOL 003 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
30
31
32
33
34
35
36
37
38
39
40
41

basePath: "/vrqan/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
42
43
44
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
45
  '/api-versions':
46
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
47

48
49
50
51
52
53
###############################################################################
# Subscriptions                                                               #
###############################################################################
  '/subscriptions':
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
54
55
56
        Subscribe


57
        The POST method creates a new subscription.
58
59
60
61
62
63
64
65
66
67
        Creation of two subscription resources with the same callbackURI and
        the same filter can result in performance degradation and will provide
        duplicates of notifications to the VNFM, and might make sense only in
        very rare use cases. Consequently, the NFVO may either allow creating
        a subscription resource if another subscription resource with the same
        filter and callbackUri already exists (in which case it shall return
        the “201 Created” response code), or may decide to not create a
        duplicate subscription resource (in which case it shall return a
        “303 See Other” response code referencing the existing subscription
        resource with the same filter and callbackUri).
68
      parameters:
Gergely Csatari's avatar
Gergely Csatari committed
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          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
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
91
92
93
94
95
96
        - name: VrQuotaAvailSubscriptionRequest
          description: Details of the subscription to be created.
          in: body
          required: true
          schema:
            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscriptionRequest"
97
98
99
100
101
102
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
103
104
105
      responses:
        201:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
106
107
            Created

108
109
110
111
112
113
114
115
116
117
118
119
120
            Representation of the created subscription resource.
            The HTTP response shall include a "Location" HTTP header that
            points to the created subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
121
122
123
124
125
126
127
128
            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
129
130
131
132
133
134
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
135
136
          schema:
            $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"
137
138
        303:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
139
140
141
142
143
144
145
146
147
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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
157
158
159
        Query Subscription Information

        
160
161
        The GET method allows the server to test the notification endpoint
        that is provided by the client, e.g. during subscription.
Gergely Csatari's avatar
Gergely Csatari committed
162
163
164
165
166
167
168
169
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VrQuotaAvailSubscription 
            and in data types referenced from it shall be supported by the 
            VNFM in the filter expression.
          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 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
189
190
191
192
193
194
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
195
      responses:
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        200:
          description: > 
            OK

            The list of subscriptions was queried successfully.
            The representations body shall contain in an array the representations
            of all active subscriptions of the functional block that invokes the
            method, i.e. zero or more representations of virtualized resource quota
            available subscriptions as defined in clause 11.5.2.3.
            If the VNFM supports alternative 2 (paging) according to clause 
            4.7.2.1 for this resource, inclusion of the Link HTTP header in 
            this response shall follow the provisions in clause 4.7.2.3.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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
222
223
224
225
226
227
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
228
229
230
231
232
233
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
234
235
236
237
          schema:
            type: array
            items:
              $ref: "definitions/VirtualisedResourcesQuotaAvailableNotification_def.yaml#/definitions/VrQuotaAvailSubscription"
238
239
        204:
          description: > 
Gergely Csatari's avatar
Gergely Csatari committed
240
241
            No Content

242
243
            The notification endpoint was tested successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
244
245
246
247
248
249
250
251
252
          headers:
            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
253
254
255
256
257
258
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
        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"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"