Loading src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml 0 → 100644 +884 −0 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml: 884 added lines, 0 removed lines. Original line number Diff line number Diff line definitions: 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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" vnfPkgIds: description: > Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdInfoIds: description: > Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nestedNsdInfoIds: description: > Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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" required: - "self" - "nsd_content" description: > "Links to resources related to this resource." properties: self: description: > "URI of this resource." $ref: "SOL005_def.yaml#/definitions/Link" nsd_content: description: > "Link to the NSD content resource" $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents a response for the query NSD operation." 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: description: > Identifier of this subscription resource. $ref: "SOL005_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: "#/definitions/NsdmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL005_def.yaml#/definitions/Uri" _links: type: "object" description: > Links to resources related to this resource. properties: self: $ref: "SOL005_def.yaml#/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. 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: description: > Match the NsdInfo identifier which is allocated by the NFVO. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: description: > Match the NSD identifier, which is allocated by the NSD designer. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdName: description: > Match the name of the on boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" nsdVersion: description: > Match the NSD version listed as part of this attribute. type: array items: $ref: "SOL005_def.yaml#/definitions/Version" nsdDesigner: description: > "Match the NSD designer of the on-boarded NSD." type: array items: $ref: "SOL005_def.yaml#/definitions/String" nsdInvariantId: description: > Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" vnfPkgIds: description: > Match VNF packages with a package identifier listed in the attribute. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdInfoIds: description: > Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nestedNsdInfoIds: description: > Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdOnboardingState: description: > Match particular on-boarding state of the NSD. type: array items: $ref: "#/definitions/NsdOnboardingStateType" nsdOperationalState: description: > Match particular operational state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: description: > Match particular usage state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdUsageStateType" pnfdId: description: > Match the PNFD identifier which is copied from the PNFD content. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: description: > Match the name of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdVersion: description: > Match the PNFD designer of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: description: > Match the provider of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdInvariantId: description: > Match the PNFD in a version independent manner. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: description: > Match particular on-boarding state of the PNFD. type: array items: $ref: "#/definitions/PnfdOnboardingStateType" pnfdUsageState: description: > Match the usage state of the individual PNF descriptor resource. type: array items: $ref: "#/definitions/PnfdUsageStateType" 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 paramsBasic: type: "object" description: > Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise. properties: userName: description: > Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. type: string password: description: > Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. type: string paramsOauth2ClientCredentials: type: "object" description: > Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise properties: clientId: description: > Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. type: string clientPassword: description: > Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. type: string tokenEndpoint: description: > The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. $ref: "SOL005_def.yaml#/definitions/Uri" 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" 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" 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: - "id" - "pnfdOnboardingState" - "pnfdUsageState" - "_links" properties: id: description: > Identifier of the on-boarded individual PNF descriptor resource. This identifier is allocated by the NFVO. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: description: > This identifier, which is managed by the PNFD designer, identifies the PNFD in a globally unique way. It is copied from the PNFD content and shall be present after the PNFD content is on-boarded. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: description: > Name of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded. type: "string" pnfdersion: $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: description: > "Provider of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded." type: "string" pnfdInvariantId: description: > Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: description: > On-boarding state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdOnboardingStateType" onboardingFailureDetails: description: > Failure details of current on-boarding procedure. It shall be present when the pnfdOnboardingState attribute is CREATED and the uploading or processing fails in the NFVO. $ref: "SOL005_def.yaml#/definitions/ProblemDetails" pnfdUsageState: description: > Usage state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdUsageStateType" userDefinedData: type: "array" description: > User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method. items: type: "object" _links: required: - "pnfd_content" - "self" type: "object" description: > "Links to resources related to this resource." properties: self: $ref: "SOL005_def.yaml#/definitions/Link" pnfd_content: $ref: "SOL005_def.yaml#/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 on-boarding 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: > User-defined data for the PNF descriptor resource to be created. It shall be present when the user defined data is set for the individual PNF descriptor resource to be created. NsdmLinks: type: "object" required: - "nsdInfo" - "subscription" properties: nsdInfo: $ref: "SOL005_def.yaml#/definitions/Link" subscription: $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents the links to resources that an NSD management notification can contain." PnfdmLinks: type: "object" required: - "pnfdInfo" - "subscription" properties: pnfdInfo: $ref: "SOL005_def.yaml#/definitions/Link" subscription: $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents the links to resources that a PNFD management notification can contain." NsdOnBoardingNotification: type: "object" required: - "_links" - "id" - "notificationType" - "nsdId" - "nsdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingFailureNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdChangeNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdDeletionNotification " for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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." PnfdOnBoardingNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the successful on-boarding of aPNFD. It shall comply with the provisions defined in Table 5.5.2.13-1. The support of this notification is mandatory. The notification is triggered when a new PNFD is on-boarded." PnfdOnBoardingFailureNotification: type: "object" required: - "_links" - "id" - "notificationType" - "onboardingFailureDetails" - "pnfdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingFailureNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: $ref: "SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the failure of on-boarding a PNFD. It shall comply with the provisions defined in Table 5.5.2.14-1. The support of this notification is mandatory. The notification is triggered when the on-boarding of a PNFD fails." PnfdDeletionNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "timeStamp" properties: id: type: "string" description: > "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value." notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdDeletionNotification " for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the deletion of an on-boarded PNFD. The notification shall comply with the provisions defined in Table 5.5.2.15-1. The support of this notification is mandatory. The notification is triggered when an on-boarded PNFD is deleted." No newline at end of file src/SOL005/NSDManagement/definitions/SOL005_def.yaml 0 → 100644 +102 −0 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005_def.yaml: 102 added lines, 0 removed lines. Original line number Diff line number Diff line # 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 src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml 0 → 100644 +292 −0 Viewed Changes for src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml: 292 added lines, 0 removed lines. Original line number Diff line number Diff line responses: 202-with-Location: description: > Accepted The request was accepted for processing, but the processing has not been completed. The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "NS lifecycle operation occurrence" resource corresponding to the operation. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Location: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" 202-with-Location-empty: description: > Accepted The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "NS Descriptor operation occurrence" resource corresponding to the operation. The response body shall be empty. headers: Location: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 409: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact the NS descriptor resource is in the enabled operational state (i.e. operationalState = ENABLED) or there are running NS instances using the concerned individual NS descriptor resource (i.e. usageState = IN_USE). The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-another-nsd-operation-ongoing: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that another Descriptor operation is ongoing. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > Conflict Another request is in progress that prohibits the fulfillment 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 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-INSTANTIATED: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-not-FAILED_TEMP: description: > The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is not in FAILED_TEMP state, or another error handling action is starting, such as rollback or fail. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-nsd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact "nsdOnboardingState" has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-CREATED: description: > Conflict. Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" No newline at end of file src/SOL005/NSDManagement/responses/SOL005_resp.yaml 0 → 100644 +417 −0 Viewed File added.Preview size limit exceeded, changes collapsed. Show changes src/SOL005/NSDManagement/NSDManagement.yaml +1919 −1464 Viewed Changes for src/SOL005/NSDManagement/NSDManagement.yaml: 1919 added lines, 1464 removed lines. Original line number Diff line number Diff line --- swagger: "2.0" info: description: "DRAFT - SOL005 - NSD Management Interface IMPORTANT: Please note that\ \ this file might be not aligned to the current version of the ETSI Group Specification\ \ it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies\ \ the published ETSI Group Specification takes precedence. Please report bugs\ \ to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis\n" version: "2.4.1" title: "DRAFT - SOL005 - NSD Management Interface" contact: name: "NFV-SOL WG" version: "1.0.0" title: "SOL005 - NSD Management Interface" description: > SOL005 - NSD Management Interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis license: name: "ETSI Forge copyright notice" url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" externalDocs: description: ETSI GS NFV-SOL 005 V2.4.1 url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf basePath: "/nsd/v1" schemes: - https consumes: - "application/json" produces: - "application/json" paths: /ns_descriptors: ############################################################################### # NS Descriptors # ############################################################################### '/ns_descriptors': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2 get: summary: "Query NSD Info" description: "The GET method queries information about multiple NS descriptor\ \ resources. This method shall follow the provisions specified in the Tables\ \ 5.4.2.3.2-1 and 5.4.2.3.2-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." summary: Query information about multiple NS descriptor resources. description: > "The GET method queries information about multiple NS descriptor resources. This method shall follow the provisions specified in the Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes." parameters: - name: "Accept" in: "header" required: true - name: "filter" in: "query" required: false type: "string" description: "This header field shall be present if the response is expected\ \ to have a non-empty message body." - name: "Authorization" in: "header" 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. All attribute names that appear in the NsdInfo and in data types referenced from it shall be supported in attribute-based filtering parameters." - name: "all_fields" in: "query" required: false type: "string" description: > "Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO shall support this parameter." - name: "fields" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > "Complex attributes to be included into the response. See clause 4.3.3 for details. The NFVO should support this parameter." - name: "exclude_fields" in: "query" required: false type: "string" description: > "Complex attributes to be excluded from the response. See clause 4.3.3 for details. The NFVO should support this parameter." - name: "exclude_default" in: "query" required: false type: "string" description: > "Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The VNFM shall support this parameter. The following attributes shall be excluded from the NsdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: userDefinedData." - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 200: description: "Information about zero or more NS descriptors.\nThe response\ \ body shall contain a representation of zero or more NS descriptors,\ \ as defined in clause 5.5.2.2 of GS NFV-SOL 005." schema: $ref: "#/definitions/NsdInfo" description: > 200 OK Information about zero or more NS descriptors. The response body shall contain a representation of zero or more NS descriptors, as defined in clause 5.5.2.2 headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: array items: properties: NsdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" 400: description: "There are two possible scenarios listed below.\n\nError: Invalid\ \ attribute-based filtering parameters. \n\nThe response body shall contain\ \ a ProblemDetails structure, in which the \"detail\" attribute should\ \ convey more information about the error.\n\nError: Invalid attribute\ \ selector. The response body shall contain a ProblemDetails structure,\ \ in which the \"detail\" attribute should convey more information about\ \ the error." $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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Create NSD Info" description: "The POST method is used to create a new NS descriptor resource.\ \ This method shall follow the provisions specified in the Tables 5.4.2.3.1-1\ \ and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and\ \ response data structures, and response codes." consumes: [] summary: Create a new NS descriptor resource. description: > The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor. parameters: - name: "Accept" in: "header" required: false type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the\nresponse is expected to have a non-empty\n\ message body." - name: "Content-Type" in: "header" required: false type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005" type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true Loading @@ -100,157 +181,159 @@ paths: - "CreateNsdInfoRequest" properties: CreateNsdInfoRequest: $ref: "#/definitions/CreateNsdInfoRequest" description: "The CreateNsdInfoRequest contains parameters for creating\ \ an NS descriptor resource, as defined in\nclause 5.5.2.4 of GS NFV-SOL\ \ 005." $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest" description: > Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3 responses: 201: description: "Status 201" description: > Status 201 An NS descriptor resource was created successfully, as a new NS descriptor resource. The response body shall contain a representation of the new NS descriptor resource, as defined in clause 5.5.2.3 of GS NFV-SOL 005. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the new NS descriptor resource. schema: type: "object" description: "An NS descriptor resource was created successfully, as a\ \ new NS descriptor resource. The response body shall contain a representation\ \ of the new NS descriptor resource, as defined in clause 5.5.2.2 of\ \ GS NFV-SOL 005." properties: NsdInfo: $ref: "#/definitions/NsdInfo" $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: Location: type: "string" description: "The HTTP response shall include a \"Location\" HTTP header\ \ that contains the resource URI of the new NS descriptor resource." Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /ns_descriptors/{nsdInfoId}: get: summary: "Query NSD Info" description: "The GET method reads information about an individual NS descriptor.\ \ This method shall follow the provisions specified in GS NFV-SOL 005 Tables\ \ 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual NS Descriptor # ############################################################################### '/ns_descriptors/{nsdInfoId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3 parameters: - name: "Accept" in: "header" - name: "nsdInfoId" description: > Identifier of the individual NS descriptor resource. in: "path" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present \nif the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" get: summary: Read information about an individual NS descriptor resource. description: > "The GET method reads information about an individual NS descriptor. This method shall follow the provisions specified in GS NFV-SOL 005 Tables 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." parameters: - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string responses: 200: description: "Information about the individual NS descriptor. The response\ \ body shall contain a representation of the individual NS descriptor,\ \ as defined in clause 5.5.2.2 of GS NFV-SOL 005." description: > 200 OK Information about the individual NS descriptor. The response body shall contain a representation of the individual NS descriptor. schema: $ref: "#/definitions/NsdInfo" type: "object" properties: NsdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." delete: summary: "Delete NSD" description: "The DELETE method deletes an individual NS descriptor resource.\ \ An individual NS descriptor resource can only be deleted when there is no\ \ NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled\ \ already (i.e. operationalState = DISABLED). Otherwise, the DELETE method\ \ shall fail. This method shall follow the provisions specified in the Tables\ \ 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." responses: 204: description: "The operation has completed successfully. The response body\ \ shall be empty." schema: type: "object" description: "The operation has completed successfully. The response body\ \ shall be empty." headers: description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: required: - "ProblemDetails" type: "object" description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due\ \ to the fact the NS descriptor resource is in the enabled operational\ \ state (i.e. operationalState = ENABLED) or there are running NS instances\ \ using the concerned individual NS descriptor resource (i.e. usageState\ \ = IN_USE). The response body shall contain a ProblemDetails structure,\ \ in which the \"detail\" attribute shall convey more information about\ \ the error." properties: ProblemDetails: $ref: "#/definitions/ProblemDetails" $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" patch: summary: "Update NSD Info" description: "The PATCH method modifies the operational state and/or user defined\ \ data of an individual NS descriptor resource. This method can be used to:\n\ 1) Enable a previously disabled individual NS descriptor resource, allowing\ \ again its use for instantiation of new\nnetwork service with this descriptor.\ \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n\ 2) Disable a previously enabled individual NS descriptor resource, preventing\ \ any further use for instantiation of\nnew network service(s) with this descriptor.\ \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change\nas a result.\n\ 3) Modify the user defined data of an individual NS descriptor resource.\n\ This method shall follow the provisions specified in the Tables 5.4.3.3.4-1\ \ and 5.4.3.3.4-2 for URI query parameters,\nrequest and response data structures,\ \ and response codes." consumes: [] summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource. description: > The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource. This method can be used to: 1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as result. 2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result. 3) Modify the user defined data of an individual NS descriptor resource. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3." - name: "body" in: "body" required: true Loading @@ -260,1486 +343,1858 @@ paths: - "NsdInfoModifications" properties: NsdInfoModifications: $ref: "#/definitions/NsdInfoModifications" description: "The operation was completed successfully. The response body\ \ shall contain attribute modifications for an 'Individual NS Descriptor'\ \ resource (see clause 5.5.2.6 of GS NFV SOL-005)." $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" description: > Parameters for the modification of an individual NS descriptor resource. - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 200: description: "Status 200" schema: $ref: "#/definitions/NsdInfoModifications" description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual NS Descriptor' resource. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: array items: properties: NsdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: Delete an individual NS descriptor resource. description: > The DELETE method deletes an individual NS descriptor resource. An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method shall fail. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The operation has completed successfully. The response body shall be empty. headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: description: "Status 412" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # NSD Content # ############################################################################### '/ns_descriptors/{nsdInfoId}/nsd_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4 parameters: - name: "nsdInfoId" in: "path" required: true type: "string" /ns_descriptors/{nsdInfoId}/nsd_content: get: summary: "Get NSD Content" description: "The GET method fetches the content of the NSD.\n\nThe NSD can\ \ be implemented as a single file or as a collection of multiple files. If\ \ the NSD is implemented in the form of multiple files, a ZIP file embedding\ \ these files shall be returned. If the NSD is implemented as a single file,\ \ either that file or a ZIP file embedding that file shall be returned.\n\n\ The selection of the format is controlled by the \"Accept\" HTTP header passed\ \ in the GET request.\n\nNOTE: The structure of the NSD zip file is outside\ \ the scope of the present document." summary: Fetch the content of a NSD. description: > The GET method fetches the content of the NSD. The NSD can be implemented as a single file or as a collection of multiple files. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the "Accept" HTTP header passed in the GET request:• If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file, the file shall be returned; otherwise, an error message shall be returned.• If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the NSD shall be returned embedded in a ZIP file.• If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned.NOTE: The structure of the NSD zip file is outside the scope of the present document. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: "string" description: "String Required\nIf the “Accept” header contains only “text/plain”\ \ and the NSD is implemented as a single file, the file shall be returned;\ \ otherwise, an error message shall be returned.\n\nIf the “Accept” header\ \ contains only “application/zip”, the single file or the multiple files\ \ that make up the NSD shall be returned embedded in a ZIP file.\n\nIf the\ \ “Accept” header contains both “text/plain” and “application/zip”, it is\ \ up to the NFVO to choose the format to return for a single-file NSD; for\ \ a multi-file NSD, a ZIP file shall be returned." - name: "Range" in: "header" type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The request may contain a \"Range\" HTTP header to obtain single\ \ range of bytes from the NSD file. This can be used to continue an aborted\ \ transmission.\n\nIf the NFVO does not support range requests, the NFVO\ \ shall ignore the 'Range\" header, process the GET request, and return\ \ the whole NSD file with a 200 OK response (rather than returning a 4xx\ \ error status code)." - name: "Authorization" type: string - name: "Range" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > "The request may contain a "Range" HTTP header to obtain single range of bytes from the NSD file. This can be used to continue an aborted transmission.If the NFVO does not support range requests, the NFVO shall ignore the 'Range" header, process the GET request, and return the whole NSD file with a 200 OK response (rather than returning a 4xx error status code)." responses: 200: description: "On success, the content of the NSD is returned. The payload\ \ body shall contain a copy of the file representing the NSD or a ZIP\ \ file that contains the file or multiple files representing the NSD,\ \ as specified above. The \"Content-Type\" HTTP header shall be set according\ \ to the format of the returned file, i.e. to \"text/plain\" for a YAML\ \ file or to \"application/zip\" for a ZIP file." schema: type: "object" description: > 200 OK On success, the content of the NSD is returned. The payload body shall contain a copy of the file representing the NSD or a ZIP file that contains the file or multiple files representing the NSD, as specified above. The "Content-Type" HTTP header shall be set according to the format of the returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file. headers: Content-Type: type: "string" description: "The \"Content-Type\" HTTP header shall be set according\ \ to the format of the returned file, i.e. to \"text/plain\" for a\ \ YAML file or to \"application/zip\" for a ZIP file." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." Content-Range: type: "string" description: "Signals the byte range that is contained in the response,\ \ and the total length of the file." Accept-Ranges: type: "string" description: "Used by the server to signal whether or ot it supports\ \ ranges for certain resources." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: description: "On success, if the NFVO supports range requests, a single\ \ consecutive byte range from the content of the NSD file is returned.\n\ \nThe response body shall contain the requested part of the NSD file.\n\ \nThe \"Content-Range\" HTTP header shall be provided according to IETF\ \ RFC 7233 [23].\n\nThe \"Content-Type\" HTTP header shall be set as defined\ \ above for the \"200 OK\" response." headers: Content-Range: type: "string" Content-Type: type: "string" $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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: description: "Status 406" schema: type: "object" description: "If the \"Accept\" header does not contain at least one name\ \ of a content type for which the NFVO can provide a representation\ \ of the NSD, the NFVO shall respond with this response code. The \"\ ProblemDetails\" structure may be included with the \"detail\" attribute\ \ providing more information about the error." $ref: "responses/SOL005_resp.yaml#/responses/406" 409: description: "Status 409" schema: type: "object" description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due\ \ to the fact \"nsdOnboardingState\" has a value different from ONBOARDED.\ \ The response body shall contain a ProblemDetails structure, in which\ \ the \"detail\" attribute shall convey more information about the error." $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: description: "Status 416" schema: type: "object" description: "The byte range passed in the \"Range\" header did not match\ \ any available byte range in the NSD file (e.g.\n\"access after end\ \ of file\"). The response body may contain a ProblemDetails structure." $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" put: summary: "Upload NSD" description: "The PUT method is used to upload the content of a NSD. The NSD\ \ to be uploaded can be implemented as a single file or as a collection of\ \ multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the\ \ NSD is implemented in the form of multiple files, a ZIP file embedding these\ \ files shall be uploaded. If the NSD is implemented as a single file, either\ \ that file or a ZIP file embedding that file shall be uploaded. The \"Content-Type\"\ \ HTTP header in the PUT request shall be set accordingly based on the format\ \ selection of the NSD. If the NSD to be uploaded is a text file, the \"Content-Type\"\ \ header is set to \"text/plain\". If the NSD to be uploaded is a zip file,\ \ the \"Content-Type\" header is set to \"application/zip\". This method shall\ \ follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2\ \ of GS-NFV-SOL 005 for URI query parameters, request and response data structures,\ \ and response codes." consumes: [] summary: Upload the content of a NSD. description: > "The PUT method is used to upload the content of a NSD. The NSD to be uploaded can be implemented as a single file or as a collection of multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be uploaded. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be uploaded. The "Content-Type" HTTP header in the PUT request shall be set accordingly based on the format selection of the NSD. If the NSD to be uploaded is a text file, the "Content-Type" header is set to "text/plain". If the NSD to be uploaded is a zip file, the "Content-Type" header is set to "application/zip". This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2 of GS-NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." parameters: - name: "Content-Type" in: "header" required: false type: "string" description: "The payload body contains a copy of the file representing the\ \ NSD or a ZIP file that contains the file or multiple files representing\ \ the NSD, as specified above. The request shall set the \"Content-Type\"\ \ HTTP header as defined\nabove." - name: "body" in: "body" - name: Accept description: > Content-Types that are acceptable for the response. The payload body contains a copy of the file representing the NSD or a ZIP file that contains the file or multiple files representing the NSD. in: header required: true schema: type: "object" type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 202: description: "Status 202" schema: type: "object" description: "The NSD content was accepted for uploading, but the processing\ \ has not been completed. It is expected to take some time for processing\ \ (asynchronous mode). The response body shall be empty. See note." description: > 202 Accepted The NSD content was accepted for uploading, but the processing has not been completed. It is expected to take some time for processing (asynchronous mode). The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 204: description: "The NSD content was successfully uploaded and validated (synchronous\ \ mode). The response body shall be empty." description: > 204 No Content The NSD content was successfully uploaded and validated (synchronous mode). The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due to\ \ the fact that the NsdOnboardingState has a value other than CREATED.\ \ The response body shall contain a ProblemDetails structure, in which\ \ the \"detail\" attribute shall convey more information about the error." schema: $ref: "#/definitions/ProblemDetails" parameters: - name: "nsdInfoId" in: "path" required: true type: "string" /pnf_descriptors: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # PNF Descriptors # ############################################################################### '/pnf_descriptors': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5 get: summary: "Query PFND Info" description: "The GET method queries information about multiple PNF descriptor\ \ resources." summary: Query information about multiple PNF descriptor resources. description: > "The GET method queries information about multiple PNF descriptor resources." parameters: - name: "exclude_default" - name: "filter" in: "query" required: false type: "string" description: "Indicates to exclude the following \n \ncomplex attributes from\ \ the response. \nSee clause 4.3.3 for details.\n\nThe NFVO shall support\ \ this parameter.\n\nThe following attributes shall be excluded from the\ \ PnfdInfo structure in the response body if this parameter is provided,\ \ or none of the parameters \"all_fields,\" \"fields\", \"exclude_fields\"\ , \"exclude_default\" are provided: userDefinedData." 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. All attribute names that appear in the PnfdInfo and in data types referenced from it shall be supported in attribute-based filtering parameters. - name: "all_fields" in: "query" required: false type: "string" description: "Include all complex attributes in the response. See clause 4.3.3\ \ for details. The NFVO shall support this parameter." - name: "Accept" in: "header" description: > Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO shall support this parameter. - name: "fields" in: "query" required: false type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" description: > Complex attributes to be included into the response. See clause 4.3.3 for details. The NFVO should support this parameter. - name: "exclude_fields" in: "query" required: false type: "string" description: > Complex attributes to be excluded from the response. See clause 4.3.3 for details. The NFVO should support this parameter. - name: "exclude_default" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The NFVO shall support this parameter. The following attributes shall be excluded from the PnfdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: userDefinedData. responses: 200: description: "Status 200" schema: type: "object" description: "Information about zero or more PNF descriptors. The response\ \ body shall contain a representation of zero or more PNF descriptors,\ \ as defined in clause 5.5.2.2." description: > 200 OK Information about zero or more PNF descriptors. The response body shall contain a representation of zero or more PNF descriptors, as defined in clause 5.5.2.2 headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "array" items: properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Create PNFD Info" description: "The POST method is used to create a new PNF descriptor resource." consumes: [] summary: Create a new PNF descriptor resource. description: > The POST method is used to create a new PNF descriptor resource parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS-NFV-SOL 005." type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true schema: type: "object" description: "Parameters of creating a PNF descriptor resource, as defined\ \ in\nclause 5.5.2.6 of GS NFV-SOL 005." required: - "CreatePnfdInfoRequest" properties: CreatePnfdInfoRequest: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest" description: > Parameters of creating a PNF descriptor resource. responses: 201: description: "Status 201" description: > 201 Created A PNF descriptor resource was created successfully, as a new PNF descriptor resource. The response body shall contain a representation of the new PNF descriptor resource, as defined in clause 5.5.2.5. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the new PNF descriptor resource. schema: type: "object" description: "A PNF descriptor resource was created successfully, as a\ \ new PNF descriptor resource. The response body shall contain a representation\ \ of the new PNF descriptor resource, as defined in clause 5.5.2.5.\ \ The HTTP response shall include a \"Location\" HTTP header that contains\ \ the resource URI of the new PNF descriptor resource." properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /pnf_descriptors/{pnfdInfoId}: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual PNF Descriptor # ############################################################################### '/pnf_descriptors/{pnfdInfoId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6 parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor resource. in: "path" required: true type: "string" get: summary: "Query PNFD Info" description: "The GET method reads information about an individual PNF descriptor.\ \ This method shall follow the provisions specified in the Tables 5.4.6.3.2-1\ \ and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and\ \ response data structures, and response codes." summary: Read an individual PNFD resource. description: > The GET method reads information about an individual PNF descriptor. This method shall follow the provisions specified in the Tables 5.4.6.3.2-1 and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 200: description: "Information about the individual PNFD descriptor. The response\ \ body shall contain a representation of the individual PNF descriptor,\ \ as defined in clause 5.5.2.5 of GS NFV-SOL 005." description: > 200 OK Information about the individual PNFD descriptor. The response body shall contain a representation of the individual PNF descriptor. headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "object" properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: "Delete PNFD" description: "The DELETE method deletes an individual PNF descriptor resource.\ \ An individual PNF descriptor resource can only be deleted when there is\ \ no NS instance using it or there is NSD referencing it. To delete all PNFD\ \ versions identified by a particular value of the \"pnfdInvariantId\" attribute,\ \ the procedure is to first use the GET method with filter \"pnfdInvariantId\"\ \ towards the PNF descriptors resource to find all versions of the PNFD. Then,\ \ the client uses the DELETE method described in this clause to delete each\ \ PNFD version individually. This method shall follow the provisions specified\ \ in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query\ \ parameters, request and response data structures, and response codes." parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." summary: Delete an individual PNF descriptor resource. description: > The DELETE method deletes an individual PNF descriptor resource. An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD referencing it. To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure is to first use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find all versions of the PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. responses: 204: description: "The operation has completed successfully. The response body\ \ shall be empty." headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > 204 No Content The operation has completed successfully. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" patch: summary: "Update PNFD Info" description: "The PATCH method modifies the user defined data of an individual\ \ PNF descriptor resource. This method shall follow the provisions specified\ \ in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request\ \ and response data structures, and response codes." consumes: [] summary: Modify the user defined data of an individual PNF descriptor resource. description: > The PATCH method modifies the user defined data of an individual PNF descriptor resource. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request. This header field\ \ shall be present if the request has a non-empty message body." description: > The MIME type of the body of the request. This header field shall be present if the request has a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." description: > The authorization token for the request. Details are specified in clause 4.5.3. - name: "body" in: "body" required: true schema: $ref: "#/definitions/PnfdInfoModifications" type: "object" required: - "PnfdInfoModifications" properties: PnfdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" description: > Parameters for the modification of an individual PNF descriptor resource, as defined in clause 5.5.2.4. responses: 200: description: "Status 200" description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual PNF Descriptor' resource. schema: $ref: "#/definitions/PnfdInfoModifications" type: "object" properties: PnfdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: description: "Status 412" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # PNFD Content # ############################################################################### '/pnf_descriptors/{pnfdInfoId}/pnfd_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7 parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor. in: "path" required: true type: "string" /pnf_descriptors/{pnfdInfoId}/pnfd_content: get: summary: "Get PNFD Content" description: "The GET method fetches the content of the PNFD." summary: Fetch the content of a PNFD. description: > The GET method fetches the content of the PNFD. This method shall follow the provisions specified in the Table 5.4.7.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string responses: 200: description: "On success, the content of the PNFD is returned. The payload\ \ body shall contain a copy of the file representing the PNFD. The \"\ Content-Type\" HTTP header shall be set to \"text/plain\"." description: > 200 OK On success, the content of the PNFD is returned. The payload body shall contain a copy of the file representing the PNFD. The Content-Type" HTTP header shall be set to "text/plain". headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "The \"Content-Type\" HTTP header shall be set to \"text/plain\"\ ." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" put: summary: "Upload PNFD" description: "The PUT method is used to upload the content of a PNFD. This method\ \ shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2\ \ of GS NFV-SOL 005for URI query parameters, request and response data structures,\ \ and response codes." consumes: [] summary: Upload the content of a PNFD. description: > The PUT method is used to upload the content of a PNFD. This resource represents the content of the individual PNF descriptor, i.e. PNFD content. The client can use this resource to upload and download the content of the PNFD. parameters: - name: "Content-Type" in: "header" required: false type: "string" description: "The request shall set the \"Content-Type\" HTTP header to \"\ text/plain\"." - name: "body" in: "body" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true schema: type: "object" description: "The payload body contains a copy of the file representing\ \ the PNFD." type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: "The PNFD content was successfully uploaded and validated.\ \ The response body shall be empty." description: > 204 No Content The PNFD content was successfully uploaded and validated. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: $ref: "#/definitions/ProblemDetails" parameters: - name: "pnfdInfoId" in: "path" required: true type: "string" /subscriptions: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-CREATED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Subscriptions # ############################################################################### '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8 get: summary: "Query Subscription Information" description: "The GET method queries the list of active subscriptions of the\ \ functional block that invokes the method. It can be used e.g. for resynchronization\ \ after error situations. This method shall support the URI query parameters,\ \ request and response data structures, and response codes, as specified in\ \ the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005." summary: Query multiple subscriptions. description: > The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall support the URI query parameters, request and response data structures, and response codes. This resource represents subscriptions. The client can use this resource to subscribe to notifications related to NSD management and to query its subscriptions. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." - name: "Authorization" in: "header" - name: "filter" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > Attribute filtering parameters according to clause 4.3.2. The NFVO shall support receiving attribute filter parameters as part of the URI query string. The OSS/BSS may supply an attribute filter. All attribute names that appear in the NsdmSubscription and in data types referenced from it shall be supported in attribute filter parameters. - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 200: description: "Status 200" schema: type: "array" description: "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." items: $ref: "#/definitions/NsdmSubscription" description: > 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. headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "array" items: properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" 303: description: "A subscription with the same callbackURI and the same filter\ \ already exits and the policy of the NFVO is to not create redundant\ \ subscriptions. The response body shall be empty." headers: Location: type: "string" description: "The HTTP response shall include a \"Location\" HTTP header\ \ that contains the resource URI of the existing subscription resource." description: > 303 See Other. A subscription with the same callbackURI and the same filter already exits and the policy of the NFVO is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Subscribe" description: "The POST method creates a new subscription. This method shall\ \ support the URI query parameters, request and response data structures,\ \ and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2\ \ of GS-NFV SOL 005. Creation of two subscription resources with the same\ \ callbackURI and the same filter can result in performance degradation and\ \ will provide duplicates of notifications to the OSS, and might make sense\ \ only in very rare use cases. Consequently, the NFVO may either allow creating\ \ a subscription resource if another subscription resource with the same filter\ \ and callbackUri already exists (in which case it shall return the \"201\ \ Created\" response code), or may decide to not create a duplicate subscription\ \ resource (in which case it shall return a \"303 See Other\" response code\ \ referencing the existing subscription resource with the same filter and\ \ callbackUri)." consumes: [] summary: Subscribe to NSD and PNFD change notifications. description: > The POST method creates a new subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2 of GS-NFV SOL 005. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri). This resource represents subscriptions. The client can use this resource to subscribe to notifications related to NSD management and to query its subscriptions. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true schema: $ref: "#/definitions/NsdmSubscriptionRequest" type: "object" required: - "NsdmSubscriptionRequest" properties: NsdmSubscriptionRequest: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest" description: > Details of the subscription to be created, as defined in clause 5.5.2.7. responses: 201: description: "Status 201" description: > 201 Created The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location:" HTTP header that points to the created subscription resource. schema: $ref: "#/definitions/NsdmSubscription" type: "object" properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Location: type: "string" description: "The HTTP response shall include a \"Location:\"\nHTTP\ \ header that points to the created subscription resource." Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /subscriptions/{subscriptionId}: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual Subscription # ############################################################################### '/subscriptions/{subscriptionId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9 parameters: - name: "subscriptionId" description: Identifier of this subscription. in: "path" required: true type: "string" get: summary: "Query Subscription Information" description: "The GET method retrieves information about a subscription by reading\ \ an individual subscription resource. This method shall support the URI query\ \ parameters, request and response data structures, and response codes, as\ \ specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2." summary: Read an individual subscription resource. description: > This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. The GET method retrieves information about a subscription by reading an individual subscription resource. This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 200: description: "Status 200" description: > 200 OK The operation has completed successfully. The response body shall contain a representation of the subscription resource. schema: $ref: "#/definitions/NsdmSubscription" type: "object" properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response. This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: "Terminate Subscription" description: "The DELETE method terminates an individual subscription. This\ \ method shall support the URI query parameters, request and response data\ \ structures, and response codes, as specified in the Tables 5.4.9.3.5-1 and\ \ 5.4.9.3.3-2 of GS NFV-SOL 005." summary: Terminate Subscription description: > This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.9.3.3-2. parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 204: description: > 204 No Content The subscription resource was deleted successfully. The response body shall be empty. 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ################################################################################## # Notification endpoint # # Dummy URI is used for testing. # # In real, resource URI is provided by the client when creating the subscription.# ################################################################################## '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdOnBoardingNotification description: > A notification about the successful on-boarding of an NSD. in: body required: true schema: properties: NsdOnBoardingNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: "The subscription resource was deleted successfully. The response\ \ body shall be empty." description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: "subscriptionId" in: "path" - name: NsdOnBoardingFailureNotification description: > A notification about the failure of on-boarding an NSD. in: body required: true type: "string" definitions: NsdInfoModifications: type: "object" properties: nsdOperationalState: $ref: "#/definitions/NsdOperationalStateType" userDefinedData: type: "object" 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." 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.\n\nNOTE: At least one of the attributes - nsdOperationalState and\ \ userDefinedData - shall be present." NsdmSubscription: type: "object" required: - "_links" - "callbackUri" - "id" properties: id: type: "string" description: "Identifier of this subscription resource" 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." NsdmNotificationsFilter: type: "object" properties: notificationTypes: type: "array" description: "Match particular notification types. Permitted values: NsdOnBoardingNotification,\ \ NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification\n\ PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.\n\ \nThe permitted values of the \"notificationTypes\" \nattribute are spelled\ \ exactly as the names of the notification types to facilitate automated\ \ code generation systems." items: type: "string" enum: - "NsdOnBoardingNotification" - "NsdOnboardingFailureNotification" - "NsdChangeNotification" - "NsdDeletionNotification" - "PnfdOnBoardingNotification" - "PnfdOnBoardingFailureNotification" - "PnfdDeletionNotification" nsdInfoId: type: "array" description: "Match the NsdInfo identifier which is allocated by the NFVO.\ \ Note: The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\ \ to a particular NSD in a filter. They should not be used both in the same\ \ filter instance, but one alternative should be chosen." items: type: "string" nsdId: type: "array" description: "Match the NSD identifier, which is allocated by the NSD designer.\ \ The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\ \ to a particular NSD in a filter. They should not be used both in the same\ \ filter instance, but one alternative should be chosen." items: type: "string" nsdName: type: "array" description: "Match the name of the onboarded NSD." items: type: "string" nsdVersion: type: "array" description: "Match the NSD version listed as part of this attribute. The\ \ NSD version is a string of variable length." items: type: "string" nsdDesigner: type: "array" description: "Match the NSD designer of the on-boarded NSD." items: type: "string" nsdInvariantId: type: "array" description: "Match the NSD invariant identifier which is allocated by the\ \ NSD designer and identifies an NSD in a version independent manner." items: type: "string" vnfPkgIds: type: "array" description: "Match VNF packages with a package identifier listed in the attribute." items: type: "string" pnfdInfoIds: type: "array" description: "Match the PnfdInfo identifier for the PNFD\nreferenced by the\ \ on-boarded NSD. The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives\ \ to reference to a particular PNFD in a filter. They should not be used\ \ both in the same filter instance, but one alternative should be chosen." items: type: "string" nestedNsdInfoIds: type: "array" description: "Match the NsdInfo identifier for the nested NSD\nreferenced\ \ by the on-boarded NSD." items: type: "string" nsdOnboardingState: type: "array" items: $ref: "#/definitions/NsdOnboardingStateType" nsdOperationalState: type: "array" items: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: type: "array" items: $ref: "#/definitions/NsdUsageStateType" pnfdId: type: "array" description: "Match the PNFD identifier which is copied from the PNFD content.\ \ The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives to reference\ \ to a particular PNFD in a filter. They should not be used both in the\ \ same filter instance, but one alternative should be chosen." items: type: "string" pnfdName: type: "array" description: "Match the name of the on-boarded PNFD." items: type: "string" pnfdVersion: type: "array" description: "Match the PNFD designer of the on-boarded PNFD. The PNFD version\ \ is a string of variable length." items: type: "string" pnfdProvider: type: "array" description: "Match the provider of the on-boarded PNFD." items: type: "string" pnfdInvariantId: type: "array" description: "Match the PNFD in a version independent manner." items: type: "string" pnfdOnboardingState: type: "array" items: $ref: "#/definitions/PnfdOnboardingStateType" pnfdUsageState: type: "array" items: $ref: "#/definitions/PnfdUsageStateType" description: "This type represents a subscription filter related to notifications\ \ about NSD management. It shall comply with the\nprovisions 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)." Uri: type: "object" description: "String formatted according to IETF RFC 3986 [10]." Link: type: "object" description: "This type represents a link to a resource. It shall comply with\ \ the provisions defined in Table 4.4.1.3-1 of GS NFV-SOL 005." SubscriptionAuthentication: type: "object" properties: authType: type: "string" description: "Defines the types of Authentication/ Authorization the API consumer\ \ is willing to accept when receiving a notification.\n\nPermitted values:\n\ BASIC: In every HTTP request to the notification endpoint, use HTTP Basic\ \ authentication with the client credentials.\n\nOAUTH2_CLIENT_CREDENTIALS:\ \ In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer\ \ token, obtained using the client credentials grant type.\n\nTLS_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." enum: - "BASIC" - "OAUTH2_CLIENT_CREDENTIALS" - "TLS_CERT" paramsBasic: type: "object" description: "Parameters for authentication/authorization using BASIC. Shall\ \ be present if authType is \"BASIC\" and the contained information has\ \ not been provisioned out of band. Shall be absent otherwise." properties: userName: type: "string" description: "Username to be used in HTTP Basic authentication. Shall\ \ be present if it has not been provisioned out of band." password: type: "string" description: "Password to be used in HTTP Basic authentication. Shall\ \ be present if it has not been provisioned out of band." paramsOauth2ClientCredentials: type: "object" description: "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.\ \ Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the\ \ contained information has not been provisioned out of band. Shall be absent\ \ otherwise." properties: clientId: type: "string" description: "Client identifier to be used in the access token request\ \ of the OAuth 2.0 client credentials grant type. Shall be present if\ \ it has not been provisioned out of band." 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.\n\nENABLED = The operational state of the resource\ \ is enabled.\nDISABLED = The operational state of the resource is disabled." enum: - "ENABLED" - "DISABLED" NsdInfo: type: "object" required: - "_links" - "id" - "nsdOnboardingState" - "nsdOperationalState" - "nsdUsageState" properties: id: type: "string" description: "Identifier of the onboarded individual NS descriptor resource.\ \ This identifier is allocated by the NFVO." nsdId: type: "object" 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." nsdName: type: "string" description: "Name of the onboarded NSD. This information is copied from the\ \ NSD content and shall be present after the NSD content is on-boarded." nsdVersion: type: "string" description: "Version of the on-boarded NSD. The NSD version is a string of\ \ variable length.This information is copied from the NSD content and shall\ \ be present after the NSD content is on-boarded." nsdDesigner: type: "string" description: "Designer of the on-boarded NSD. This information \nis copied\ \ from the NSD content and shall be present after the NSD content is on-boarded." nsdInvariantId: type: "string" 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." vnfPkgIds: type: "array" description: "Identifies the VNF package for the VNFD referenced by the on-boarded\ \ NS descriptor resource." items: type: "string" pnfdInfoIds: type: "array" description: "Identifies the PnfdInfo element for the PNFD referenced by the\ \ on-boarded NS descriptor resource." items: type: "string" nestedNsdInfoIds: type: "array" description: "Identifies the NsdInfo element for the nested NSD referenced\ \ by the on-boarded NS descriptor resource. At least one of the attributes\ \ – vnfPkgId and nestedNsdInfoId shall be present, after the NSD is on-boarded." items: type: "string" nsdOnboardingState: $ref: "#/definitions/NsdOnboardingStateType" onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" nsdOperationalState: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: $ref: "#/definitions/NsdUsageStateType" userDefinedData: $ref: "#/definitions/KeyValuePairs" _links: type: "object" description: "Links to resources related to this resource." properties: self: $ref: "#/definitions/Link" nsd_content: $ref: "#/definitions/Link" description: "This type represents a response for the query NSD operation. It\ \ shall comply with the provisions defined in\nTable 5.5.2.2-1 of GS NFV-SOL\ \ 005." 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 onboarding\ \ state of the NSD.\n\nCREATED = 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" required: - "detail" - "status" properties: type: $ref: "#/definitions/Uri" title: type: "string" 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." status: type: "integer" description: "The HTTP status code for this occurrence of the problem." detail: type: "string" description: "A human-readable explanation specific to this occurrence of\ \ the problem." instance: $ref: "#/definitions/Uri" description: "The definition of the general \"ProblemDetails\" data structure\ \ from IETF RFC 7807 [27] is reproduced in\nTable 4.3.5.3-1 of GS NFV-SOL 005.\ \ Compared to the general framework defined in IETF RFC 7807 [27], 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 [27] 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.\n\nThe description column only provides\ \ some explanation of the meaning to facilitate understanding of the design.\ \ For a\nfull description, see IETF RFC 7807 [27]." 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.\n\nIN_USE = The resource is in use.\nNOT_IN_USE = The resource\ \ is not-in-use." enum: - "IN_USE" - "NOT_IN_USE" KeyValuePairs: type: "object" 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 keyvalue\npairs is\ \ represented as an object. It shall comply with the provisions defined in clause\ \ 4 of IETF RFC 7159 [20]." CreateNsdInfoRequest: type: "object" properties: userDefinedData: $ref: "#/definitions/KeyValuePairs" description: "This type creates a completely new NS descriptor resource." PnfdInfoModifications: type: "object" required: - "userDefinedData" properties: userDefinedData: $ref: "#/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: type: "string" description: "Identifier of the onboarded individual PNF descriptor resource.\ \ This identifier is allocated by the NFVO." pnfdId: type: "string" description: "This identifier, which is managed by the PNFD\ndesigner, identifies\ \ the PNFD in a globally unique way. It is copied from the PNFD content\ \ and shall be present after the PNFD content is on-boarded." 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: type: "string" description: "Version of the onboarded PNFD. The PNFD version is a string\ \ of variable length.This information is copied from the PNFD content and\ \ shall be present after the PNFD content is on-boarded." 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: type: "string" description: "Identifies a PNFD in a version independent manner. This attribute\ \ is invariant across versions of PNFD." pnfdOnboardingState: $ref: "#/definitions/PnfdOnboardingStateType" onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" pnfdUsageState: $ref: "#/definitions/PnfdUsageStateType" userDefinedData: type: "array" description: "User defined data for the individual PNF descriptor resource.\ \ This attribute can be modified with the PATCH method." items: type: "object" _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.\n\nCREATED = 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.\n\nIN-USE = The resource is in use.\nNOT_IN_USE = The resource\ \ is not-in-use." enum: - "IN_USE" - "NOT_IN_USE" CreatePnfdInfoRequest: type: "object" properties: userDefinedData: $ref: "#/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" - "subscriptionId" - "timeStamp" schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdOnboardingNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: NsdOnBoardingFailureNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingFailureNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the NSD in a globally unique way. It is copied from the on-boarded\ \ NSD." _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 of GS NFV-SOL 005. 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" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdChangeNotification description: > A notification about the state change of an on-boarded NSD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdOnboardingFailureNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way." 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" - "subscriptionId" - "timeStamp" properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdChangeNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdChangeNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way. It is copied from the on-boarded NSD." 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 of GS NFV-SOL 005. 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" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdDeletionNotification description: > A notification about the deletion of an on-boarded NSD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdDeletionNotification \" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: NsdDeletionNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdDeletionNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way. It is copied from the on-boarded NSD." _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" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdOnBoardingNotification description: > A notification about the successful on-boarding of a PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdOnboardingNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: PnfdOnBoardingNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the PNFD in a globally unique way. It is copied from the on-boarded\ \ PNFD." _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the successful on-boarding of a\nPNFD. It shall comply with\ \ the provisions defined in Table 5.5.2.13-1. The support of this notification\ \ is mandatory. The notification is triggered when a new PNFD is on-boarded." PnfdOnboardingFailureNotification: type: "object" required: - "_links" - "id" - "notificationType" - "onboardingFailureDetails" - "pnfdInfoId" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdOnBoardingFailureNotification description: > A notification about the failure of on-boarding a PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdOnboardingFailureNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: PnfdOnBoardingFailureNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingFailureNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the PNFD in a globally unique way." onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the failure of on-boarding a\n PNFD. It shall comply with\ \ the provisions defined in Table 5.5.2.14-1 of GS NFV-SOL 005. The support\ \ of this notification is mandatory. The notification is triggered when the\ \ on-boarding of a PNFD fails." PnfdDeletionNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdDeletionNotification description: > A notification about the deletion of an on-boarded PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdDeletionNotification \" for this notification type." subscriptionId: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: PnfdDeletionNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdDeletionNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" get: summary: Test the notification endpoint description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during subscription. This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The notification endpoint was tested successfully. The response body shall be empty. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the PNFD in a globally unique way. It is copied from the on-boarded PNFD." _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the deletion of an on-boarded PNFD. The notification shall\ \ comply with the provisions defined in Table 5.5.2.15-1. The support of this\ \ notification is mandatory. The notification is triggered when an on-boarded\ \ PNFD is deleted." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" No newline at end of file Loading
src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml 0 → 100644 +884 −0 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml: 884 added lines, 0 removed lines. Original line number Diff line number Diff line definitions: 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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" vnfPkgIds: description: > Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdInfoIds: description: > Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nestedNsdInfoIds: description: > Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource. type: array items: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/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" required: - "self" - "nsd_content" description: > "Links to resources related to this resource." properties: self: description: > "URI of this resource." $ref: "SOL005_def.yaml#/definitions/Link" nsd_content: description: > "Link to the NSD content resource" $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents a response for the query NSD operation." 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: description: > Identifier of this subscription resource. $ref: "SOL005_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: "#/definitions/NsdmNotificationsFilter" callbackUri: description: > The URI of the endpoint to send the notification to. $ref: "SOL005_def.yaml#/definitions/Uri" _links: type: "object" description: > Links to resources related to this resource. properties: self: $ref: "SOL005_def.yaml#/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. 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: description: > Match the NsdInfo identifier which is allocated by the NFVO. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: description: > Match the NSD identifier, which is allocated by the NSD designer. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdName: description: > Match the name of the on boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" nsdVersion: description: > Match the NSD version listed as part of this attribute. type: array items: $ref: "SOL005_def.yaml#/definitions/Version" nsdDesigner: description: > "Match the NSD designer of the on-boarded NSD." type: array items: $ref: "SOL005_def.yaml#/definitions/String" nsdInvariantId: description: > Match the NSD invariant identifier which is allocated by the NSD designer and identifies an NSD in a version independent manner. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" vnfPkgIds: description: > Match VNF packages with a package identifier listed in the attribute. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdInfoIds: description: > Match the PnfdInfo identifier for the PNFD referenced by the on-boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nestedNsdInfoIds: description: > Match the NsdInfo identifier for the nested NSD referenced by the on-boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdOnboardingState: description: > Match particular on-boarding state of the NSD. type: array items: $ref: "#/definitions/NsdOnboardingStateType" nsdOperationalState: description: > Match particular operational state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: description: > Match particular usage state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdUsageStateType" pnfdId: description: > Match the PNFD identifier which is copied from the PNFD content. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: description: > Match the name of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdVersion: description: > Match the PNFD designer of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: description: > Match the provider of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdInvariantId: description: > Match the PNFD in a version independent manner. type: array items: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: description: > Match particular on-boarding state of the PNFD. type: array items: $ref: "#/definitions/PnfdOnboardingStateType" pnfdUsageState: description: > Match the usage state of the individual PNF descriptor resource. type: array items: $ref: "#/definitions/PnfdUsageStateType" 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 paramsBasic: type: "object" description: > Parameters for authentication/authorization using BASIC. Shall be present if authType is "BASIC" and the contained information has not been provisioned out of band. Shall be absent otherwise. properties: userName: description: > Username to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. type: string password: description: > Password to be used in HTTP Basic authentication. Shall be present if it has not been provisioned out of band. type: string paramsOauth2ClientCredentials: type: "object" description: > Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the contained information has not been provisioned out of band. Shall be absent otherwise properties: clientId: description: > Client identifier to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. type: string clientPassword: description: > Client password to be used in the access token request of the OAuth 2.0 client credentials grant type. Shall be present if it has not been provisioned out of band. type: string tokenEndpoint: description: > The token endpoint from which the access token can be obtained. Shall be present if it has not been provisioned out of band. $ref: "SOL005_def.yaml#/definitions/Uri" 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" 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" 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: - "id" - "pnfdOnboardingState" - "pnfdUsageState" - "_links" properties: id: description: > Identifier of the on-boarded individual PNF descriptor resource. This identifier is allocated by the NFVO. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: description: > This identifier, which is managed by the PNFD designer, identifies the PNFD in a globally unique way. It is copied from the PNFD content and shall be present after the PNFD content is on-boarded. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: description: > Name of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded. type: "string" pnfdersion: $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: description: > "Provider of the on-boarded PNFD. This information is copied from the PNFD content and shall be present after the PNFD content is on-boarded." type: "string" pnfdInvariantId: description: > Identifies a PNFD in a version independent manner. This attribute is invariant across versions of PNFD. $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: description: > On-boarding state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdOnboardingStateType" onboardingFailureDetails: description: > Failure details of current on-boarding procedure. It shall be present when the pnfdOnboardingState attribute is CREATED and the uploading or processing fails in the NFVO. $ref: "SOL005_def.yaml#/definitions/ProblemDetails" pnfdUsageState: description: > Usage state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdUsageStateType" userDefinedData: type: "array" description: > User defined data for the individual PNF descriptor resource. This attribute can be modified with the PATCH method. items: type: "object" _links: required: - "pnfd_content" - "self" type: "object" description: > "Links to resources related to this resource." properties: self: $ref: "SOL005_def.yaml#/definitions/Link" pnfd_content: $ref: "SOL005_def.yaml#/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 on-boarding 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: > User-defined data for the PNF descriptor resource to be created. It shall be present when the user defined data is set for the individual PNF descriptor resource to be created. NsdmLinks: type: "object" required: - "nsdInfo" - "subscription" properties: nsdInfo: $ref: "SOL005_def.yaml#/definitions/Link" subscription: $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents the links to resources that an NSD management notification can contain." PnfdmLinks: type: "object" required: - "pnfdInfo" - "subscription" properties: pnfdInfo: $ref: "SOL005_def.yaml#/definitions/Link" subscription: $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents the links to resources that a PNFD management notification can contain." NsdOnBoardingNotification: type: "object" required: - "_links" - "id" - "notificationType" - "nsdId" - "nsdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingFailureNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdChangeNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdDeletionNotification " for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: $ref: "SOL005_def.yaml#/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." PnfdOnBoardingNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the successful on-boarding of aPNFD. It shall comply with the provisions defined in Table 5.5.2.13-1. The support of this notification is mandatory. The notification is triggered when a new PNFD is on-boarded." PnfdOnBoardingFailureNotification: type: "object" required: - "_links" - "id" - "notificationType" - "onboardingFailureDetails" - "pnfdInfoId" - "timeStamp" properties: id: $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingFailureNotification" for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: $ref: "SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the failure of on-boarding a PNFD. It shall comply with the provisions defined in Table 5.5.2.14-1. The support of this notification is mandatory. The notification is triggered when the on-boarding of a PNFD fails." PnfdDeletionNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "timeStamp" properties: id: type: "string" description: > "Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "id" attribute of all these notifications shall have the same value." notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdDeletionNotification " for this notification type." subscriptionId: $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: description: > Date-time of the generation of the notification. $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > "This type represents a PNFD management notification, which informs the receiver of the deletion of an on-boarded PNFD. The notification shall comply with the provisions defined in Table 5.5.2.15-1. The support of this notification is mandatory. The notification is triggered when an on-boarded PNFD is deleted." No newline at end of file
src/SOL005/NSDManagement/definitions/SOL005_def.yaml 0 → 100644 +102 −0 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005_def.yaml: 102 added lines, 0 removed lines. Original line number Diff line number Diff line # 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
src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml 0 → 100644 +292 −0 Viewed Changes for src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml: 292 added lines, 0 removed lines. Original line number Diff line number Diff line responses: 202-with-Location: description: > Accepted The request was accepted for processing, but the processing has not been completed. The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "NS lifecycle operation occurrence" resource corresponding to the operation. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 Location: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" 202-with-Location-empty: description: > Accepted The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "NS Descriptor operation occurrence" resource corresponding to the operation. The response body shall be empty. headers: Location: description: The resource URI of the created NS instance type: string format: url WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 409: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact the NS descriptor resource is in the enabled operational state (i.e. operationalState = ENABLED) or there are running NS instances using the concerned individual NS descriptor resource (i.e. usageState = IN_USE). The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-another-nsd-operation-ongoing: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that another Descriptor operation is ongoing. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-inconsistent-state: description: > Conflict Another request is in progress that prohibits the fulfillment 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 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-INSTANTIATED: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-not-FAILED_TEMP: description: > The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is not in FAILED_TEMP state, or another error handling action is starting, such as rollback or fail. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-state-conflict-NOT-INSTANTIATED: description: > Conflict The operation cannot be executed currently, due to a conflict with the state of the NS instance resource. Typically, this is due to the fact that the NS instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-nsd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact "nsdOnboardingState" has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-ONBOARDED: description: > Conflict Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409-pnfd-onboarding-state-NOT-CREATED: description: > Conflict. Error: The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. type: string maximum: 1 minimum: 0 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" No newline at end of file
src/SOL005/NSDManagement/responses/SOL005_resp.yaml 0 → 100644 +417 −0 Viewed File added.Preview size limit exceeded, changes collapsed. Show changes
src/SOL005/NSDManagement/NSDManagement.yaml +1919 −1464 Viewed Changes for src/SOL005/NSDManagement/NSDManagement.yaml: 1919 added lines, 1464 removed lines. Original line number Diff line number Diff line --- swagger: "2.0" info: description: "DRAFT - SOL005 - NSD Management Interface IMPORTANT: Please note that\ \ this file might be not aligned to the current version of the ETSI Group Specification\ \ it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies\ \ the published ETSI Group Specification takes precedence. Please report bugs\ \ to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis\n" version: "2.4.1" title: "DRAFT - SOL005 - NSD Management Interface" contact: name: "NFV-SOL WG" version: "1.0.0" title: "SOL005 - NSD Management Interface" description: > SOL005 - NSD Management Interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis license: name: "ETSI Forge copyright notice" url: "https://forge.etsi.org/etsi-forge-copyright-notice.txt" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt contact: name: "NFV-SOL WG" externalDocs: description: ETSI GS NFV-SOL 005 V2.4.1 url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf basePath: "/nsd/v1" schemes: - https consumes: - "application/json" produces: - "application/json" paths: /ns_descriptors: ############################################################################### # NS Descriptors # ############################################################################### '/ns_descriptors': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2 get: summary: "Query NSD Info" description: "The GET method queries information about multiple NS descriptor\ \ resources. This method shall follow the provisions specified in the Tables\ \ 5.4.2.3.2-1 and 5.4.2.3.2-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." summary: Query information about multiple NS descriptor resources. description: > "The GET method queries information about multiple NS descriptor resources. This method shall follow the provisions specified in the Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters, request and response data structures, and response codes." parameters: - name: "Accept" in: "header" required: true - name: "filter" in: "query" required: false type: "string" description: "This header field shall be present if the response is expected\ \ to have a non-empty message body." - name: "Authorization" in: "header" 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. All attribute names that appear in the NsdInfo and in data types referenced from it shall be supported in attribute-based filtering parameters." - name: "all_fields" in: "query" required: false type: "string" description: > "Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO shall support this parameter." - name: "fields" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > "Complex attributes to be included into the response. See clause 4.3.3 for details. The NFVO should support this parameter." - name: "exclude_fields" in: "query" required: false type: "string" description: > "Complex attributes to be excluded from the response. See clause 4.3.3 for details. The NFVO should support this parameter." - name: "exclude_default" in: "query" required: false type: "string" description: > "Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The VNFM shall support this parameter. The following attributes shall be excluded from the NsdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: userDefinedData." - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 200: description: "Information about zero or more NS descriptors.\nThe response\ \ body shall contain a representation of zero or more NS descriptors,\ \ as defined in clause 5.5.2.2 of GS NFV-SOL 005." schema: $ref: "#/definitions/NsdInfo" description: > 200 OK Information about zero or more NS descriptors. The response body shall contain a representation of zero or more NS descriptors, as defined in clause 5.5.2.2 headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: array items: properties: NsdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" 400: description: "There are two possible scenarios listed below.\n\nError: Invalid\ \ attribute-based filtering parameters. \n\nThe response body shall contain\ \ a ProblemDetails structure, in which the \"detail\" attribute should\ \ convey more information about the error.\n\nError: Invalid attribute\ \ selector. The response body shall contain a ProblemDetails structure,\ \ in which the \"detail\" attribute should convey more information about\ \ the error." $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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Create NSD Info" description: "The POST method is used to create a new NS descriptor resource.\ \ This method shall follow the provisions specified in the Tables 5.4.2.3.1-1\ \ and 5.4.2.3.1-2 of GS NFV-SOL 005 for URI query parameters, request and\ \ response data structures, and response codes." consumes: [] summary: Create a new NS descriptor resource. description: > The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor. parameters: - name: "Accept" in: "header" required: false type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the\nresponse is expected to have a non-empty\n\ message body." - name: "Content-Type" in: "header" required: false type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005" type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true Loading @@ -100,157 +181,159 @@ paths: - "CreateNsdInfoRequest" properties: CreateNsdInfoRequest: $ref: "#/definitions/CreateNsdInfoRequest" description: "The CreateNsdInfoRequest contains parameters for creating\ \ an NS descriptor resource, as defined in\nclause 5.5.2.4 of GS NFV-SOL\ \ 005." $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest" description: > Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3 responses: 201: description: "Status 201" description: > Status 201 An NS descriptor resource was created successfully, as a new NS descriptor resource. The response body shall contain a representation of the new NS descriptor resource, as defined in clause 5.5.2.3 of GS NFV-SOL 005. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the new NS descriptor resource. schema: type: "object" description: "An NS descriptor resource was created successfully, as a\ \ new NS descriptor resource. The response body shall contain a representation\ \ of the new NS descriptor resource, as defined in clause 5.5.2.2 of\ \ GS NFV-SOL 005." properties: NsdInfo: $ref: "#/definitions/NsdInfo" $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: Location: type: "string" description: "The HTTP response shall include a \"Location\" HTTP header\ \ that contains the resource URI of the new NS descriptor resource." Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /ns_descriptors/{nsdInfoId}: get: summary: "Query NSD Info" description: "The GET method reads information about an individual NS descriptor.\ \ This method shall follow the provisions specified in GS NFV-SOL 005 Tables\ \ 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual NS Descriptor # ############################################################################### '/ns_descriptors/{nsdInfoId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3 parameters: - name: "Accept" in: "header" - name: "nsdInfoId" description: > Identifier of the individual NS descriptor resource. in: "path" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present \nif the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" get: summary: Read information about an individual NS descriptor resource. description: > "The GET method reads information about an individual NS descriptor. This method shall follow the provisions specified in GS NFV-SOL 005 Tables 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." parameters: - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string responses: 200: description: "Information about the individual NS descriptor. The response\ \ body shall contain a representation of the individual NS descriptor,\ \ as defined in clause 5.5.2.2 of GS NFV-SOL 005." description: > 200 OK Information about the individual NS descriptor. The response body shall contain a representation of the individual NS descriptor. schema: $ref: "#/definitions/NsdInfo" type: "object" properties: NsdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." delete: summary: "Delete NSD" description: "The DELETE method deletes an individual NS descriptor resource.\ \ An individual NS descriptor resource can only be deleted when there is no\ \ NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled\ \ already (i.e. operationalState = DISABLED). Otherwise, the DELETE method\ \ shall fail. This method shall follow the provisions specified in the Tables\ \ 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters,\ \ request and response data structures, and response codes." parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." responses: 204: description: "The operation has completed successfully. The response body\ \ shall be empty." schema: type: "object" description: "The operation has completed successfully. The response body\ \ shall be empty." headers: description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: required: - "ProblemDetails" type: "object" description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due\ \ to the fact the NS descriptor resource is in the enabled operational\ \ state (i.e. operationalState = ENABLED) or there are running NS instances\ \ using the concerned individual NS descriptor resource (i.e. usageState\ \ = IN_USE). The response body shall contain a ProblemDetails structure,\ \ in which the \"detail\" attribute shall convey more information about\ \ the error." properties: ProblemDetails: $ref: "#/definitions/ProblemDetails" $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" patch: summary: "Update NSD Info" description: "The PATCH method modifies the operational state and/or user defined\ \ data of an individual NS descriptor resource. This method can be used to:\n\ 1) Enable a previously disabled individual NS descriptor resource, allowing\ \ again its use for instantiation of new\nnetwork service with this descriptor.\ \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change as a\nresult.\n\ 2) Disable a previously enabled individual NS descriptor resource, preventing\ \ any further use for instantiation of\nnew network service(s) with this descriptor.\ \ The usage state (i.e. \"IN_USE/NOT_IN_USE\") shall not change\nas a result.\n\ 3) Modify the user defined data of an individual NS descriptor resource.\n\ This method shall follow the provisions specified in the Tables 5.4.3.3.4-1\ \ and 5.4.3.3.4-2 for URI query parameters,\nrequest and response data structures,\ \ and response codes." consumes: [] summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource. description: > The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource. This method can be used to: 1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as result. 2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result. 3) Modify the user defined data of an individual NS descriptor resource. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3." - name: "body" in: "body" required: true Loading @@ -260,1486 +343,1858 @@ paths: - "NsdInfoModifications" properties: NsdInfoModifications: $ref: "#/definitions/NsdInfoModifications" description: "The operation was completed successfully. The response body\ \ shall contain attribute modifications for an 'Individual NS Descriptor'\ \ resource (see clause 5.5.2.6 of GS NFV SOL-005)." $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" description: > Parameters for the modification of an individual NS descriptor resource. - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 200: description: "Status 200" schema: $ref: "#/definitions/NsdInfoModifications" description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual NS Descriptor' resource. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: array items: properties: NsdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: Delete an individual NS descriptor resource. description: > The DELETE method deletes an individual NS descriptor resource. An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method shall fail. parameters: - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The operation has completed successfully. The response body shall be empty. headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: description: "Status 412" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # NSD Content # ############################################################################### '/ns_descriptors/{nsdInfoId}/nsd_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4 parameters: - name: "nsdInfoId" in: "path" required: true type: "string" /ns_descriptors/{nsdInfoId}/nsd_content: get: summary: "Get NSD Content" description: "The GET method fetches the content of the NSD.\n\nThe NSD can\ \ be implemented as a single file or as a collection of multiple files. If\ \ the NSD is implemented in the form of multiple files, a ZIP file embedding\ \ these files shall be returned. If the NSD is implemented as a single file,\ \ either that file or a ZIP file embedding that file shall be returned.\n\n\ The selection of the format is controlled by the \"Accept\" HTTP header passed\ \ in the GET request.\n\nNOTE: The structure of the NSD zip file is outside\ \ the scope of the present document." summary: Fetch the content of a NSD. description: > The GET method fetches the content of the NSD. The NSD can be implemented as a single file or as a collection of multiple files. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be returned. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be returned. The selection of the format is controlled by the "Accept" HTTP header passed in the GET request:• If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file, the file shall be returned; otherwise, an error message shall be returned.• If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the NSD shall be returned embedded in a ZIP file.• If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned.NOTE: The structure of the NSD zip file is outside the scope of the present document. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: "string" description: "String Required\nIf the “Accept” header contains only “text/plain”\ \ and the NSD is implemented as a single file, the file shall be returned;\ \ otherwise, an error message shall be returned.\n\nIf the “Accept” header\ \ contains only “application/zip”, the single file or the multiple files\ \ that make up the NSD shall be returned embedded in a ZIP file.\n\nIf the\ \ “Accept” header contains both “text/plain” and “application/zip”, it is\ \ up to the NFVO to choose the format to return for a single-file NSD; for\ \ a multi-file NSD, a ZIP file shall be returned." - name: "Range" in: "header" type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The request may contain a \"Range\" HTTP header to obtain single\ \ range of bytes from the NSD file. This can be used to continue an aborted\ \ transmission.\n\nIf the NFVO does not support range requests, the NFVO\ \ shall ignore the 'Range\" header, process the GET request, and return\ \ the whole NSD file with a 200 OK response (rather than returning a 4xx\ \ error status code)." - name: "Authorization" type: string - name: "Range" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > "The request may contain a "Range" HTTP header to obtain single range of bytes from the NSD file. This can be used to continue an aborted transmission.If the NFVO does not support range requests, the NFVO shall ignore the 'Range" header, process the GET request, and return the whole NSD file with a 200 OK response (rather than returning a 4xx error status code)." responses: 200: description: "On success, the content of the NSD is returned. The payload\ \ body shall contain a copy of the file representing the NSD or a ZIP\ \ file that contains the file or multiple files representing the NSD,\ \ as specified above. The \"Content-Type\" HTTP header shall be set according\ \ to the format of the returned file, i.e. to \"text/plain\" for a YAML\ \ file or to \"application/zip\" for a ZIP file." schema: type: "object" description: > 200 OK On success, the content of the NSD is returned. The payload body shall contain a copy of the file representing the NSD or a ZIP file that contains the file or multiple files representing the NSD, as specified above. The "Content-Type" HTTP header shall be set according to the format of the returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file. headers: Content-Type: type: "string" description: "The \"Content-Type\" HTTP header shall be set according\ \ to the format of the returned file, i.e. to \"text/plain\" for a\ \ YAML file or to \"application/zip\" for a ZIP file." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." Content-Range: type: "string" description: "Signals the byte range that is contained in the response,\ \ and the total length of the file." Accept-Ranges: type: "string" description: "Used by the server to signal whether or ot it supports\ \ ranges for certain resources." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: description: "On success, if the NFVO supports range requests, a single\ \ consecutive byte range from the content of the NSD file is returned.\n\ \nThe response body shall contain the requested part of the NSD file.\n\ \nThe \"Content-Range\" HTTP header shall be provided according to IETF\ \ RFC 7233 [23].\n\nThe \"Content-Type\" HTTP header shall be set as defined\ \ above for the \"200 OK\" response." headers: Content-Range: type: "string" Content-Type: type: "string" $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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: description: "Status 406" schema: type: "object" description: "If the \"Accept\" header does not contain at least one name\ \ of a content type for which the NFVO can provide a representation\ \ of the NSD, the NFVO shall respond with this response code. The \"\ ProblemDetails\" structure may be included with the \"detail\" attribute\ \ providing more information about the error." $ref: "responses/SOL005_resp.yaml#/responses/406" 409: description: "Status 409" schema: type: "object" description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due\ \ to the fact \"nsdOnboardingState\" has a value different from ONBOARDED.\ \ The response body shall contain a ProblemDetails structure, in which\ \ the \"detail\" attribute shall convey more information about the error." $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: description: "Status 416" schema: type: "object" description: "The byte range passed in the \"Range\" header did not match\ \ any available byte range in the NSD file (e.g.\n\"access after end\ \ of file\"). The response body may contain a ProblemDetails structure." $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" put: summary: "Upload NSD" description: "The PUT method is used to upload the content of a NSD. The NSD\ \ to be uploaded can be implemented as a single file or as a collection of\ \ multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the\ \ NSD is implemented in the form of multiple files, a ZIP file embedding these\ \ files shall be uploaded. If the NSD is implemented as a single file, either\ \ that file or a ZIP file embedding that file shall be uploaded. The \"Content-Type\"\ \ HTTP header in the PUT request shall be set accordingly based on the format\ \ selection of the NSD. If the NSD to be uploaded is a text file, the \"Content-Type\"\ \ header is set to \"text/plain\". If the NSD to be uploaded is a zip file,\ \ the \"Content-Type\" header is set to \"application/zip\". This method shall\ \ follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2\ \ of GS-NFV-SOL 005 for URI query parameters, request and response data structures,\ \ and response codes." consumes: [] summary: Upload the content of a NSD. description: > "The PUT method is used to upload the content of a NSD. The NSD to be uploaded can be implemented as a single file or as a collection of multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be uploaded. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be uploaded. The "Content-Type" HTTP header in the PUT request shall be set accordingly based on the format selection of the NSD. If the NSD to be uploaded is a text file, the "Content-Type" header is set to "text/plain". If the NSD to be uploaded is a zip file, the "Content-Type" header is set to "application/zip". This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2 of GS-NFV-SOL 005 for URI query parameters, request and response data structures, and response codes." parameters: - name: "Content-Type" in: "header" required: false type: "string" description: "The payload body contains a copy of the file representing the\ \ NSD or a ZIP file that contains the file or multiple files representing\ \ the NSD, as specified above. The request shall set the \"Content-Type\"\ \ HTTP header as defined\nabove." - name: "body" in: "body" - name: Accept description: > Content-Types that are acceptable for the response. The payload body contains a copy of the file representing the NSD or a ZIP file that contains the file or multiple files representing the NSD. in: header required: true schema: type: "object" type: string enum: - text/plain - application/zip - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 202: description: "Status 202" schema: type: "object" description: "The NSD content was accepted for uploading, but the processing\ \ has not been completed. It is expected to take some time for processing\ \ (asynchronous mode). The response body shall be empty. See note." description: > 202 Accepted The NSD content was accepted for uploading, but the processing has not been completed. It is expected to take some time for processing (asynchronous mode). The response body shall be empty. headers: Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 204: description: "The NSD content was successfully uploaded and validated (synchronous\ \ mode). The response body shall be empty." description: > 204 No Content The NSD content was successfully uploaded and validated (synchronous mode). The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Error: The operation cannot be executed currently, due to\ \ a conflict with the state of the resource. Typically, this is due to\ \ the fact that the NsdOnboardingState has a value other than CREATED.\ \ The response body shall contain a ProblemDetails structure, in which\ \ the \"detail\" attribute shall convey more information about the error." schema: $ref: "#/definitions/ProblemDetails" parameters: - name: "nsdInfoId" in: "path" required: true type: "string" /pnf_descriptors: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # PNF Descriptors # ############################################################################### '/pnf_descriptors': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5 get: summary: "Query PFND Info" description: "The GET method queries information about multiple PNF descriptor\ \ resources." summary: Query information about multiple PNF descriptor resources. description: > "The GET method queries information about multiple PNF descriptor resources." parameters: - name: "exclude_default" - name: "filter" in: "query" required: false type: "string" description: "Indicates to exclude the following \n \ncomplex attributes from\ \ the response. \nSee clause 4.3.3 for details.\n\nThe NFVO shall support\ \ this parameter.\n\nThe following attributes shall be excluded from the\ \ PnfdInfo structure in the response body if this parameter is provided,\ \ or none of the parameters \"all_fields,\" \"fields\", \"exclude_fields\"\ , \"exclude_default\" are provided: userDefinedData." 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. All attribute names that appear in the PnfdInfo and in data types referenced from it shall be supported in attribute-based filtering parameters. - name: "all_fields" in: "query" required: false type: "string" description: "Include all complex attributes in the response. See clause 4.3.3\ \ for details. The NFVO shall support this parameter." - name: "Accept" in: "header" description: > Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO shall support this parameter. - name: "fields" in: "query" required: false type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" description: > Complex attributes to be included into the response. See clause 4.3.3 for details. The NFVO should support this parameter. - name: "exclude_fields" in: "query" required: false type: "string" description: > Complex attributes to be excluded from the response. See clause 4.3.3 for details. The NFVO should support this parameter. - name: "exclude_default" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The NFVO shall support this parameter. The following attributes shall be excluded from the PnfdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: userDefinedData. responses: 200: description: "Status 200" schema: type: "object" description: "Information about zero or more PNF descriptors. The response\ \ body shall contain a representation of zero or more PNF descriptors,\ \ as defined in clause 5.5.2.2." description: > 200 OK Information about zero or more PNF descriptors. The response body shall contain a representation of zero or more PNF descriptors, as defined in clause 5.5.2.2 headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "array" items: properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Create PNFD Info" description: "The POST method is used to create a new PNF descriptor resource." consumes: [] summary: Create a new PNF descriptor resource. description: > The POST method is used to create a new PNF descriptor resource parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS-NFV-SOL 005." type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true schema: type: "object" description: "Parameters of creating a PNF descriptor resource, as defined\ \ in\nclause 5.5.2.6 of GS NFV-SOL 005." required: - "CreatePnfdInfoRequest" properties: CreatePnfdInfoRequest: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest" description: > Parameters of creating a PNF descriptor resource. responses: 201: description: "Status 201" description: > 201 Created A PNF descriptor resource was created successfully, as a new PNF descriptor resource. The response body shall contain a representation of the new PNF descriptor resource, as defined in clause 5.5.2.5. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the new PNF descriptor resource. schema: type: "object" description: "A PNF descriptor resource was created successfully, as a\ \ new PNF descriptor resource. The response body shall contain a representation\ \ of the new PNF descriptor resource, as defined in clause 5.5.2.5.\ \ The HTTP response shall include a \"Location\" HTTP header that contains\ \ the resource URI of the new PNF descriptor resource." properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /pnf_descriptors/{pnfdInfoId}: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual PNF Descriptor # ############################################################################### '/pnf_descriptors/{pnfdInfoId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6 parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor resource. in: "path" required: true type: "string" get: summary: "Query PNFD Info" description: "The GET method reads information about an individual PNF descriptor.\ \ This method shall follow the provisions specified in the Tables 5.4.6.3.2-1\ \ and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and\ \ response data structures, and response codes." summary: Read an individual PNFD resource. description: > The GET method reads information about an individual PNF descriptor. This method shall follow the provisions specified in the Tables 5.4.6.3.2-1 and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and response data structures, and response codes. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 200: description: "Information about the individual PNFD descriptor. The response\ \ body shall contain a representation of the individual PNF descriptor,\ \ as defined in clause 5.5.2.5 of GS NFV-SOL 005." description: > 200 OK Information about the individual PNFD descriptor. The response body shall contain a representation of the individual PNF descriptor. headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "object" properties: PnfdInfo: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: "Delete PNFD" description: "The DELETE method deletes an individual PNF descriptor resource.\ \ An individual PNF descriptor resource can only be deleted when there is\ \ no NS instance using it or there is NSD referencing it. To delete all PNFD\ \ versions identified by a particular value of the \"pnfdInvariantId\" attribute,\ \ the procedure is to first use the GET method with filter \"pnfdInvariantId\"\ \ towards the PNF descriptors resource to find all versions of the PNFD. Then,\ \ the client uses the DELETE method described in this clause to delete each\ \ PNFD version individually. This method shall follow the provisions specified\ \ in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query\ \ parameters, request and response data structures, and response codes." parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." summary: Delete an individual PNF descriptor resource. description: > The DELETE method deletes an individual PNF descriptor resource. An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD referencing it. To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure is to first use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find all versions of the PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. responses: 204: description: "The operation has completed successfully. The response body\ \ shall be empty." headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > 204 No Content The operation has completed successfully. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" patch: summary: "Update PNFD Info" description: "The PATCH method modifies the user defined data of an individual\ \ PNF descriptor resource. This method shall follow the provisions specified\ \ in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request\ \ and response data structures, and response codes." consumes: [] summary: Modify the user defined data of an individual PNF descriptor resource. description: > The PATCH method modifies the user defined data of an individual PNF descriptor resource. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request. This header field\ \ shall be present if the request has a non-empty message body." description: > The MIME type of the body of the request. This header field shall be present if the request has a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request. Details are specified\ \ in clause 4.5.3." description: > The authorization token for the request. Details are specified in clause 4.5.3. - name: "body" in: "body" required: true schema: $ref: "#/definitions/PnfdInfoModifications" type: "object" required: - "PnfdInfoModifications" properties: PnfdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" description: > Parameters for the modification of an individual PNF descriptor resource, as defined in clause 5.5.2.4. responses: 200: description: "Status 200" description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual PNF Descriptor' resource. schema: $ref: "#/definitions/PnfdInfoModifications" type: "object" properties: PnfdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: description: "Status 412" schema: $ref: "#/definitions/ProblemDetails" $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # PNFD Content # ############################################################################### '/pnf_descriptors/{pnfdInfoId}/pnfd_content': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7 parameters: - name: "pnfdInfoId" description: > Identifier of the individual PNF descriptor. in: "path" required: true type: "string" /pnf_descriptors/{pnfdInfoId}/pnfd_content: get: summary: "Get PNFD Content" description: "The GET method fetches the content of the PNFD." summary: Fetch the content of a PNFD. description: > The GET method fetches the content of the PNFD. This method shall follow the provisions specified in the Table 5.4.7.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non-empty\ \ message body." - name: "Authorization" in: "header" type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string responses: 200: description: "On success, the content of the PNFD is returned. The payload\ \ body shall contain a copy of the file representing the PNFD. The \"\ Content-Type\" HTTP header shall be set to \"text/plain\"." description: > 200 OK On success, the content of the PNFD is returned. The payload body shall contain a copy of the file representing the PNFD. The Content-Type" HTTP header shall be set to "text/plain". headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." Content-Type: description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "The \"Content-Type\" HTTP header shall be set to \"text/plain\"\ ." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" put: summary: "Upload PNFD" description: "The PUT method is used to upload the content of a PNFD. This method\ \ shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2\ \ of GS NFV-SOL 005for URI query parameters, request and response data structures,\ \ and response codes." consumes: [] summary: Upload the content of a PNFD. description: > The PUT method is used to upload the content of a PNFD. This resource represents the content of the individual PNF descriptor, i.e. PNFD content. The client can use this resource to upload and download the content of the PNFD. parameters: - name: "Content-Type" in: "header" required: false type: "string" description: "The request shall set the \"Content-Type\" HTTP header to \"\ text/plain\"." - name: "body" in: "body" - name: Accept description: > Content-Types that are acceptable for the response. in: header required: true schema: type: "object" description: "The payload body contains a copy of the file representing\ \ the PNFD." type: string enum: - text/plain - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: "The PNFD content was successfully uploaded and validated.\ \ The response body shall be empty." description: > 204 No Content The PNFD content was successfully uploaded and validated. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: description: "Status 409" schema: $ref: "#/definitions/ProblemDetails" parameters: - name: "pnfdInfoId" in: "path" required: true type: "string" /subscriptions: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-CREATED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Subscriptions # ############################################################################### '/subscriptions': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8 get: summary: "Query Subscription Information" description: "The GET method queries the list of active subscriptions of the\ \ functional block that invokes the method. It can be used e.g. for resynchronization\ \ after error situations. This method shall support the URI query parameters,\ \ request and response data structures, and response codes, as specified in\ \ the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005." summary: Query multiple subscriptions. description: > The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations. This method shall support the URI query parameters, request and response data structures, and response codes. This resource represents subscriptions. The client can use this resource to subscribe to notifications related to NSD management and to query its subscriptions. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." - name: "Authorization" in: "header" - name: "filter" in: "query" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > Attribute filtering parameters according to clause 4.3.2. The NFVO shall support receiving attribute filter parameters as part of the URI query string. The OSS/BSS may supply an attribute filter. All attribute names that appear in the NsdmSubscription and in data types referenced from it shall be supported in attribute filter parameters. - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 200: description: "Status 200" schema: type: "array" description: "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." items: $ref: "#/definitions/NsdmSubscription" description: > 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. headers: Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: The MIME type of the body of the response. type: string maximum: 1 minimum: 1 WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 schema: type: "array" items: properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" 303: description: "A subscription with the same callbackURI and the same filter\ \ already exits and the policy of the NFVO is to not create redundant\ \ subscriptions. The response body shall be empty." headers: Location: type: "string" description: "The HTTP response shall include a \"Location\" HTTP header\ \ that contains the resource URI of the existing subscription resource." description: > 303 See Other. A subscription with the same callbackURI and the same filter already exits and the policy of the NFVO is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" post: summary: "Subscribe" description: "The POST method creates a new subscription. This method shall\ \ support the URI query parameters, request and response data structures,\ \ and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2\ \ of GS-NFV SOL 005. Creation of two subscription resources with the same\ \ callbackURI and the same filter can result in performance degradation and\ \ will provide duplicates of notifications to the OSS, and might make sense\ \ only in very rare use cases. Consequently, the NFVO may either allow creating\ \ a subscription resource if another subscription resource with the same filter\ \ and callbackUri already exists (in which case it shall return the \"201\ \ Created\" response code), or may decide to not create a duplicate subscription\ \ resource (in which case it shall return a \"303 See Other\" response code\ \ referencing the existing subscription resource with the same filter and\ \ callbackUri)." consumes: [] summary: Subscribe to NSD and PNFD change notifications. description: > The POST method creates a new subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2 of GS-NFV SOL 005. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri). This resource represents subscriptions. The client can use this resource to subscribe to notifications related to NSD management and to query its subscriptions. parameters: - name: "Accept" in: "header" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." - name: "Content-Type" in: "header" required: true type: "string" description: "The MIME type of the body of the request.\nThis header field\ \ shall be present if the\nrequest has a non-empty message body." - name: "Authorization" in: "header" type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string - name: "body" in: "body" required: true schema: $ref: "#/definitions/NsdmSubscriptionRequest" type: "object" required: - "NsdmSubscriptionRequest" properties: NsdmSubscriptionRequest: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest" description: > Details of the subscription to be created, as defined in clause 5.5.2.7. responses: 201: description: "Status 201" description: > 201 Created The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location:" HTTP header that points to the created subscription resource. schema: $ref: "#/definitions/NsdmSubscription" type: "object" properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Location: type: "string" description: "The HTTP response shall include a \"Location:\"\nHTTP\ \ header that points to the created subscription resource." Content-Type: type: "string" description: "The MIME type of the body of the response. This header\ \ field shall be present if the response has a non-empty message body." description: > The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." /subscriptions/{subscriptionId}: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ############################################################################### # Individual Subscription # ############################################################################### '/subscriptions/{subscriptionId}': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9 parameters: - name: "subscriptionId" description: Identifier of this subscription. in: "path" required: true type: "string" get: summary: "Query Subscription Information" description: "The GET method retrieves information about a subscription by reading\ \ an individual subscription resource. This method shall support the URI query\ \ parameters, request and response data structures, and response codes, as\ \ specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2." summary: Read an individual subscription resource. description: > This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. The GET method retrieves information about a subscription by reading an individual subscription resource. This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. parameters: - name: "Accept" in: "header" required: true type: "string" description: "Content-Types that are acceptable for the\nresponse. This header\ \ field shall be present if the response is expected to have a non empty\ \ message body." description: > Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 200: description: "Status 200" description: > 200 OK The operation has completed successfully. The response body shall contain a representation of the subscription resource. schema: $ref: "#/definitions/NsdmSubscription" type: "object" properties: NsdmSubscription: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Content-Type: type: "string" description: "The MIME type of the body of the response.\nThis header\ \ field shall be present if the\nresponse has a non-empty message\ \ body." description: > The MIME type of the body of the response. This header field shall be present if the response has a non-empty message body. WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request\nhas not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" delete: summary: "Terminate Subscription" description: "The DELETE method terminates an individual subscription. This\ \ method shall support the URI query parameters, request and response data\ \ structures, and response codes, as specified in the Tables 5.4.9.3.5-1 and\ \ 5.4.9.3.3-2 of GS NFV-SOL 005." summary: Terminate Subscription description: > This resource represents an individual subscription. It can be used by the client to read and to terminate a subscription to notifications related to NSD management. The DELETE method terminates an individual subscription. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.9.3.3-2. parameters: - name: "Authorization" in: "header" required: false type: "string" description: "The authorization token for the request.\nDetails are specified\ \ in clause 4.5.3 of GS NFV-SOL 005." description: > The authorization token for the request. Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 204: description: > 204 No Content The subscription resource was deleted successfully. The response body shall be empty. 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" ################################################################################## # Notification endpoint # # Dummy URI is used for testing. # # In real, resource URI is provided by the client when creating the subscription.# ################################################################################## '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdOnBoardingNotification description: > A notification about the successful on-boarding of an NSD. in: body required: true schema: properties: NsdOnBoardingNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: "The subscription resource was deleted successfully. The response\ \ body shall be empty." description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "Challenge if the corresponding HTTP request has not provided\ \ authorization, or error details if the corresponding HTTP request\ \ has provided an invalid authorization token." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdOnBoardingFailureNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: "subscriptionId" in: "path" - name: NsdOnBoardingFailureNotification description: > A notification about the failure of on-boarding an NSD. in: body required: true type: "string" definitions: NsdInfoModifications: type: "object" properties: nsdOperationalState: $ref: "#/definitions/NsdOperationalStateType" userDefinedData: type: "object" 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." 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.\n\nNOTE: At least one of the attributes - nsdOperationalState and\ \ userDefinedData - shall be present." NsdmSubscription: type: "object" required: - "_links" - "callbackUri" - "id" properties: id: type: "string" description: "Identifier of this subscription resource" 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." NsdmNotificationsFilter: type: "object" properties: notificationTypes: type: "array" description: "Match particular notification types. Permitted values: NsdOnBoardingNotification,\ \ NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification\n\ PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.\n\ \nThe permitted values of the \"notificationTypes\" \nattribute are spelled\ \ exactly as the names of the notification types to facilitate automated\ \ code generation systems." items: type: "string" enum: - "NsdOnBoardingNotification" - "NsdOnboardingFailureNotification" - "NsdChangeNotification" - "NsdDeletionNotification" - "PnfdOnBoardingNotification" - "PnfdOnBoardingFailureNotification" - "PnfdDeletionNotification" nsdInfoId: type: "array" description: "Match the NsdInfo identifier which is allocated by the NFVO.\ \ Note: The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\ \ to a particular NSD in a filter. They should not be used both in the same\ \ filter instance, but one alternative should be chosen." items: type: "string" nsdId: type: "array" description: "Match the NSD identifier, which is allocated by the NSD designer.\ \ The attributes \"nsdId\" and \"nsdInfoId\" are alternatives to reference\ \ to a particular NSD in a filter. They should not be used both in the same\ \ filter instance, but one alternative should be chosen." items: type: "string" nsdName: type: "array" description: "Match the name of the onboarded NSD." items: type: "string" nsdVersion: type: "array" description: "Match the NSD version listed as part of this attribute. The\ \ NSD version is a string of variable length." items: type: "string" nsdDesigner: type: "array" description: "Match the NSD designer of the on-boarded NSD." items: type: "string" nsdInvariantId: type: "array" description: "Match the NSD invariant identifier which is allocated by the\ \ NSD designer and identifies an NSD in a version independent manner." items: type: "string" vnfPkgIds: type: "array" description: "Match VNF packages with a package identifier listed in the attribute." items: type: "string" pnfdInfoIds: type: "array" description: "Match the PnfdInfo identifier for the PNFD\nreferenced by the\ \ on-boarded NSD. The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives\ \ to reference to a particular PNFD in a filter. They should not be used\ \ both in the same filter instance, but one alternative should be chosen." items: type: "string" nestedNsdInfoIds: type: "array" description: "Match the NsdInfo identifier for the nested NSD\nreferenced\ \ by the on-boarded NSD." items: type: "string" nsdOnboardingState: type: "array" items: $ref: "#/definitions/NsdOnboardingStateType" nsdOperationalState: type: "array" items: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: type: "array" items: $ref: "#/definitions/NsdUsageStateType" pnfdId: type: "array" description: "Match the PNFD identifier which is copied from the PNFD content.\ \ The attributes \"pnfdId\" and \"pnfdInfoId\" are alternatives to reference\ \ to a particular PNFD in a filter. They should not be used both in the\ \ same filter instance, but one alternative should be chosen." items: type: "string" pnfdName: type: "array" description: "Match the name of the on-boarded PNFD." items: type: "string" pnfdVersion: type: "array" description: "Match the PNFD designer of the on-boarded PNFD. The PNFD version\ \ is a string of variable length." items: type: "string" pnfdProvider: type: "array" description: "Match the provider of the on-boarded PNFD." items: type: "string" pnfdInvariantId: type: "array" description: "Match the PNFD in a version independent manner." items: type: "string" pnfdOnboardingState: type: "array" items: $ref: "#/definitions/PnfdOnboardingStateType" pnfdUsageState: type: "array" items: $ref: "#/definitions/PnfdUsageStateType" description: "This type represents a subscription filter related to notifications\ \ about NSD management. It shall comply with the\nprovisions 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)." Uri: type: "object" description: "String formatted according to IETF RFC 3986 [10]." Link: type: "object" description: "This type represents a link to a resource. It shall comply with\ \ the provisions defined in Table 4.4.1.3-1 of GS NFV-SOL 005." SubscriptionAuthentication: type: "object" properties: authType: type: "string" description: "Defines the types of Authentication/ Authorization the API consumer\ \ is willing to accept when receiving a notification.\n\nPermitted values:\n\ BASIC: In every HTTP request to the notification endpoint, use HTTP Basic\ \ authentication with the client credentials.\n\nOAUTH2_CLIENT_CREDENTIALS:\ \ In every HTTP request to the notification endpoint, use an OAuth 2.0 Bearer\ \ token, obtained using the client credentials grant type.\n\nTLS_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." enum: - "BASIC" - "OAUTH2_CLIENT_CREDENTIALS" - "TLS_CERT" paramsBasic: type: "object" description: "Parameters for authentication/authorization using BASIC. Shall\ \ be present if authType is \"BASIC\" and the contained information has\ \ not been provisioned out of band. Shall be absent otherwise." properties: userName: type: "string" description: "Username to be used in HTTP Basic authentication. Shall\ \ be present if it has not been provisioned out of band." password: type: "string" description: "Password to be used in HTTP Basic authentication. Shall\ \ be present if it has not been provisioned out of band." paramsOauth2ClientCredentials: type: "object" description: "Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.\ \ Shall be present if authType is \"OAUTH2_CLIENT_CREDENTIALS\" and the\ \ contained information has not been provisioned out of band. Shall be absent\ \ otherwise." properties: clientId: type: "string" description: "Client identifier to be used in the access token request\ \ of the OAuth 2.0 client credentials grant type. Shall be present if\ \ it has not been provisioned out of band." 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.\n\nENABLED = The operational state of the resource\ \ is enabled.\nDISABLED = The operational state of the resource is disabled." enum: - "ENABLED" - "DISABLED" NsdInfo: type: "object" required: - "_links" - "id" - "nsdOnboardingState" - "nsdOperationalState" - "nsdUsageState" properties: id: type: "string" description: "Identifier of the onboarded individual NS descriptor resource.\ \ This identifier is allocated by the NFVO." nsdId: type: "object" 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." nsdName: type: "string" description: "Name of the onboarded NSD. This information is copied from the\ \ NSD content and shall be present after the NSD content is on-boarded." nsdVersion: type: "string" description: "Version of the on-boarded NSD. The NSD version is a string of\ \ variable length.This information is copied from the NSD content and shall\ \ be present after the NSD content is on-boarded." nsdDesigner: type: "string" description: "Designer of the on-boarded NSD. This information \nis copied\ \ from the NSD content and shall be present after the NSD content is on-boarded." nsdInvariantId: type: "string" 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." vnfPkgIds: type: "array" description: "Identifies the VNF package for the VNFD referenced by the on-boarded\ \ NS descriptor resource." items: type: "string" pnfdInfoIds: type: "array" description: "Identifies the PnfdInfo element for the PNFD referenced by the\ \ on-boarded NS descriptor resource." items: type: "string" nestedNsdInfoIds: type: "array" description: "Identifies the NsdInfo element for the nested NSD referenced\ \ by the on-boarded NS descriptor resource. At least one of the attributes\ \ – vnfPkgId and nestedNsdInfoId shall be present, after the NSD is on-boarded." items: type: "string" nsdOnboardingState: $ref: "#/definitions/NsdOnboardingStateType" onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" nsdOperationalState: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: $ref: "#/definitions/NsdUsageStateType" userDefinedData: $ref: "#/definitions/KeyValuePairs" _links: type: "object" description: "Links to resources related to this resource." properties: self: $ref: "#/definitions/Link" nsd_content: $ref: "#/definitions/Link" description: "This type represents a response for the query NSD operation. It\ \ shall comply with the provisions defined in\nTable 5.5.2.2-1 of GS NFV-SOL\ \ 005." 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 onboarding\ \ state of the NSD.\n\nCREATED = 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" required: - "detail" - "status" properties: type: $ref: "#/definitions/Uri" title: type: "string" 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." status: type: "integer" description: "The HTTP status code for this occurrence of the problem." detail: type: "string" description: "A human-readable explanation specific to this occurrence of\ \ the problem." instance: $ref: "#/definitions/Uri" description: "The definition of the general \"ProblemDetails\" data structure\ \ from IETF RFC 7807 [27] is reproduced in\nTable 4.3.5.3-1 of GS NFV-SOL 005.\ \ Compared to the general framework defined in IETF RFC 7807 [27], 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 [27] 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.\n\nThe description column only provides\ \ some explanation of the meaning to facilitate understanding of the design.\ \ For a\nfull description, see IETF RFC 7807 [27]." 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.\n\nIN_USE = The resource is in use.\nNOT_IN_USE = The resource\ \ is not-in-use." enum: - "IN_USE" - "NOT_IN_USE" KeyValuePairs: type: "object" 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 keyvalue\npairs is\ \ represented as an object. It shall comply with the provisions defined in clause\ \ 4 of IETF RFC 7159 [20]." CreateNsdInfoRequest: type: "object" properties: userDefinedData: $ref: "#/definitions/KeyValuePairs" description: "This type creates a completely new NS descriptor resource." PnfdInfoModifications: type: "object" required: - "userDefinedData" properties: userDefinedData: $ref: "#/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: type: "string" description: "Identifier of the onboarded individual PNF descriptor resource.\ \ This identifier is allocated by the NFVO." pnfdId: type: "string" description: "This identifier, which is managed by the PNFD\ndesigner, identifies\ \ the PNFD in a globally unique way. It is copied from the PNFD content\ \ and shall be present after the PNFD content is on-boarded." 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: type: "string" description: "Version of the onboarded PNFD. The PNFD version is a string\ \ of variable length.This information is copied from the PNFD content and\ \ shall be present after the PNFD content is on-boarded." 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: type: "string" description: "Identifies a PNFD in a version independent manner. This attribute\ \ is invariant across versions of PNFD." pnfdOnboardingState: $ref: "#/definitions/PnfdOnboardingStateType" onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" pnfdUsageState: $ref: "#/definitions/PnfdUsageStateType" userDefinedData: type: "array" description: "User defined data for the individual PNF descriptor resource.\ \ This attribute can be modified with the PATCH method." items: type: "object" _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.\n\nCREATED = 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.\n\nIN-USE = The resource is in use.\nNOT_IN_USE = The resource\ \ is not-in-use." enum: - "IN_USE" - "NOT_IN_USE" CreatePnfdInfoRequest: type: "object" properties: userDefinedData: $ref: "#/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" - "subscriptionId" - "timeStamp" schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdOnboardingNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: NsdOnBoardingFailureNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingFailureNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the NSD in a globally unique way. It is copied from the on-boarded\ \ NSD." _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 of GS NFV-SOL 005. 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" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdChangeNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdChangeNotification description: > A notification about the state change of an on-boarded NSD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdOnboardingFailureNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way." 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" - "subscriptionId" - "timeStamp" properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdChangeNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdChangeNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way. It is copied from the on-boarded NSD." 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 of GS NFV-SOL 005. 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" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-NsdDeletionNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: NsdDeletionNotification description: > A notification about the deletion of an on-boarded NSD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"NsdDeletionNotification \" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." nsdInfoId: type: "string" description: "Identifier of the NSD information object. This identifier is\ \ allocated by the NFVO." nsdId: NsdDeletionNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdDeletionNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the NSD in a globally unique way. It is copied from the on-boarded NSD." _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" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdOnBoardingNotification description: > A notification about the successful on-boarding of a PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdOnboardingNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: PnfdOnBoardingNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the PNFD in a globally unique way. It is copied from the on-boarded\ \ PNFD." _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the successful on-boarding of a\nPNFD. It shall comply with\ \ the provisions defined in Table 5.5.2.13-1. The support of this notification\ \ is mandatory. The notification is triggered when a new PNFD is on-boarded." PnfdOnboardingFailureNotification: type: "object" required: - "_links" - "id" - "notificationType" - "onboardingFailureDetails" - "pnfdInfoId" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdOnBoardingFailureNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdOnBoardingFailureNotification description: > A notification about the failure of on-boarding a PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdOnboardingFailureNotification\" for this notification type." subscriptionId: type: "string" description: "Identifier of the subscription that this notification relates\ \ to." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: PnfdOnBoardingFailureNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingFailureNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service\nprovider,\ \ identifies the PNFD in a globally unique way." onboardingFailureDetails: $ref: "#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the failure of on-boarding a\n PNFD. It shall comply with\ \ the provisions defined in Table 5.5.2.14-1 of GS NFV-SOL 005. The support\ \ of this notification is mandatory. The notification is triggered when the\ \ on-boarding of a PNFD fails." PnfdDeletionNotification: type: "object" required: - "_links" - "id" - "notificationType" - "pnfdId" - "pnfdInfoId" - "subscriptionId" - "timeStamp" description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" '/URI_is_provided_by_the_client_when_creating_the_subscription-PnfdDeletionNotification': #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.10 post: summary: Notify about NSD and PNFD changes description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The POST method delivers a notification from the server to the client. This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the Table 5.4.10.3.1-2. parameters: - name: PnfdDeletionNotification description: > A notification about the deletion of an on-boarded PNFD. in: body required: true schema: properties: id: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." notificationType: type: "string" description: "Discriminator for the different notification types. Shall be\ \ set to \"PnfdDeletionNotification \" for this notification type." subscriptionId: type: "string" description: "Identifier of this notification. If a notification is sent multiple\ \ times due to multiple subscriptions, the \"id\" attribute of all these\ \ notifications shall have the same value." timeStamp: type: "string" format: "date-time" description: "Date-time of the generation of the notification." pnfdInfoId: PnfdDeletionNotification: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdDeletionNotification" - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string - name: Content-Type description: > The MIME type of the body of the request. Reference: IETF RFC 7231 in: header required: true type: string responses: 204: description: > 204 No Content The notification was delivered successfully. headers: WWW-Authenticate: type: "string" description: "Identifier of the PNFD information object. This identifier is\ \ allocated by the NFVO." pnfdId: description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" get: summary: Test the notification endpoint description: > This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed client, which has provided the URI of this resource during the subscription process. The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during subscription. This method shall follow the provisions specified in the Table 5.4.10.3.2-2 for URI query parameters, request and response data structures, and response codes. parameters: - name: Accept description: > Content-Types that are acceptable for the response. Reference: IETF RFC 7231 in: header required: true type: string - name: Authorization description: > The authorization token for the request. Reference: IETF RFC 7235 in: header required: false type: string responses: 204: description: > 204 No Content The notification endpoint was tested successfully. The response body shall be empty. headers: WWW-Authenticate: type: "string" description: "This identifier, which is managed by the service provider, identifies\ \ the PNFD in a globally unique way. It is copied from the on-boarded PNFD." _links: $ref: "#/definitions/PnfdmLinks" description: "This type represents a PNFD management notification, which informs\ \ the receiver of the deletion of an on-boarded PNFD. The notification shall\ \ comply with the provisions defined in Table 5.5.2.15-1. The support of this\ \ notification is mandatory. The notification is triggered when an on-boarded\ \ PNFD is deleted." description: > Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. maximum: 1 minimum: 0 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 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" 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: $ref: "responses/SOL005_resp.yaml#/responses/503" No newline at end of file