Commit 875bd4d7 authored by moscatelli's avatar moscatelli
Browse files

SOL005_8: Link and nextpage_opaque_marker added in NS mgmt and NS performarce...

SOL005_8: Link and nextpage_opaque_marker added in NS mgmt and NS performarce mgmt GET requests + code formatting
parent c2da30f6
Pipeline #512 failed with stage
in 0 seconds
This diff is collapsed.
# Copyright (c) ETSI 2017. # Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt # https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions: definitions:
Identifier: Identifier:
description: > description: >
An identifier with the intention of being globally unique. An identifier with the intention of being globally unique.
type: string type: string
KeyValuePairs: KeyValuePairs:
description: > description: >
This type represents a list of key-value pairs. The order of the pairs in the list is not significant. This type represents a list of key-value pairs. The order of the pairs in the list is not significant.
In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions
defined in clause 4 of IETF RFC 7159. defined in clause 4 of IETF RFC 7159.
type: object type: object
String: String:
description: > description: >
This type represents stack of string values This type represents stack of string values
type: string type: string
Version: Version:
description: > description: >
A Version. A Version.
type: string type: string
Uri: Uri:
description: > description: >
String formatted according to IETF RFC 3986. String formatted according to IETF RFC 3986.
type: string type: string
Link: Link:
description: > description: >
This type represents a link to a resource. This type represents a link to a resource.
type: object type: object
required: required:
- href - href
properties: properties:
href: href:
description: > description: >
URI of the referenced resource. URI of the referenced resource.
type: string type: string
format: url format: url
DateTime: DateTime:
description: > description: >
Date-time stamp. Date-time stamp.
Representation: String formatted according to IETF RFC 3339. Representation: String formatted according to IETF RFC 3339.
type: string type: string
format: "date-time" format: "date-time"
ProblemDetails: ProblemDetails:
#SOL005 location: 4.3.5.3-1 #SOL005 location: 4.3.5.3-1
description: > description: >
The definition of the general "ProblemDetails" data structure from The definition of the general "ProblemDetails" data structure from
IETF RFC 7807 [19] is reproduced in this structure. Compared to the IETF RFC 7807 [19] is reproduced in this structure. Compared to the
general framework defined in IETF RFC 7807 [19], the "status" and general framework defined in IETF RFC 7807 [19], the "status" and
"detail" attributes are mandated to be included by the present document, "detail" attributes are mandated to be included by the present document,
to ensure that the response contains additional textual information about to ensure that the response contains additional textual information about
an error. IETF RFC 7807 [19] foresees extensibility of the an error. IETF RFC 7807 [19] foresees extensibility of the
"ProblemDetails" type. It is possible that particular APIs in the present "ProblemDetails" type. It is possible that particular APIs in the present
document, or particular implementations, define extensions to define document, or particular implementations, define extensions to define
additional attributes that provide more information about the error. additional attributes that provide more information about the error.
The description column only provides some explanation of the meaning to The description column only provides some explanation of the meaning to
Facilitate understanding of the design. For a full description, see Facilitate understanding of the design. For a full description, see
IETF RFC 7807 [19]. IETF RFC 7807 [19].
type: object type: object
required: required:
- statussss - statussss
- detail - detail
properties: properties:
type: type:
description: > description: >
A URI reference according to IETF RFC 3986 [5] that identifies the A URI reference according to IETF RFC 3986 [5] that identifies the
problem type. It is encouraged that the URI provides human-readable problem type. It is encouraged that the URI provides human-readable
documentation for the problem (e.g. using HTML) when dereferenced. documentation for the problem (e.g. using HTML) when dereferenced.
When this member is not present, its value is assumed to be When this member is not present, its value is assumed to be
"about:blank". "about:blank".
type: string type: string
format: URI format: URI
title: title:
description: > description: >
A short, human-readable summary of the problem type. It should not A short, human-readable summary of the problem type. It should not
change from occurrence to occurrence of the problem, except for change from occurrence to occurrence of the problem, except for
purposes of localization. If type is given and other than purposes of localization. If type is given and other than
"about:blank", this attribute shall also be provided. "about:blank", this attribute shall also be provided.
A short, human-readable summary of the problem A short, human-readable summary of the problem
type. It SHOULD NOT change from occurrence to occurrence of the type. It SHOULD NOT change from occurrence to occurrence of the
problem, except for purposes of localization (e.g., using problem, except for purposes of localization (e.g., using
proactive content negotiation; see [RFC7231], Section 3.4). proactive content negotiation; see [RFC7231], Section 3.4).
type: string type: string
status: status:
description: > description: >
The HTTP status code for this occurrence of the problem. The HTTP status code for this occurrence of the problem.
The HTTP status code ([RFC7231], Section 6) generated by the origin The HTTP status code ([RFC7231], Section 6) generated by the origin
server for this occurrence of the problem. server for this occurrence of the problem.
type: integer type: integer
detail: detail:
description: > description: >
A human-readable explanation specific to this occurrence of the A human-readable explanation specific to this occurrence of the
problem. problem.
type: string type: string
instance: instance:
description: > description: >
A URI reference that identifies the specific occurrence of the A URI reference that identifies the specific occurrence of the
problem. It may yield further information if dereferenced. problem. It may yield further information if dereferenced.
type: string type: string
format: URI format: URI
\ No newline at end of file \ No newline at end of file
...@@ -2,7 +2,7 @@ responses: ...@@ -2,7 +2,7 @@ responses:
409-alarm-state-conflict: 409-alarm-state-conflict:
description: > description: >
Conflict Conflict
Error: The operation cannot be executed currently, due Error: The operation cannot be executed currently, due
to a conflict with the state of the "Individual alarm" resource. to a conflict with the state of the "Individual alarm" resource.
Typically, this is due to the fact that the alarm is already Typically, this is due to the fact that the alarm is already
......
...@@ -21,7 +21,7 @@ definitions: ...@@ -21,7 +21,7 @@ definitions:
type: array type: array
items: items:
$ref: "#/definitions/HealVnfData" $ref: "#/definitions/HealVnfData"
NsLcmOpOcc: NsLcmOpOcc:
description: > description: >
This type represents a request a NS lifecycle operation occurrence. This type represents a request a NS lifecycle operation occurrence.
...@@ -33,11 +33,11 @@ definitions: ...@@ -33,11 +33,11 @@ definitions:
- stateEnteredTime - stateEnteredTime
- nsInstanceId - nsInstanceId
- lcmOperationType - lcmOperationType
- startTime - startTime
- isAutomaticInvocation - isAutomaticInvocation
- operationParams - operationParams
- isCancelPending - isCancelPending
- _links - _links
properties: properties:
id: id:
description: > description: >
...@@ -60,7 +60,7 @@ definitions: ...@@ -60,7 +60,7 @@ definitions:
description: > description: >
Type of the actual LCM operation represented by this Type of the actual LCM operation represented by this
lcm operation occurrence. lcm operation occurrence.
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpType" $ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpType"
startTime: startTime:
description: > description: >
Date-time of the start of the operation. Date-time of the start of the operation.
...@@ -92,7 +92,7 @@ definitions: ...@@ -92,7 +92,7 @@ definitions:
- SCALE - SCALE
- UPDATE - UPDATE
- HEAL - HEAL
- TERMINATE - TERMINATE
isCancelPending: isCancelPending:
description: > description: >
If the LCM operation occurrence is in "PROCESSING" If the LCM operation occurrence is in "PROCESSING"
...@@ -174,7 +174,7 @@ definitions: ...@@ -174,7 +174,7 @@ definitions:
type: object type: object
required: required:
- self - self
- nsInstance - nsInstance
properties: properties:
self: self:
description: > description: >
...@@ -198,9 +198,9 @@ definitions: ...@@ -198,9 +198,9 @@ definitions:
$ref: "SOL005_def.yaml#/definitions/Link" $ref: "SOL005_def.yaml#/definitions/Link"
rollback: rollback:
description: > description: >
Link to the task resource that represents the "rollback" Link to the task resource that represents the "rollback"
operation for this LCM operation occurrence, if rolling operation for this LCM operation occurrence, if rolling
back is currently allowed. back is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link" $ref: "SOL005_def.yaml#/definitions/Link"
continue: continue:
description: > description: >
...@@ -219,24 +219,24 @@ definitions: ...@@ -219,24 +219,24 @@ definitions:
This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence.
It shall comply with the provisions defined in Table 6.5.2.16-1.. It shall comply with the provisions defined in Table 6.5.2.16-1..
type: object type: object
required: required:
- cancelMode - cancelMode
properties: properties:
cancelMode: cancelMode:
description: > description: >
Cancellation mode to apply. Cancellation mode to apply.
$ref: "#/definitions/CancelModeType" $ref: "#/definitions/CancelModeType"
CancelModeType: CancelModeType:
description: > description: >
Cancellation mode. Cancellation mode.
The NFVO shall not start any new VNF lifecycle management and resource The NFVO shall not start any new VNF lifecycle management and resource
management operation, and shall wait for the ongoing VNF lifecycle management management operation, and shall wait for the ongoing VNF lifecycle management
and resource management operations in the underlying system, typically the VNFM and resource management operations in the underlying system, typically the VNFM
and VIM, to finish execution or to time out. After that, the NFVO shall put the and VIM, to finish execution or to time out. After that, the NFVO shall put the
operation occurrence into the FAILED_TEMP state. operation occurrence into the FAILED_TEMP state.
The NFVO shall not start any new VNF lifecycle management and resource The NFVO shall not start any new VNF lifecycle management and resource
management operation, shall cancel the ongoing VNF lifecycle management and management operation, shall cancel the ongoing VNF lifecycle management and
resource management operations in the underlying system, typically the VNFM and resource management operations in the underlying system, typically the VNFM and
...@@ -246,14 +246,14 @@ definitions: ...@@ -246,14 +246,14 @@ definitions:
enum: enum:
- GRACEFUL - GRACEFUL
- FORCEFUL - FORCEFUL
HealNsData: HealNsData:
description: > description: >
This type represents the information used to heal a NS. This type represents the information used to heal a NS.
It shall comply with the provisions defined in Table 6.5.3.43-1. It shall comply with the provisions defined in Table 6.5.3.43-1.
type: object type: object
required: required:
- degreeHealing - degreeHealing
properties: properties:
degreeHealing: degreeHealing:
description: > description: >
...@@ -268,11 +268,11 @@ definitions: ...@@ -268,11 +268,11 @@ definitions:
NS resetting to the original instantiation state of the NS NS resetting to the original instantiation state of the NS
- PARTIAL_HEALING - PARTIAL_HEALING
type: string type: string
enum: enum:
- HEAL_RESTORE - HEAL_RESTORE
- HEAL_QOS - HEAL_QOS
- HEAL_RESET - HEAL_RESET
- PARTIAL_HEALING - PARTIAL_HEALING
actionsHealing: actionsHealing:
description: > description: >
Used to specify dedicated healing actions in a Used to specify dedicated healing actions in a
...@@ -290,13 +290,13 @@ definitions: ...@@ -290,13 +290,13 @@ definitions:
order. The healScript, since it refers to a script in the order. The healScript, since it refers to a script in the
NSD, can be used to execute healing actions which NSD, can be used to execute healing actions which
are defined during NS design time. are defined during NS design time.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalParamsforNs: additionalParamsforNs:
description: > description: >
Allows the OSS/BSS to provide additional Allows the OSS/BSS to provide additional
parameter(s) to the healing process at the NS level. parameter(s) to the healing process at the NS level.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
HealVnfData: HealVnfData:
description: > description: >
This type represents the information to heal a VNF that is part of an NS. This type represents the information to heal a VNF that is part of an NS.
...@@ -304,14 +304,14 @@ definitions: ...@@ -304,14 +304,14 @@ definitions:
operation towards the appropriate VNFM. operation towards the appropriate VNFM.
It shall comply with the provisions defined in Table 6.5.3.44-1. It shall comply with the provisions defined in Table 6.5.3.44-1.
type: object type: object
required: required:
- vnfInstanceId - vnfInstanceId
properties: properties:
vnfInstanceId: vnfInstanceId:
description: > description: >
Identifies the VNF instance, part of the NS, requiring a Identifies the VNF instance, part of the NS, requiring a
healing action. healing action.
$ref: "SOL005_def.yaml#/definitions/Identifier" $ref: "SOL005_def.yaml#/definitions/Identifier"
cause: cause:
description: > description: >
Indicates the reason why a healing procedure is required. Indicates the reason why a healing procedure is required.
...@@ -322,7 +322,7 @@ definitions: ...@@ -322,7 +322,7 @@ definitions:
the healing process, specific to the VNF being healed. the healing process, specific to the VNF being healed.
EXAMPLE: Input parameters to VNF-specific healing procedures. EXAMPLE: Input parameters to VNF-specific healing procedures.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs" $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
TerminateNsRequest: TerminateNsRequest:
description: > description: >
This type represents a NS termination request. This type represents a NS termination request.
...@@ -335,7 +335,7 @@ definitions: ...@@ -335,7 +335,7 @@ definitions:
will be terminated automatically at this timestamp. will be terminated automatically at this timestamp.
Cardinality "0" indicates the NS termination takes place immediately Cardinality "0" indicates the NS termination takes place immediately
$ref: "SOL005_def.yaml#/definitions/DateTime" $ref: "SOL005_def.yaml#/definitions/DateTime"
ProblemDetails: ProblemDetails:
description: > description: >
The definition of the general "ProblemDetails" data structure from The definition of the general "ProblemDetails" data structure from
......
...@@ -18,12 +18,12 @@ definitions: ...@@ -18,12 +18,12 @@ definitions:
type: array type: array
items: items:
type: object type: object
required: required:
- objectType - objectType
- objectInstanceId - objectInstanceId
- performanceMetric - performanceMetric
- performanceValue - performanceValue
properties: properties:
objectType: objectType:
description: > description: >
Defines the object type for which performance Defines the object type for which performance
...@@ -31,7 +31,7 @@ definitions: ...@@ -31,7 +31,7 @@ definitions:
shall be set to the nsdId of the NS instance to which the shall be set to the nsdId of the NS instance to which the
performance information relates. performance information relates.
type: string type: string
objectInstanceId: objectInstanceId:
description: > description: >
The object instance for which the performance metric is The object instance for which the performance metric is
reported. reported.
...@@ -46,9 +46,9 @@ definitions: ...@@ -46,9 +46,9 @@ definitions:
description: > description: >
List of performance values with associated timestamp. List of performance values with associated timestamp.
type: array type: array
items: items:
type: object type: object
required: required:
- timeStamp - timeStamp
- performanceValue - performanceValue
properties: properties:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment