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

info:
4
5
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL003 - VNF Indicator interface
6
  description: >
7
    SOL003 - VNF Indicator interface
8
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=
Gergely Csatari's avatar
Gergely Csatari committed
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.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
30
31
32
33
34
35
36
37
38
39
40
41

basePath: "/callback/v1"

schemes:
  - https

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

paths:
42
43
44
  ###############################################################################
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
  ###############################################################################
Gergely Csatari's avatar
Gergely Csatari committed
45
46
47
48
  '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIndicatorValueChangeNotification':
    #SOL003 location: 8.4.7
    post:
      description: >
49
50
51
52
53
        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
54
55
56
57
58
59
60
61
      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
62
63
64
65
66
67
68
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
69
70
71
72
73
74
        - 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
75
76
      responses:
        204:
77
          description: >
78
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
79

80
            Shall be returned when the notification has been delivered successfully.
Gergely Csatari's avatar
Gergely Csatari committed
81
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
82
83
84
85
86
87
88
89
90
          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
91
92
93
94
95
96
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
        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"
111

Gergely Csatari's avatar
Gergely Csatari committed
112
113
    get:
      description: >
114
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
115
116
117
        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
118
119
120
121
122
123
124
125
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
126
127
128
129
130
131
        - 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
132
133
      responses:
        204:
134
          description: >
135
            204 NO CONTENT
136
            Shall be returned to indicate that the notification endpoint has been tested successfully.
Gergely Csatari's avatar
Gergely Csatari committed
137
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
138
139
140
141
142
143
144
145
146
          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
147
148
149
150
151
152
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
153
154
155
156
157
158
159
160
161
162
163
164
165
        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:
166
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"