Remove unnecessary API description in API-DQ
In VNF LCM API document, there is a Notification API where Tacker doesn't have an endpoint. Therefore, the API definition is unnecessary and should be removed. Change-Id: If0272e3211da2c1372551fcb47f8bf99c10a468e Closes-Bug: #1913665
This commit is contained in:
Hiroo Kitamura
parent
d2e817f2f9
commit
25d80fdb58
|
|
@ -781,73 +781,6 @@ mac_address_cp_info:
|
|||
in: body
|
||||
required: false
|
||||
type: string
|
||||
notification_id:
|
||||
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.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_operation:
|
||||
description: |
|
||||
The lifecycle management operation.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_operation_state:
|
||||
description: |
|
||||
The state of the VNF LCM operation occurrence.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_status:
|
||||
description: |
|
||||
Indicates whether this notification reports about the start
|
||||
of a lifecycle operation or the result of a lifecycle
|
||||
operation.
|
||||
Permitted values:
|
||||
|
||||
START: Informs about the start of the VNF LCM
|
||||
operation occurrence.
|
||||
|
||||
RESULT: Informs about the final or intermediate
|
||||
result of the VNF LCM operation occurrence.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_subscription_id:
|
||||
description: |
|
||||
Identifier of the subscription that this notification relates to.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_time_tamp:
|
||||
description: |
|
||||
Date-time of the generation of the notification.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_type:
|
||||
description: |
|
||||
Discriminator for the different notification types.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_vnf_instance_id:
|
||||
description: |
|
||||
The identifier of the VNF instance affected.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
notification_vnf_lcm_op_occ_id:
|
||||
description: |
|
||||
The identifier of the VNF lifecycle management
|
||||
operation occurrence associated to the notification.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
number_of_steps:
|
||||
description: |
|
||||
Number of scaling steps to be executed as part of this
|
||||
|
|
|
|||
|
|
@ -1,100 +0,0 @@
|
|||
{
|
||||
"id": "fb864bd0-25f3-4180-b591-2910086c0013",
|
||||
"notificationType": "VnfLcmOperationOccurrenceNotification",
|
||||
"subscriptionId": "c25ae285-e245-4898-9df7-0527841efdc4",
|
||||
"timeStamp": "2020-08-02T06:50:50.883373",
|
||||
"notificationStatus": "RESULT",
|
||||
"operationState": "COMPLETED",
|
||||
"vnfInstanceId": "0b7b95a9-21d5-4ac4-80c8-9ae9f7323787",
|
||||
"operation": "INSTANTIATE",
|
||||
"isAutomaticInvocation": false,
|
||||
"vnfLcmOpOccId": "1266b5b4-84d3-4c3a-acbf-aa515fada6b0",
|
||||
"affectedVnfcs": [
|
||||
{
|
||||
"id": "36e24439-829c-4803-a413-385cd658d544",
|
||||
"vduId": "VDU1",
|
||||
"changeType": "ADDED",
|
||||
"computeResource": {
|
||||
"vimConnectionId": null,
|
||||
"resourceId": "e0510ba9-3a53-4fcf-9dcc-58dea5c048b0",
|
||||
"vimLevelResourceType": "OS::Nova::Server"
|
||||
},
|
||||
"metadata": {
|
||||
"stackId": "f0faec36-721a-4245-8f50-4a19edec757a"
|
||||
},
|
||||
"affectedVnfcCpIds": [
|
||||
"VDU1_CP0",
|
||||
"VDU1_CP1"
|
||||
],
|
||||
"addedStorageResourceIds": []
|
||||
},
|
||||
{
|
||||
"id": "51f930d7-f8b9-4a7f-8b02-18c47ec31340",
|
||||
"vduId": "VDU2",
|
||||
"changeType": "ADDED",
|
||||
"computeResource": {
|
||||
"vimConnectionId": null,
|
||||
"resourceId": "",
|
||||
"vimLevelResourceType": null
|
||||
},
|
||||
"metadata": {},
|
||||
"affectedVnfcCpIds": [
|
||||
"VDU2_CP0",
|
||||
"VDU2_CP1"
|
||||
],
|
||||
"addedStorageResourceIds": []
|
||||
},
|
||||
{
|
||||
"id": "52e4253a-7c9e-4161-bb74-0642d5072271",
|
||||
"vduId": "VDU3",
|
||||
"changeType": "ADDED",
|
||||
"computeResource": {
|
||||
"vimConnectionId": null,
|
||||
"resourceId": "",
|
||||
"vimLevelResourceType": null
|
||||
},
|
||||
"metadata": {},
|
||||
"affectedVnfcCpIds": [
|
||||
"VDU3_CP0",
|
||||
"VDU3_CP1"
|
||||
],
|
||||
"addedStorageResourceIds": []
|
||||
}
|
||||
],
|
||||
"affectedVirtualLinks": [
|
||||
{
|
||||
"id": "9836f7f2-5af4-4df5-a89f-933479448ef7",
|
||||
"vnfVirtualLinkDescId": "internalNW1",
|
||||
"changeType": "ADDED",
|
||||
"networkResource": {
|
||||
"vimConnectionId": null,
|
||||
"resourceId": "400692e5-b2db-478e-acb1-b77a92635ec6",
|
||||
"vimLevelResourceType": "OS::Neutron::Net"
|
||||
},
|
||||
"metadata": {}
|
||||
},
|
||||
{
|
||||
"id": "8d6c4a5f-cbd1-4fd8-b240-867ed1d48385",
|
||||
"vnfVirtualLinkDescId": "internalNW2",
|
||||
"changeType": "ADDED",
|
||||
"networkResource": {
|
||||
"vimConnectionId": null,
|
||||
"resourceId": "",
|
||||
"vimLevelResourceType": null
|
||||
},
|
||||
"metadata": {}
|
||||
}
|
||||
],
|
||||
"affectedVirtualStorages": [],
|
||||
"_links": {
|
||||
"vnfInstance": {
|
||||
"href": "http://sample.com/vnflcm/v1/vnf_instances/0b7b95a9-21d5-4ac4-80c8-9ae9f7323787"
|
||||
},
|
||||
"subscription": {
|
||||
"href": "http://sample.com/vnflcm/v1/subscriptions/c25ae285-e245-4898-9df7-0527841efdc4"
|
||||
},
|
||||
"vnfLcmOpOcc": {
|
||||
"href": "http://sample.com/vnflcmv1/vnf_lcm_op_occs/1266b5b4-84d3-4c3a-acbf-aa515fada6b0"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -998,100 +998,3 @@ Response Example
|
|||
|
||||
.. literalinclude:: samples/vnflcm/list-subscription-response.json
|
||||
:language: javascript
|
||||
|
||||
Notification
|
||||
=================
|
||||
|
||||
.. rest_method:: POST URI is provided by the client when creating the subscription.
|
||||
|
||||
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall have
|
||||
previously created an "Individual subscription" resource with a matching filter.
|
||||
|
||||
Response Codes
|
||||
--------------
|
||||
|
||||
.. rest_status_code:: success status.yaml
|
||||
|
||||
- 204
|
||||
|
||||
.. rest_status_code:: error status.yaml
|
||||
|
||||
- 401
|
||||
- 403
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
.. rest_parameters:: parameters_vnflcm.yaml
|
||||
|
||||
|
||||
- id: notification_id
|
||||
- notificationType: notification_type
|
||||
- subscriptionId: notification_subscription_id
|
||||
- timeStamp: notification_time_tamp
|
||||
- notificationStatus: notification_status
|
||||
- operationState: notification_operation_state
|
||||
- vnfInstanceId: notification_vnf_instance_id
|
||||
- operation: notification_operation
|
||||
- isAutomaticInvocation: is_automatic_invocation
|
||||
- vnfLcmOpOccId: notification_vnf_lcm_op_occ_id
|
||||
- affectedVnfcs: affected_vnfcs
|
||||
- id: affected_vnfcs_id
|
||||
- vduId: affected_vnfcs_vdu_id
|
||||
- changeType: affected_vnfcs_change_type
|
||||
- computeResource: vnfc_resource_info_compute_resource
|
||||
- vimConnectionId: vim_connection_id
|
||||
- resourceId: resource_handle_resource_id
|
||||
- vimLevelResourceType: resource_handle_vim_level_resource_type
|
||||
- affectedVnfcCpIds: affected_vnfc_cp_ids
|
||||
- addedStorageResourceIds: added_storage_resource_ids
|
||||
- removedStorageResourceIds: removed_storage_resource_ids
|
||||
- affectedVirtualLinks: affected_virtual_links
|
||||
- id: affected_virtual_links_id
|
||||
- vnfVirtualLinkDescId: vnf_virtual_link_resource_info_vnf_virtual_link_desc_id
|
||||
- virtualLinkDescId: vnf_virtual_link_resource_info_vnf_virtual_link_desc_id
|
||||
- changeType: affected_virtual_links_change_type
|
||||
- networkResource: vnf_virtual_link_resource_info_network_resource
|
||||
- vimConnectionId: vim_connection_id
|
||||
- resourceId: resource_handle_resource_id
|
||||
- vimLevelResourceType: resource_handle_vim_level_resource_type
|
||||
- affectedVirtualStorages: affected_virtual_storages
|
||||
- id: affected_virtual_storages_id
|
||||
- virtualStorageDescId: affected_virtual_storages_virtual_storage_desc_id
|
||||
- changeType: affected_virtual_storages_change_type
|
||||
- storageResource: virtual_storage_resource_info_storage_resource
|
||||
- vimConnectionId: vim_connection_id
|
||||
- resourceId: resource_handle_resource_id
|
||||
- vimLevelResourceType: resource_handle_vim_level_resource_type
|
||||
- changedInfo: changed_info
|
||||
- vnfInstanceName: changed_info_vnf_instance_name
|
||||
- vnfInstanceDescription: changed_info_vnf_instance_description
|
||||
- metadata: changed_info_metadata
|
||||
- vimConnectionInfo: changed_info_vim_connection_info
|
||||
- id: vim_connection_info_id
|
||||
- vimId: vim_connection_info_vim_id
|
||||
- vimType: vim_connection_info_vim_type
|
||||
- interfaceInfo: vim_connection_info_interface_info
|
||||
- endpoint: vim_connection_info_interface_info_endpoint
|
||||
- accessInfo: vim_connection_info_access_info
|
||||
- username: vim_connection_info_access_info_username
|
||||
- region: vim_connection_info_access_info_region
|
||||
- password: vim_connection_info_access_info_password
|
||||
- tenant: vim_connection_info_access_info_tenant
|
||||
- vnfPkgId: changed_info_vnf_pkg_id
|
||||
- vnfdId: changed_info_vnfd_id
|
||||
- vnfProvider: changed_info_vnf_provider
|
||||
- vnfProductName: changed_info_vnf_product_name
|
||||
- vnfSotwareVersion: changed_info_vnf_sotware_version
|
||||
- vnfdVersion: changed_info_vnfd_version
|
||||
- error: error
|
||||
- title: error_title
|
||||
- status: error_status
|
||||
- detail: error_detail
|
||||
- _links: vnf_instance_links
|
||||
|
||||
Response Example
|
||||
----------------
|
||||
|
||||
.. literalinclude:: samples/vnflcm/notification-request.json
|
||||
:language: javascript
|
||||
|
|
|
|||
Loading…
Reference in New Issue