Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL002-SOL003
Commits
3ffe4064
Commit
3ffe4064
authored
May 08, 2019
by
moscatelli
Browse files
SOL002: VNF Fault mgmt notification interface updated with multiple body types
parent
01d7376b
Pipeline
#895
passed with stage
in 0 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @
3ffe4064
...
...
@@ -34,9 +34,23 @@ produces:
paths
:
###############################################################################
# Notification endpoint
AlarmNotification
#
# Notification endpoint
#
###############################################################################
'
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification'
:
'
/URI-is-provided-by-the-client-when-creating-the-subscription'
:
parameters
:
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
post
:
description
:
>
Notify
...
...
@@ -49,276 +63,23 @@ paths:
description
:
>
Information of a VNF alarm.
in
:
body
required
:
tru
e
required
:
fals
e
schema
:
$ref
:
"
../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Content-Type
description
:
>
The Content-Type header shall be set to
"application/merge-patch+json" according to
IETF RFC 7396.
in
:
header
required
:
true
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
The notification was delivered 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.
type
:
string
maximum
:
1
minimum
:
0
Version
:
description
:
>
Version of the API used in the response.
type
:
string
maximum
:
1
minimum
:
1
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"
get
:
description
:
>
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
parameters
:
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
The notification endpoint was 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.
type
:
string
maximum
:
1
minimum
:
0
Version
:
description
:
>
Version of the API used in the response.
type
:
string
maximum
:
1
minimum
:
1
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"
###############################################################################
# Notification endpoint AlarmClearedNotification #
###############################################################################
'
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification'
:
post
:
description
:
>
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
parameters
:
-
name
:
AlarmClearedNotification
description
:
>
Information of the clearance of a VNF alarm
in
:
body
required
:
tru
e
required
:
fals
e
schema
:
$ref
:
"
../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Content-Type
description
:
>
The Content-Type header shall be set to
"application/merge-patch+json" according to
IETF RFC 7396.
in
:
header
required
:
true
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
The notification was delivered 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.
type
:
string
maximum
:
1
minimum
:
0
Version
:
description
:
>
Version of the API used in the response.
type
:
string
maximum
:
1
minimum
:
1
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"
get
:
description
:
>
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
parameters
:
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
The notification endpoint was 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.
type
:
string
maximum
:
1
minimum
:
0
Version
:
description
:
>
Version of the API used in the response.
type
:
string
maximum
:
1
minimum
:
1
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"
###############################################################################
# Notification endpoint AlarmListRebuiltNotification #
###############################################################################
'
/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification'
:
post
:
description
:
>
Notify
The POST method notifies a VNF alarm or that the alarm list has been
rebuilt.
parameters
:
-
name
:
AlarmListRebuiltNotification
description
:
>
Information that the alarm list has been rebuilt by the VNFM
in
:
body
required
:
tru
e
required
:
fals
e
schema
:
$ref
:
"
../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Content-Type
description
:
>
The Content-Type header shall be set to
...
...
@@ -327,16 +88,10 @@ paths:
in
:
header
required
:
true
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
204 NO CONTENT
The notification was delivered successfully.
The response body shall be empty.
...
...
@@ -373,24 +128,10 @@ paths:
description
:
>
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
parameters
:
-
name
:
Authorization
description
:
>
The authorization token for the request.
Reference: IETF RFC 7235
in
:
header
required
:
false
type
:
string
-
name
:
Version
description
:
>
Version of the API requested to use when responding to this request.
in
:
header
required
:
true
type
:
string
responses
:
204
:
description
:
>
No Content
201 NO CONTENT
The notification endpoint was tested successfully.
The response body shall be empty.
...
...
@@ -422,4 +163,4 @@ paths:
500
:
$ref
:
"
../../responses/SOL002SOL003_resp.yaml#/responses/500"
503
:
$ref
:
"
../../responses/SOL002SOL003_resp.yaml#/responses/503"
$ref
:
"
../../responses/SOL002SOL003_resp.yaml#/responses/503"
\ No newline at end of file
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment