Commit 6001fb66 authored by moscatelli's avatar moscatelli
Browse files

SOL002: VNF Indicator data types consolidation

parent 3ffe4064
Pipeline #896 passed with stage
in 0 seconds
...@@ -133,7 +133,7 @@ paths: ...@@ -133,7 +133,7 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -267,7 +267,7 @@ paths: ...@@ -267,7 +267,7 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -355,7 +355,7 @@ paths: ...@@ -355,7 +355,7 @@ paths:
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -425,7 +425,7 @@ paths: ...@@ -425,7 +425,7 @@ paths:
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -478,7 +478,7 @@ paths: ...@@ -478,7 +478,7 @@ paths:
description: Details of the subscription to be created. description: Details of the subscription to be created.
required: true required: true
schema: schema:
$ref: 'definitions/VnfIndicatorSubscriptionRequest_def.yaml#/definitions/VnfIndicatorSubscriptionRequest' $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'
responses: responses:
201: 201:
description: > description: >
...@@ -487,7 +487,7 @@ paths: ...@@ -487,7 +487,7 @@ paths:
The subscription was created successfully. The subscription was created successfully.
The response body shall contain a representation of the created subscription resource. The response body shall contain a representation of the created subscription resource.
schema: schema:
$ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
headers: headers:
Location: Location:
description: > description: >
...@@ -620,7 +620,7 @@ paths: ...@@ -620,7 +620,7 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
...@@ -701,7 +701,7 @@ paths: ...@@ -701,7 +701,7 @@ paths:
maximum: 1 maximum: 1
minimum: 1 minimum: 1
schema: schema:
$ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
400: 400:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
401: 401:
......
definitions:
VnfIndicatorNotificationsFilter:
description: >
This type represents a subscription filter related to notifications about VNF indicator value changes.
At a particular nesting level in the filter structure, the following applies:
All attributes shall match in order for the filter to match (logical "and" between different filter attributes).
If an attribute is an array, the attribute shall match if at least one of the values in the array matches
(logical "or" between the values of one filter attribute).
type: object
properties:
vnfInstanceSubscriptionFilter:
description: >
Filter criteria to select VNF instances about which to notify. This attribute shall not be included
when the VNFM sends a subscription request to a particular VNF instance.
$ref: 'VnfInstanceSubscriptionFilter_def.yaml#/definitions/VnfInstanceSubscriptionFilter'
indicatorIds:
description: >
Match particular VNF indicator identifiers.
type: array
items:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd'
definitions:
VnfIndicatorSubscriptionRequest:
description: >
This type represents a subscription request related to VNF indicator value change notifications.
type: object
required:
- callbackUri
properties:
filter:
description: >
Filter settings for this subscription, to define the subset of all notifications this
subscription relates to. A particular notification is sent to the subscriber if the filter
matches, or if there is no filter.
$ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter'
callbackUri:
description: >
The URI of the endpoint to send the notification to.
type: string
format: URI
authentication:
description: >
Authentication parameters to configure the use of Authorization when sending notifications corresponding
to this subscription. This attribute shall only be present if the subscriber requires authorization of
notifications.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
\ No newline at end of file
definitions:
VnfIndicatorSubscription:
description: >
This type represents a subscription related to notifications about VNF indicator value changes.
type: object
required:
- callbackUri
- id
- _links
properties:
id:
description: >
Identifier of this subscription resource.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier'
filter:
description: >
Filter settings for this subscription, to define the subset of all notifications this subscription
relates to. A particular notification is sent to the subscriber if the filter matches, or if there
is no filter.
$ref: 'VnfIndicatorNotificationsFilter_def.yaml#/definitions/VnfIndicatorNotificationsFilter'
callbackUri:
description: >
The URI of the endpoint to send the notification to.
type: string
format: URI
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link'
definitions:
VnfIndicator:
type: object
required:
- id
- value
- vnfInstanceId
- _links
properties:
id:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd'
name:
type: string
value:
type: object
vnfInstanceId:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier'
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: URI of this resource.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link'
vnfInstance:
description: Link to the VNF instance that the operation applies to.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Link'
definitions:
VnfInstanceSubscriptionFilter:
description: >
This type represents subscription filter criteria to match VNF instances.
* NOTE 1:
The attributes "vnfdIds" and "vnfProductsFromProviders" are alternatives to reference to
VNF instances that are based on certain VNFDs in a filter. They should not be used both
in the same filter instance, but one alternative should be chosen.
* NOTE 2:
The attributes "vnfInstanceIds" and "vnfInstanceNames" are alternatives to reference to
particular VNF instances in a filter. They should not be used both in the same filter instance,
but one alternative should be chosen.
type: object
properties:
vnfdIds:
description: >
If present, match VNF instances that were created based on a VNFD identified by one of the
vnfdId values listed in this attribute. See NOTE 1.
type: array
items:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier'
vnfProductsFromProviders:
description: >
If present, match VNF instances that belong to VNF products from certain providers. See NOTE 1.
type: array
items:
type: object
required:
- vnfProvider
properties:
vnfProvider:
description: >
Name of the VNF provider to match.
type: string
vnfProducts:
description: >
If present, match VNF instances that belong to VNF products with certain product names,
from one particular provider.
type: array
items:
type: object
required:
- vnfProductName
properties:
vnfProductName:
description: >
Name of the VNF product to match.
type: string
versions:
description: >
If present, match VNF instances that belong to VNF products with certain versions
and a certain product name, from one particular provider.
type: array
items:
type: object
required:
- vnfSoftwareVersions
properties:
vnfSoftwareVersions:
description: >
Software version to match.
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Version'
vnfdVersions:
description: >
If present, match VNF instances that belong to VNF products with certain VNFD versions,
a certain software version and a certain product name, from one particular provider.
type: array
items:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Version'
vnfInstanceIds:
description: >
If present, match VNF instances with an instance identifier listed in this attribute. See NOTE 2.
type: array
items:
$ref: '../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier'
vnfInstanceNames:
description: >
If present, match VNF instances with a VNF Instance Name listed in this attribute. See NOTE 2
type: array
items:
type: string
responses:
409:
description: >
Conflict
Another request is in progress that prohibits the fulfilment of
the current request, or the current resource state is inconsistent
with the request.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
schema:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
...@@ -127,8 +127,7 @@ definitions: ...@@ -127,8 +127,7 @@ definitions:
callbackUri: callbackUri:
description: > description: >
The URI of the endpoint to send the notification to. The URI of the endpoint to send the notification to.
type: string $ref: "SOL002SOl003_def.yaml#/definitions/Uri"
format: url
authentication: authentication:
description: > description: >
Authentication parameters to configure the use of Authorization Authentication parameters to configure the use of Authorization
......
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