VNFIndicatorNotification.yaml 5.89 KB
Newer Older
Gergely Csatari's avatar
Gergely Csatari committed
1
2
3
swagger: "2.0"

info:
4
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
Giacomo Bernini's avatar
Giacomo Bernini committed
5
  title: SOL003 - VNF Indicator Notification Interface
6
  description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
7
    SOL003 - VNF Indicator Notification interface
8

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

13
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
Gergely Csatari's avatar
Gergely Csatari committed
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
18

externalDocs:
19
20
  description: ETSI GS NFV-SOL 003 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.pdf
Gergely Csatari's avatar
Gergely Csatari committed
21
22
23
24
25
26
27
28
29
30
31
32

basePath: "/callback/v1"

schemes:
  - https

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

paths:
33
34
35
  ###############################################################################
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
  ###############################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIndicatorValueChangeNotification':
Gergely Csatari's avatar
Gergely Csatari committed
37
38
39
    #SOL003 location: 8.4.7
    post:
      description: >
40
41
42
43
44
        Notify.
        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.
        This method shall follow the provisions specified in the tables 8.4.7.3.1-1 and 8.4.7.3.1-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
45
46
47
48
49
50
51
52
      parameters:
        - name: AlarmListRebuiltNotification
          description: >
            Information that the alarm list has been rebuilt by the VNFM
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification"
Gergely Csatari's avatar
Gergely Csatari committed
53
54
55
56
57
58
59
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
60
61
62
63
64
65
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
Gergely Csatari's avatar
Gergely Csatari committed
66
67
      responses:
        204:
68
          description: >
69
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
70

71
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
72
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
73
74
75
76
77
78
79
80
81
          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
82
83
84
85
86
87
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
88
89
90
91
92
93
94
95
96
97
98
99
100
101
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        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"
102

Gergely Csatari's avatar
Gergely Csatari committed
103
104
    get:
      description: >
105
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
106
107
108
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 8.4.7.3.2-1 and 8.4.7.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
109
110
111
112
113
114
115
116
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
117
118
119
120
121
122
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
Gergely Csatari's avatar
Gergely Csatari committed
123
124
      responses:
        204:
125
          description: >
126
            204 NO CONTENT
127
            Shall be returned to indicate that the notification endpoint has been tested successfully.
Gergely Csatari's avatar
Gergely Csatari committed
128
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
129
130
131
132
133
134
135
136
137
          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
138
139
140
141
142
143
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
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"
        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:
157
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"