NFVManoLogManagementNotification.yaml 9.42 KB
Newer Older
1
2
openapi: 3.0.2
info:
3
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
4
  title: SOL009 - NFV-MANO Log Management Notification Operation
5
  description: >
6
    SOL009 - NFV-MANO Log Management Notification Operation
7
8
9
10
11
12
13
14
15

    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.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
16
  description: ETSI GS NFV-SOL 009 V3.5.1
17
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.05.01_60/gs_NFV-SOL009v030501p.pdf
18
19
20
21
22
23

security:
  - OauthSecurity:
      - all

servers:
Giacomo Bernini's avatar
Giacomo Bernini committed
24
25
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
26
27

paths:
28
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:
29
30
31
32
33
34
35
36
37
    description: >-
      This resource represents a notification endpoint for NFV-MANO log management.
      The API producer can use this resource to send notifications related to log management events to a
      subscribed API consumer, which has provided the URI of this resource during the subscription process.

    post:
      description: >-
        The POST method delivers a notification regarding a log management event from the API producer to the API
        consumer. The API consumer shall have previously created an "Individual subscription" resource with a
38
        matching filter. See clause 8.5.9.3.1.
39
      parameters:
40
41
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
42
43
44
45
      requestBody:
        $ref: "#/components/requestBodies/LogReportAvailableNotification"
      responses:
        "204":
46
          $ref: '#/components/responses/notification.post.204'
47
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
48
          $ref: '../components/SOL009_resp.yaml#/components/responses/400'
49
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
50
          $ref: '../components/SOL009_resp.yaml#/components/responses/401'
51
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: '../components/SOL009_resp.yaml#/components/responses/403'
53
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: '../components/SOL009_resp.yaml#/components/responses/404'
55
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
56
          $ref: '../components/SOL009_resp.yaml#/components/responses/405'
57
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
58
          $ref: '../components/SOL009_resp.yaml#/components/responses/406'
59
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
60
          $ref: '../components/SOL009_resp.yaml#/components/responses/422'
61
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
62
          $ref: '../components/SOL009_resp.yaml#/components/responses/500'
63
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
64
          $ref: '../components/SOL009_resp.yaml#/components/responses/503'
65
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
66
          $ref: '../components/SOL009_resp.yaml#/components/responses/504'
67
68
69
70

    get:
      description: >-
        The GET method allows the API producer to test the notification endpoint that is provided by the API
71
        consumer, e.g. during subscription. See clause 8.5.9.3.2.
72
      parameters:
73
74
75
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
76
77
      responses:
        "204":
78
          $ref: '#/components/responses/notification.get.204'
79
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
80
          $ref: '../components/SOL009_resp.yaml#/components/responses/400'
81
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
82
          $ref: '../components/SOL009_resp.yaml#/components/responses/401'
83
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
84
          $ref: '../components/SOL009_resp.yaml#/components/responses/403'
85
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
86
          $ref: '../components/SOL009_resp.yaml#/components/responses/404'
87
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
88
          $ref: '../components/SOL009_resp.yaml#/components/responses/405'
89
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: '../components/SOL009_resp.yaml#/components/responses/406'
91
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: '../components/SOL009_resp.yaml#/components/responses/422'
93
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: '../components/SOL009_resp.yaml#/components/responses/500'
95
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: '../components/SOL009_resp.yaml#/components/responses/503'
97
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
98
          $ref: '../components/SOL009_resp.yaml#/components/responses/504'
99
100
101
102
103
104
105
106
107
108
109
110

components:
  requestBodies:
    LogReportAvailableNotification:
      description: >-
        Notification about the availability of a log report.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/LogReportAvailableNotification"

  responses:
111
    notification.post.204:
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
      description: >-
        Shall be returned when the notification has been delivered successfully.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          schema:
            type: string
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

132
    notification.get.204:
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
      description: >-
        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          schema:
            type: string
        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.
          schema:
            type: string
        Version:
          description: >
            Version of the API used in the response.
          schema:
            type: string

  schemas:
    LogReportAvailableNotification:
      description: >-
        This notification informs the receiver that the log report of the NFV-MANO functional entity is available.
        It shall comply with the provisions defined in table 8.6.2.4-1.
        The notification shall be triggered by the NFV-MANO functional entity when log information has been collected
        by the logging job and the log report is available.
      type: object
      required:
        - id
        - notificationType
        - subscriptionId
        - timeStamp
        - objectInstanceId
        - _links
      properties:
        id:
          description: >-
            Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions,
            the "id" attribute of all these notifications shall have the same value.
174
          $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
175
176
177
178
179
180
181
182
        notificationType:
          description: >-
            Discriminator for the different notification types.
            Shall be set to "LogReportAvailableNotification" for this notification type.
          type: string
        subscriptionId:
          description: >-
            Identifier of the subscription that this notification relates to.
183
          $ref: '../components/SOL009_schemas.yaml#/components/schemas/Identifier'
184
185
186
        timeStamp:
          description: >-
            Date and time of the generation of the notification.
187
          $ref: '../components/SOL009_schemas.yaml#/components/schemas/DateTime'
188
189
190
191
        objectInstanceId:
          description: >-
            Identifier that identifies the object instance for which the log report is available.
            This attribute shall contain the identifier of the logged object according to their type.
192
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
193
194
195
196
197
198
199
200
201
202
203
        _links:
          description: >-
            Links to resources related to this notification.
          type: object
          required:
            - subscription
            - logReports
          properties:
            subscription:
              description: >-
                Link to the related subscription.
204
              $ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
205
206
207
208
            objectInstance:
              description: >-
                Link to the resource representing the measured object instance to which the notified change applies.
                Shall be present if the measured object instance information is accessible as a resource.
209
              $ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
210
211
212
            LoggingJob:
              description: >-
                Link to the resource that represents the logging job for which the log report is available.
213
              $ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'
214
215
216
217
218
219
220
            logReports:
              description: >-
                Link from which the available log report can be obtained. Due to the relationship of the logging
                job compilation and the logging information availability reporting, more than one logReport
                notification link can be provided.
              type: array
              items:
221
                $ref: '../components/SOL009_schemas.yaml#/components/schemas/NotificationLink'