VNFIndicatorNotification.yaml 4.61 KB
Newer Older
1
2
3
swagger: "2.0"

info: 
4
  version: "1.2.0"
5
  title: "SOL002 - VNF Indicator Notification Endpoint interface"
6
  description: >
7
8
    VNF Indicator Notification Endpoint interface of ETSI NFV SOL002

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
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
16
  
17
18
19
20
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

21
22
externalDocs:
  description: ETSI GS NFV-SOL 002 V2.4.1
23
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
24

25
schemes:
26
27
28
29
30
31
32
33
34
35
36
37
38
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json


paths:

    /notificationendpoint:
39
40
41
42
43
44
45
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
      post:
        summary: Notification endpoint
        description: >
          The API producer can use this resource to send notifications related to VNF indicator
          value changes to a subscribed API consumer, which has provided the URI of this resource
          during the subscription process.
          The POST method delivers a notification from the server to the client.
        parameters:
         - name: vnfIndicatorValueChangeNotification
           in: body
           description: >
             A notification about VNF indicator value changes.
           required: true
           schema: 
             $ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'                  
        responses:
          204:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
64
65
              No Content

66
              The notification was delivered successfully. The response body shall be empty.
67
68
69
70
71
72
73
            headers:
              Version:
                description: The used API version.
                type: string
                maximum: 1
                minimum: 1

74
75
76
77
78
79
80
81
82
83
84
85
86
87
          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' }
          409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
      get:
        summary: Test notification endpoint.
        description: >
Gergely Csatari's avatar
Gergely Csatari committed
88
89
          Service Unavailable

90
91
92
93
94
          The GET method allows the server to test the notification endpoint that is provided
          by the client, e.g. during subscription.
        responses:
          204:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
95
96
              No Content

97
              The notification endpoint was tested successfully. The response body shall be empty.
98
99
100
101
102
103
            headers:
              Version:
                description: The used API version.
                type: string
                maximum: 1
                minimum: 1
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
          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' }
          409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }