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