NSPerformanceManagementNotification.yaml 11.2 KB
Newer Older
1
openapi: 3.0.2
2 3

info:
4 5
  title: SOL005 - NS Performance Management Notification interface
  description: |
6
    SOL005 - NS Performance Management Notification interface
7

8 9 10
    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.
11
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues
12 13
  contact:
    name: NFV-SOL WG
14
  license:
15
    name: ETSI Forge copyright notice
16
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
18 19

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

23 24 25
servers:
  - url: http://127.0.0.1/callback/v2
  - url: https://127.0.0.1/callback/v2
26

27 28
paths:
  ##################################################################################
29
  # Notification endpoint PerformanceInformationAvailableNotification              #
30
  ##################################################################################
31
  /URI_is_provided_by_the_client_when_creating_the_subscription_PerformanceInformationAvailableNotificatio:
32
    parameters:
33 34 35
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
36 37 38

    post:
      summary: Notify about PM related events
39
      description: |
40 41
        The POST method delivers a notification regarding a performance management event 
        from the API producer to an API consumer. The API consumer shall have previously 
42
        created an "Individual PM job resource" or "Individual threshold resource".
43
        This method shall follow the provisions specified in the
44 45
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
        data strctures, and response codes.
46
      parameters:
47 48 49
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/PerformanceInformationAvailableNotification'
50 51
      responses:
        204:
52
          $ref: '#/components/responses/PerformanceInformationAvailableNotification.Post.204'
53
        400:
54
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
55
        401:
56
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
57
        403:
58
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
59
        404:
60
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
61
        405:
62
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
63
        406:
64
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
65
        500:
66
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
67
        503:
68
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
69 70 71

    get:
      summary: Test the notification endpoint
72
      description: |
73 74 75
        The GET method allows the API producer to test the notification
        endpoint that is provided by the API consumer, e.g. during
        creation of the PM job or threshold resource.
76 77 78 79 80
        This method shall follow the provisions specified in the
        Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      responses:
        204:
81
          $ref: '#/components/responses/PerformanceInformationAvailableNotification.Get.204'
82
        400:
83
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
84
        401:
85
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
86
        403:
87
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
88
        404:
89
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
90
        405:
91
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
92
        406:
93
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
94
        500:
95
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
96
        503:
97
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
98 99 100 101

  ##################################################################################
  # Notification endpoint ThresholdCrossedNotification                             #
  ##################################################################################
102
  /URI_is_provided_by_the_client_when_creating_the_subscription_ThresholdCrossedNotification:
103
    parameters:
104 105 106
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
107 108 109

    post:
      summary: Notify about PM related events
110
      description: |
111 112
        The POST method delivers a notification regarding a performance management event 
        from the API producer to an API consumer. The API consumer shall have previously 
113
        created an "Individual PM job resource" or "Individual threshold resource".
114
        This method shall follow the provisions specified in the
115 116
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters, request and response
        data strctures, and response codes.
117
      parameters:
118 119 120
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/ThresholdCrossedNotification'
121 122
      responses:
        204:
123
          $ref: '#/components/responses/ThresholdCrossedNotification.Post.204'
124
        400:
125
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
126
        401:
127
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
128
        403:
129
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
130
        404:
131
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
132
        405:
133
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
134
        406:
135
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
136
        500:
137
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
138
        503:
139
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
140 141 142

    get:
      summary: Test the notification endpoint
143
      description: |
144 145 146
        The GET method allows the API producer to test the notification
        endpoint that is provided by the API consumer, e.g. during
        creation of the PM job or threshold resource.
147 148 149 150 151
        This method shall follow the provisions specified in the
        Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      responses:
        204:
152
          $ref: '#/components/responses/ThresholdCrossedNotification.Get.204'
153
        400:
154
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
155
        401:
156
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
157
        403:
158
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
159
        404:
160
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
161
        405:
162
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
163
        406:
164
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
165
        500:
166
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
167
        503:
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

components:
  requestBodies:
    PerformanceInformationAvailableNotification:
      description: |
        Notification about performance information availability.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/PerformanceInformationAvailableNotification"
      required: true

    ThresholdCrossedNotification:
      description: |
        Notification about threshold crossing.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagementNotification_def.yaml#/definitions/ThresholdCrossedNotification"
      required: true

  responses:
    PerformanceInformationAvailableNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification was delivered successfully.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PerformanceInformationAvailableNotification.Get.204:
      description: |
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been 
        tested successfully.
        The response body shall be empty.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    ThresholdCrossedNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification was delivered successfully.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    ThresholdCrossedNotification.Get.204:
      description: |
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been 
        tested successfully.
        The response body shall be empty.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string