...
 
Commits (42)
......@@ -27,6 +27,57 @@ produces:
- "application/json"
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
minimum: 1
400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
###############################################################################
# Alarms #
###############################################################################
'/alarms':
......@@ -38,16 +89,16 @@ paths:
The client can use this method to retrieve information about the alarm list.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string.
The OSS/BSS may supply filtering parameters.
The following attribute names shall be supported in attribute-based
filtering parameters:
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
The following attribute names shall be supported by the NFVO in the filter
expression:
- id
- nsInstanceId
- rootCauseFaultyComponent.faultyNestedNsInstanceId
......@@ -57,6 +108,13 @@ paths:
- eventType
- perceivedSeverity
- probableCause
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -82,8 +140,11 @@ paths:
description: >
200 OK
The request has succeeded.
Information about zero or more alarms was queried successfully.
The response body shall contain the list of related alarms.
If the NFVO supports alternative 2 (paging) according to
clause 4.7.2.1 for this resource, inclusion of the Link HTTP header
in this response shall follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -104,6 +165,12 @@ paths:
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
......@@ -441,16 +508,23 @@ paths:
Table 8.4.4.3.2-1: URI query parameters supported.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI
query string. The OSS/BSS may supply filtering parameters.
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI
query string. The OSS/BSS may supply this parameter.
All attribute names that appear in the FmSubscription and in data types
referenced from it shall be supported in attribute-based filtering parameters.
referenced from it shall be supported by the NFVO in the filter expression.
- name: nextpage_opaque_marker
in: query
description: >
Marker to obtain the next page of a paged response. Shall be supported by the NFVO
if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -484,9 +558,13 @@ paths:
200 OK
The list of subscriptions was queried successfully.
The response body shall contain the representations of
all active subscriptions of the functional block that
invokes the method.
The response body shall contain in an array the representations
of all active subscriptions of the functional block that invokes
the method, i.e. zero or more representations of FM subscriptions,
as defined in clause 8.5.2.3.
If the NFVO supports alternative 2 (paging) according to
clause 4.7.2.1 for this resource, inclusion of the Link HTTP header
in this response shall follow the provisions in clause 4.7.2.3.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -507,6 +585,12 @@ paths:
type: string
maximum: 1
minimum: 1
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
schema:
type: array
items:
......
......@@ -168,11 +168,11 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarm:
description: >
Link to the resource that represents the related alarm.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
AlarmListRebuiltNotification:
description: >
......@@ -221,11 +221,11 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarms:
description: >
Link to the alarm list, i.e. the "Alarms" resource.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
AlarmModifications:
description: >
......@@ -345,7 +345,8 @@ definitions:
$ref: "#/definitions/PerceivedSeverityType"
eventTypes:
description: >
Match VNF alarms with an event type listed in this attribute.
Match VNF alarms related to NSs with an event type listed
in this attribute.
type: array
items:
$ref: "#/definitions/EventType"
......@@ -534,7 +535,7 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarm:
description: >
Link to the resource that represents the related alarm.
......
......@@ -35,7 +35,6 @@ definitions:
- lcmOperationType
- startTime
- isAutomaticInvocation
- operationParams
- isCancelPending
- _links
properties:
......@@ -86,6 +85,11 @@ definitions:
- UPDATE: UpdateNsRequest
- HEAL: HealNsRequest
- TERMINATE: TerminateNsRequest
This attribute shall be present if this data type is returned
in a response to reading an individual resource, and may
be present according to the chosen attribute selector
parameter if this data type is returned in a response to a
query of a container resource.
type: string
enum:
- INSTANTIATE
......
......@@ -355,13 +355,13 @@ definitions:
The identifier of the externally-managed internal VL
instance, if provided.
$ref: "#/definitions/Identifier"
virtualLinkDescId:
vmfVirtualLinkDescId:
description: >
The identifier of the VLD in the VNFD for this VL.
$ref: "#/definitions/IdentifierInVnfd"
vimId:
description: >
Identifier of the VIMthat manage this resource. This
Identifier of the VIM that manage this resource. This
attribute shall only be supported and present if VNFrelated
resource management in direct mode is applicable.
$ref: "#/definitions/Identifier"
......
......@@ -147,11 +147,11 @@ definitions:
Link to the resource representing the VNF package to
which the notified change applies, i.e. the individual on boarded
VNF package resource that represents the VNF package.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
VnfPackageSoftwareImageInfo:
description: >
......@@ -537,6 +537,7 @@ definitions:
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfPkgId
- vnfdId
......@@ -564,7 +565,7 @@ definitions:
$ref: "SOL005_def.yaml#/definitions/DateTime"
vnfPkgId:
description: >
Identifier of the on-boarded VNF package. This identifier
Identifier of the VNF package. This identifier
is allocated by the NFVO.
Its value is the same as the value of the "id" attribute of
the related "Individual VNF package" resource.
......@@ -596,6 +597,7 @@ definitions:
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfPkgId
- vnfdId
......