VNFPackageManagementNotification.yaml 9.73 KB
Newer Older
1
2
openapi: 3.0.2

3
info:
4
5
  title: SOL005 - VNF Package Management Notification interface
  description: |
6
7
8
    SOL005 - VNF Package Management Notification interface
    IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification
    it refers to. In case of discrepancies the published ETSI Group Specification takes precedence.
9
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
10
  license:
11
    name: ETSI Forge copyright notice
12
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
13
14
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

15
externalDocs:
16
  description: ETSI GS NFV-SOL 005 V3.3.1
17
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.03.01_60/gs_nfv-sol005v030301p.pdf
18
19
20
21
22
23

servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1


24
25
paths:
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification':
26
27
28
29
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
30
      summary: Notify about VNF package onboarding or change
31
      description: |
32
33
        The POST method delivers a notification from the API producer to an API consumer.
        The API consumer shall have previously created an "individual subscription resource" with a matching filter.
34
      parameters:
35
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
36
      responses:
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
        "204":
          $ref: '#/components/responses/VnfPackageOnboardingNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
53

54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    post:
      summary: Notify about VNF package onboarding or change
      description: |
        The POST method delivers a notification from the API producer to an API consumer.
        The API consumer shall have previously created an "individual subscription resource" with a matching filter.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageOnboardingNotificationRequest'
      responses:
        "204":
          $ref: '#/components/responses/VnfPackageOnboardingNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
81

82
83
84
85
  /URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
86
    get:
87
88
89
90
      summary: Test the notification endpoint
      description: |
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
        e.g. during subscription.
91
      parameters:
92
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
93
      responses:
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        "204":
          $ref: '#/components/responses/VnfPackageChangeNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
110

111
112
    post:
      summary: Notify about VNF package onboarding or change
113
114
115
116
      description: |
        The POST method delivers a notification from the server to the client. This method shall follow the provisions
        specified in the Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters, request and response data
        structures, and response codes.
117
      parameters:
118
119
120
121
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageChangeNotificationRequest'
122
      responses:
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
        "204":
          $ref: '#/components/responses/VnfPackageChangeNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
139

140
141
142
143
144
145
146
147
148
149
components:
  requestBodies:
    VnfPackageOnboardingNotificationRequest:
      description: |
        A notification about on-boarding of a VNF package.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageOnboardingNotification
      required: true
150

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
    VnfPackageChangeNotificationRequest:
      description: |
        A notification about changes of status in a VNF package.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagementNotification_def.yaml#/definitions/VnfPackageChangeNotification
      required: true

  responses:
    VnfPackageOnboardingNotification.Get:
      description: |
        204 No Content
        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}
183

184
185
186
187
188
189
190
191
192
193
194
195
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
    VnfPackageOnboardingNotification.Post:
      description: |
        204 No Content
        Shall be returned when the notification has been delivered successfully.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    VnfPackageChangeNotification.Get:
      description: |
        204 No Content
        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    VnfPackageChangeNotification.Post:
      description: |
        204 No Content
        Shall be returned when the notification has been delivered successfully.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}