VNFLifecycleManagementNotification.yaml 9.66 KB
Newer Older
1 2 3
swagger: "2.0"

info:
4
  version: "1.2.0"
5
  title: SOL003 - VNF Lifecycle Management Notification interface
6
  description: >
7 8
    SOL003 - VNF Lifecycle Management 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 42

basePath: "/callback/v1"

schemes:
  - https

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

paths:
###############################################################################
43
# Notification endpoint VnfLcmOperationOccurrenceNotification                      #
44 45 46 47
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification':
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
48 49 50
        Notify


51 52 53
        The POST method delivers a notification from the server to the client.
      parameters:
        - name: VnfLcmOperationOccurrenceNotification
54
          description: A notification about on-boarding of a VNF package.
55 56 57
          in: body
          required: true
          schema:
58
            $ref: "definitions/VNFLifecycleManagementNotification_def.yaml#/definitions/VnfLcmOperationOccurrenceNotification"
Gergely Csatari's avatar
Gergely Csatari committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
73 74 75 76 77 78
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
79 80 81
      responses:
        204:
          description: > 
82 83
            No Content

84
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
85 86 87 88 89 90 91 92 93
          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
94 95 96 97 98 99
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
100 101 102 103 104 105 106
        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:
107
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
108 109 110 111 112 113 114 115 116 117 118 119 120 121
        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"
###############################################################################
# Notification endpoint VnfIdentifierCreationNotification                     #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification':
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
122 123 124
        Notify


125 126 127 128 129 130 131 132 133 134
        The POST method delivers a notification from the server to the client.
      parameters:
        - name: VnfIdentifierCreationNotification
          description: >
            A notification about the creation of a VNF identifier and the
            related VNF instance resource.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierCreationNotification"
Gergely Csatari's avatar
Gergely Csatari committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
149 150 151 152 153 154
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
155 156 157
      responses:
        204:
          description: > 
158 159
            No Content

160
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
161 162 163 164 165 166 167 168 169
          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
170 171 172 173 174 175
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
176 177 178 179 180 181 182
        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:
183
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
184 185 186 187 188 189 190 191 192 193 194 195 196 197
        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"
###############################################################################
# Notification endpoint VnfIdentifierDeletionNotification                     #
###############################################################################
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification':
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
198 199 200
        Notify

        
201 202 203 204 205 206 207 208 209 210
        The POST method delivers a notification from the server to the client.
      parameters:
        - name: VnfIdentifierDeletionNotification
          description: >
            A notification about the deletion of a VNF identifier and the
            related VNF instance resource.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfIdentifierDeletionNotification"
Gergely Csatari's avatar
Gergely Csatari committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
225 226 227 228 229 230
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
231 232 233
      responses:
        204:
          description: > 
234 235
            No Content

236
            The notification was delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
237 238 239 240 241 242 243 244 245
          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
246 247 248 249 250 251
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
252 253 254 255 256 257 258
        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:
259
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
260 261 262 263 264 265 266 267
        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"