Commit 7a10c8d8 authored by rameshnaraya's avatar rameshnaraya

SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.

parent c91ca1d6
Pipeline #156 failed with stage
This source diff could not be displayed because it is too large. You can view the blob instead.
definitions:
NsdInfoModifications:
type: "object"
description: >
This type represents attribute modifications for an individual NS
descriptor resource based on the NsdInfo data type. The attributes of
NsdInfo that can be modified are included in the NsdInfoModifications
data type.NOTE: At least one of the attributes - nsdOperationalState and
userDefinedData - shall be present.
properties:
nsdOperationalState:
$ref: "#/definitions/NsdOperationalStateType"
userDefinedData:
description: >
Modifications of the userDefinedData attribute in NsdInfo
data type. See note. If present, these modifications shall be applied
according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
type: "array"
items:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
nsdOperationalState:
description: >
"New value of the "nsdOperationalState" attribute in "NsdInfo"
data type. See note.Permitted values:
ENABLED,
DISABLED"
type: "array"
items:
$ref: "#/definitions/NsdInfoModifications"
NsdmSubscription:
type: "object"
required:
- "id"
- "callbackUri"
- "_links"
properties:
id:
$ref: "#/definitions/Identifier"
filter:
$ref: "#/definitions/NsdmNotificationsFilter"
callbackUri:
$ref: "#/definitions/Uri"
_links:
type: "object"
description: >
"Links to resources related to this resource."
properties:
self:
$ref: "#/definitions/Link"
description: >
"This type represents a subscription related to notifications about
NSD management."
NsdmSubscriptionRequest:
type: "object"
required:
- "callbackUri"
properties:
filter:
$ref: "#/definitions/NsdmNotificationsFilter"
callbackUri:
type: "string"
description: >
"The URI of the endpoint to send the notification to."
authentication:
$ref: "#/definitions/SubscriptionAuthentication"
description: >
"This type represents a subscription request related to notifications
about NSD management."
Identifier:
type: "object"
NsdmNotificationsFilter:
type: "object"
description: >
"This type represents a subscription filter related to notifications
about NSD management. It shall comply with the provisions defined in Table
5.5.3.2-1 of GS NFV-SOL 005. 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)."
properties:
notificationTypes:
description: >
"Match particular notification types. Permitted values: NsdOnBoardingNotification,
NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
The permitted values of the "notificationTypes" ] attribute are spelled
exactly as the names of the notification types to facilitate automated
code generation systems."
type: array
items:
type: string
enum:
- "NsdOnBoardingNotification"
- "NsdOnboardingFailureNotification"
- "NsdChangeNotification"
- "NsdDeletionNotification"
- "PnfdOnBoardingNotification"
- "PnfdOnBoardingFailureNotification"
- "PnfdDeletionNotification"
nsdInfoId:
type: array
items:
$ref: "#/definitions/Identifier"
nsdId:
type: array
items:
$ref: "#/definitions/Identifier"
nsdName:
description: >
"Match the name of the on boarded NSD."
type: array
items:
$ref: "SOL005_def.yaml#/definitions/String"
nsdVersion:
type: array
items:
$ref: "#/definitions/Version"
nsdDesigner:
description: >
"Match the NSD designer of the on-boarded NSD."
type: array
items:
$ref: "SOL005_def.yaml#/definitions/String"
nsdInvariantId:
type: array
items:
$ref: "#/definitions/Identifier"
vnfPkgIds:
type: array
items:
$ref: "#/definitions/Identifier"
pnfdInfoIds:
type: array
items:
$ref: "#/definitions/Identifier"
nestedNsdInfoIds:
type: array
items:
$ref: "#/definitions/Identifier"
nsdOnboardingState:
type: array
items:
$ref: "#/definitions/NsdOnboardingStateType"
nsdOperationalState:
type: array
items:
$ref: "#/definitions/NsdOperationalStateType"
nsdUsageState:
type: array
items:
$ref: "#/definitions/NsdUsageStateType"
pnfdId:
type: array
items:
$ref: "#/definitions/Identifier"
pnfdName:
description: >
"Match the name of the on-boarded PNFD."
type: array
items:
$ref: "SOL005_def.yaml#/definitions/String"
pnfdVersion:
type: array
items:
$ref: "#/definitions/Version"
pnfdProvider:
description: >
"Match the provider of the on-boarded PNFD."
type: array
items:
$ref: "SOL005_def.yaml#/definitions/String"
pnfdInvariantId:
type: array
items:
$ref: "#/definitions/Identifier"
pnfdOnboardingState:
type: array
items:
$ref: "#/definitions/PnfdOnboardingStateType"
pnfdUsageState:
type: array
items:
$ref: "#/definitions/PnfdUsageStateType"
Uri:
type: "object"
Link:
type: "object"
SubscriptionAuthentication:
description: >
The procedure defined in clause 4.5.2 allows an API consumer to
obtain authorization to perform API requests towards
the API producer, including subscription requests.
For sending the actual notifications matching a subscription, the API
producer needs to obtain separate authorization to actually send the notification to the API consumer.
If an API consumer requires the API producer to authorize for sending notifications to that API consumer, it shall
include in the subscription request a data structure that defines the authorization requirements, as defined in
Table 4.5.3.4-1.
type: "object"
required:
- "authType"
properties:
authType:
description: >
Defines the types of Authentication
Authorization the API consumer is willing to
accept when receiving a notification.
Permitted values:
BASIC: In every HTTP request to the
notification endpoint, use HTTP Basic
authentication with the client credentials.
OAUTH2_CLIENT_CREDENTIALS: In every
HTTP request to the notification endpoint, use
an OAuth 2.0 Bearer token, obtained using the
client credentials grant type.
TLS_CERT: Every HTTP request to the
notification endpoint is sent over a mutually
authenticated TLS session. i.e. not only server
is authenticated, but also the client is
authenticated during the TLS tunnel setup
type: string
enum:
- BASIC
- OAUTH2_CLIENT_CREDENTIALS
- TLS_CERT
NsdOperationalStateType:
type: "string"
description: >
"The enumeration NsdOperationalStateType shall comply with the provisions
defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
state of the resource.
ENABLED = The operational state of the resource is enabled.
DISABLED = The operational state of the resource is disabled."
enum:
- "ENABLED"
- "DISABLED"
NsdInfo:
type: "object"
required:
- "id"
- "nsdOnboardingState"
- "nsdOperationalState"
- "nsdUsageState"
- "_links"
properties:
id:
description: >
Identifier of the on boarded individual NS descriptor
resource. This identifier is allocated by the NFVO.
$ref: "#/definitions/Identifier"
nsdId:
description: >
This identifier, which is allocated by the NSD
designer, identifies the NSD in a globally unique
way. It is copied from the NSD content and shall be
present after the NSD content is on-boarded.
$ref: "#/definitions/Identifier"
nsdName:
type: "string"
description: >
"Name of the on boarded NSD. This information is copied from the
NSD content and shall be present after the NSD content is on-boarded."
nsdVersion:
description: >
Version of the on-boarded NSD. This information is
copied from the NSD content and shall be present
after the NSD content is on-boarded.
$ref: "#/definitions/Version"
nsdDesigner:
type: "string"
description: >
"Designer of the on-boarded NSD. This information is copied
from the NSD content and shall be present after the NSD content is on-boarded."
nsdInvariantId:
description: >
This identifier, which is allocated by the NSD
designer, identifies an NSD in a version independent
manner. This information is copied from the NSD
content and shall be present after the NSD content is
on-boarded.
$ref: "#/definitions/Identifier"
vnfPkgIds:
description: >
Identifies the VNF package for the VNFD referenced
by the on-boarded NS descriptor resource. See
note 1.
type: array
items:
$ref: "#/definitions/Identifier"
pnfdInfoIds:
description: >
Identifies the PnfdInfo element for the PNFD
referenced by the on-boarded NS descriptor
resource.
type: array
items:
$ref: "#/definitions/Identifier"
nestedNsdInfoIds:
description: >
Identifies the NsdInfo element for the nested NSD
referenced by the on-boarded NS descriptor
resource.
type: array
items:
$ref: "#/definitions/Identifier"
nsdOnboardingState:
description: >
On boarding state of the individual NS descriptor resource.
$ref: "#/definitions/NsdOnboardingStateType"
onboardingFailureDetails:
description: >
Failure details of current on boarding procedure. See
clause 4.3.5.3 for the details of "ProblemDetails"
structure.
It shall be present when the "nsdOnboardingState"
attribute is CREATED and the uploading or
processing fails in NFVO.
$ref: "#/definitions/ProblemDetails"
nsdOperationalState:
description: >
Operational state of the individual NS descriptor
resource. This attribute can be modified with the
PATCH method.
$ref: "#/definitions/NsdOperationalStateType"
nsdUsageState:
description: >
Usage state of the individual NS descriptor resource.
$ref: "#/definitions/NsdUsageStateType"
userDefinedData:
description: >
User defined data for the individual NS descriptor
resource. This attribute can be modified with the
PATCH method.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
_links:
type: "object"
description: >
"Links to resources related to this resource."
properties:
self:
description: >
"URI of this resource."
$ref: "#/definitions/Link"
nsd_content:
description: >
"Link to the NSD content resource"
$ref: "#/definitions/Link"
description: >
"This type represents a response for the query NSD operation."
Version:
type: "object"
NsdOnboardingStateType:
type: "string"
description: >
"The enumeration NsdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
state of the NSD.CREATED = The NSD information object is created. UPLOADING
= The associated NSD content is being uploaded. PROCESSING = The associated
NSD content is being processed, e.g. validation. ONBOARDED = The associated
NSD content is on-boarded."
enum:
- "CREATED"
- "UPLOADING"
- "PROCESSING"
- "ONBOARDED"
ProblemDetails:
type: "object"
NsdUsageStateType:
type: "string"
description: >
"The enumeration NsdUsageStateType shall comply with the provisions
defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
is not-in-use."
enum:
- "IN_USE"
- "NOT_IN_USE"
CreateNsdInfoRequest:
type: "object"
properties:
userDefinedData:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
description: >
"This type creates a completely new NS descriptor resource."
PnfdInfoModifications:
type: "object"
required:
- "userDefinedData"
properties:
userDefinedData:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
description: >
"This type represents attribute modifications for an individual PNF
descriptor resource based on the "PnfdInfo" data type. The attributes of
"PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
data type."
PnfdInfo:
type: "object"
required:
- "_links"
- "id"
- "pnfdOnboardingState"
- "pnfdUsageState"
properties:
id:
$ref: "#/definitions/Identifier"
pnfdId:
$ref: "#/definitions/Identifier"
pnfdName:
type: "string"
description: >
"Name of the onboarded PNFD. This information is copied from
the PNFD content and shall be present after the PNFD content is on-boarded."
pnfdVersion:
$ref: "#/definitions/Version"
pnfdProvider:
type: "string"
description: >
"Provider of the onboarded PNFD. This information is copied from
the PNFD content and shall be present after the PNFD content is onboarded."
pnfdInvariantId:
$ref: "#/definitions/Identifier"
pnfdOnboardingState:
$ref: "#/definitions/PnfdOnboardingStateType"
onboardingFailureDetails:
$ref: "#/definitions/ProblemDetails"
pnfdUsageState:
$ref: "#/definitions/PnfdUsageStateType"
userDefinedData:
type: "object"
description: >
"User defined data for the individual PNF descriptor resource.
This attribute can be modified with the PATCH method."
_links:
required:
- "pnfd_content"
- "self"
type: "object"
description: >
"Links to resources related to this resource."
properties:
self:
$ref: "#/definitions/Link"
pnfd_content:
$ref: "#/definitions/Link"
description: >
"This type represents a response for the query PNFD operation."
PnfdOnboardingStateType:
type: "string"
description: >
"The enumeration PnfdOnboardingStateType shall comply with the provisions
defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the onboarding state
of the individual PNF descriptor resource.CREATED = The PNF descriptor
resource is created. UPLOADING = The associated PNFD content is being uploaded.
PROCESSING = The associated PNFD content is being processed, e.g. validation.
ONBOARDED = The associated PNFD content is on-boarded."
enum:
- "CREATED"
- "UPLOADING"
- "PROCESSING"
- "ONBOARDING"
PnfdUsageStateType:
type: "string"
description: >
"The enumeration PnfdUsageStateType shall comply with the provisions
defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
is not-in-use."
enum:
- "IN_USE"
- "NOT_IN_USE"
CreatePnfdInfoRequest:
type: "object"
properties:
userDefinedData:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
description: >
"This type creates a new PNF descriptor resource."
NsdmLinks:
type: "object"
required:
- "nsdInfo"
- "subscription"
properties:
nsdInfo:
$ref: "#/definitions/Link"
subscription:
$ref: "#/definitions/Link"
description: >
"This type represents the links to resources that an NSD management
notification can contain."
NsdOnboardingNotification:
type: "object"
required:
- "_links"
- "id"
- "notificationType"
- "nsdId"
- "nsdInfoId"
- "timeStamp"
properties:
id:
$ref: "#/definitions/Identifier"
notificationType:
type: "string"
description: >
"Discriminator for the different notification types. Shall be
set to "NsdOnboardingNotification" for this notification type."
subscriptionId:
$ref: "#/definitions/Identifier"
timeStamp:
type: "string"
format: "date-time"
description: >
"Date-time of the generation of the notification."
nsdInfoId:
$ref: "#/definitions/Identifier"
nsdId:
$ref: "#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
"This type represents an NSD management notification, which informs
the receiver of the successful on-boarding of an NSD. It shall comply with
the provisions defined in Table 5.5.2.9-1. The support of this notification
is mandatory. The notification shall be triggered by the NFVO when the "
nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED"."
NsdOnboardingFailureNotification:
type: "object"
required:
- "_links"
- "id"
- "notificationType"
- "nsdInfoId"
- "onboardingFailureDetails"
- "timeStamp"
properties:
id:
$ref: "#/definitions/Identifier"
notificationType:
type: "string"
description: >
"Discriminator for the different notification types. Shall be
set to "NsdOnboardingFailureNotification" for this notification type."
subscriptionId:
$ref: "#/definitions/Identifier"
timeStamp:
type: "string"
format: "date-time"
description: >
"Date-time of the generation of the notification."
nsdInfoId:
$ref: "#/definitions/Identifier"
nsdId:
$ref: "#/definitions/Identifier"
onboardingFailureDetails:
$ref: "#/definitions/ProblemDetails"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
"This type represents an NSD management notification, which informs
the receiver of the failure of on-boarding an NSD. It shall comply with the
provisions defined in Table 5.5.2.10-1. The support of this notification is
mandatory. The notification shall be triggered by the NFVO when the on-boarding
of an NSD has failed."
NsdChangeNotification:
type: "object"
required:
- "_links"
- "id"
- "notificationType"
- "nsdId"
- "nsdInfoId"
- "nsdOperationalState"
- "timeStamp"
properties:
id:
$ref: "#/definitions/Identifier"
notificationType:
type: "string"
description: >
"Discriminator for the different notification types. Shall be
set to "NsdChangeNotification" for this notification type."
subscriptionId:
$ref: "#/definitions/Identifier"
timeStamp:
type: "string"
format: "date-time"
description: >
"Date-time of the generation of the notification."
nsdInfoId:
$ref: "#/definitions/Identifier"
nsdId:
$ref: "#/definitions/Identifier"
nsdOperationalState:
$ref: "#/definitions/NsdOperationalStateType"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
"This type represents an NSD management notification, which informs
the receiver of a change of the "nsdOperationalState" attribute of an on-boarded
NSD. Changes in the value of the "nsdUsageState" and "nsdOnboardingState"
attributes are not reported. The notification shall comply with the provisions
defined in Table 5.5.2.11-1. The support of this notification is mandatory.
The notification shall be triggered by the NFVO when the value of the "nsdOperationalState"
attribute has changed, and the "nsdOperationalState" attribute has the value
"ONBOARDED"."
NsdDeletionNotification:
type: "object"
required:
- "_links"
- "id"
- "notificationType"
- "nsdId"
- "nsdInfoId"
- "timeStamp"
properties:
id:
$ref: "#/definitions/Identifier"
notificationType:
type: "string"
description: >
"Discriminator for the different notification types. Shall be
set to "NsdDeletionNotification " for this notification type."
subscriptionId:
$ref: "#/definitions/Identifier"
timeStamp:
type: "string"
format: "date-time"
description: >
"Date-time of the generation of the notification."
nsdInfoId:
$ref: "#/definitions/Identifier"
nsdId:
$ref: "#/definitions/Identifier"
_links:
$ref: "#/definitions/NsdmLinks"
description: >
"This type represents an NSD management notification, which informs
the receiver of the deletion of an on-boarded NSD. The notification shall
comply with the provisions defined in Table 5.5.2.12-1. The support of this
notification is mandatory. The notification shall be triggered by the NFVO
when it has deleted an on-boarded NSD."
PnfdmLinks:
type: "object"
required:
- "pnfdInfo"
- "subscription"
properties:
pnfdInfo:
$ref: "#/definitions/Link"
subscription:
$ref: "#/definitions/Link"
description: >
"This type represents the links to resources that a PNFD management
notification can contain."
PnfdOnboardingNotification:
type: "object"
required:
- "_links"
- "id"
- "notificationType"
- "pnfdId"
- "pnfdInfoId"
- "timeStamp"
properties:
id:
$ref: "#/definitions/Identifier"
notificationType:
type: "string"
description: >
"Discriminator for the different notification types. Shall be
set to "PnfdOnboardingNotification" for this notification type."
subscriptionId:
$ref: "#/definitions/Identifier"
timeStamp:
type: "string"